azure.mgmt.iothub.v2023_06_30_preview package

Submodules

• azure.mgmt.iothub.v2023_06_30_preview.models module
  • AccessRights
    • AccessRights.DEVICE_CONNECT
    • AccessRights.REGISTRY_READ
    • AccessRights.REGISTRY_READ_DEVICE_CONNECT
    • AccessRights.REGISTRY_READ_REGISTRY_WRITE
    • AccessRights.REGISTRY_READ_REGISTRY_WRITE_DEVICE_CONNECT
    • AccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT
    • AccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECT
    • AccessRights.REGISTRY_READ_SERVICE_CONNECT
    • AccessRights.REGISTRY_READ_SERVICE_CONNECT_DEVICE_CONNECT
    • AccessRights.REGISTRY_WRITE
    • AccessRights.REGISTRY_WRITE_DEVICE_CONNECT
    • AccessRights.REGISTRY_WRITE_SERVICE_CONNECT
    • AccessRights.REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECT
    • AccessRights.SERVICE_CONNECT
    • AccessRights.SERVICE_CONNECT_DEVICE_CONNECT
  • ArmIdentity
  • ArmUserIdentity
  • AuthenticationType
    • AuthenticationType.IDENTITY_BASED
    • AuthenticationType.KEY_BASED
  • Capabilities
    • Capabilities.DEVICE_MANAGEMENT
    • Capabilities.NONE
  • CertificateBodyDescription
  • CertificateDescription
  • CertificateListDescription
  • CertificateProperties
  • CertificatePropertiesWithNonce
  • CertificateVerificationDescription
  • CertificateWithNonceDescription
  • CloudToDeviceProperties
  • CreatedByType
    • CreatedByType.APPLICATION
    • CreatedByType.KEY
    • CreatedByType.MANAGED_IDENTITY
    • CreatedByType.USER
  • DefaultAction
    • DefaultAction.ALLOW
    • DefaultAction.DENY
  • EncryptionPropertiesDescription
  • EndpointHealthData
  • EndpointHealthDataListResult
  • EndpointHealthStatus
    • EndpointHealthStatus.DEAD
    • EndpointHealthStatus.DEGRADED
    • EndpointHealthStatus.HEALTHY
    • EndpointHealthStatus.UNHEALTHY
    • EndpointHealthStatus.UNKNOWN
  • EnrichmentProperties
  • ErrorDetails
  • EventHubConsumerGroupBodyDescription
  • EventHubConsumerGroupInfo
  • EventHubConsumerGroupName
  • EventHubConsumerGroupsListResult
  • EventHubProperties
  • ExportDevicesRequest
  • FailoverInput
  • FallbackRouteProperties
  • FeedbackProperties
  • GroupIdInformation
  • GroupIdInformationProperties
  • ImportDevicesRequest
  • IotHubCapacity
  • IotHubDescription
  • IotHubDescriptionListResult
  • IotHubLocationDescription
  • IotHubNameAvailabilityInfo
  • IotHubNameUnavailabilityReason
    • IotHubNameUnavailabilityReason.ALREADY_EXISTS
    • IotHubNameUnavailabilityReason.INVALID
  • IotHubProperties
  • IotHubPropertiesDeviceStreams
  • IotHubQuotaMetricInfo
  • IotHubQuotaMetricInfoListResult
  • IotHubReplicaRoleType
    • IotHubReplicaRoleType.PRIMARY
    • IotHubReplicaRoleType.SECONDARY
  • IotHubScaleType
    • IotHubScaleType.AUTOMATIC
    • IotHubScaleType.MANUAL
    • IotHubScaleType.NONE
  • IotHubSku
    • IotHubSku.B1
    • IotHubSku.B2
    • IotHubSku.B3
    • IotHubSku.F1
    • IotHubSku.S1
    • IotHubSku.S2
    • IotHubSku.S3
  • IotHubSkuDescription
  • IotHubSkuDescriptionListResult
  • IotHubSkuInfo
  • IotHubSkuTier
    • IotHubSkuTier.BASIC
    • IotHubSkuTier.FREE
    • IotHubSkuTier.STANDARD
  • IpFilterActionType
    • IpFilterActionType.ACCEPT
    • IpFilterActionType.REJECT
  • IpFilterRule
  • IpVersion
    • IpVersion.IPV4
    • IpVersion.IPV4_IPV6
    • IpVersion.IPV6
  • JobResponse
  • JobResponseListResult
  • JobStatus
    • JobStatus.CANCELLED
    • JobStatus.COMPLETED
    • JobStatus.ENQUEUED
    • JobStatus.FAILED
    • JobStatus.RUNNING
    • JobStatus.UNKNOWN
  • JobType
    • JobType.BACKUP
    • JobType.EXPORT
    • JobType.FACTORY_RESET_DEVICE
    • JobType.FIRMWARE_UPDATE
    • JobType.IMPORT
    • JobType.IMPORT_ENUM
    • JobType.READ_DEVICE_PROPERTIES
    • JobType.REBOOT_DEVICE
    • JobType.UNKNOWN
    • JobType.UPDATE_DEVICE_CONFIGURATION
    • JobType.WRITE_DEVICE_PROPERTIES
  • KeyVaultKeyProperties
  • ManagedIdentity
  • MatchedRoute
  • MessagingEndpointProperties
  • Name
  • NetworkRuleIPAction
    • NetworkRuleIPAction.ALLOW
  • NetworkRuleSetIpRule
  • NetworkRuleSetProperties
  • Operation
  • OperationDisplay
  • OperationInputs
  • OperationListResult
  • PrivateEndpoint
  • PrivateEndpointConnection
  • PrivateEndpointConnectionProperties
  • PrivateLinkResources
  • PrivateLinkServiceConnectionState
  • PrivateLinkServiceConnectionStatus
    • PrivateLinkServiceConnectionStatus.APPROVED
    • PrivateLinkServiceConnectionStatus.DISCONNECTED
    • PrivateLinkServiceConnectionStatus.PENDING
    • PrivateLinkServiceConnectionStatus.REJECTED
  • PublicNetworkAccess
    • PublicNetworkAccess.DISABLED
    • PublicNetworkAccess.ENABLED
  • RegistryStatistics
  • Resource
  • ResourceIdentityType
    • ResourceIdentityType.NONE
    • ResourceIdentityType.SYSTEM_ASSIGNED
    • ResourceIdentityType.SYSTEM_ASSIGNED_USER_ASSIGNED
    • ResourceIdentityType.USER_ASSIGNED
  • RootCertificateProperties
  • RouteCompilationError
  • RouteErrorPosition
  • RouteErrorRange
  • RouteErrorSeverity
    • RouteErrorSeverity.ERROR
    • RouteErrorSeverity.WARNING
  • RouteProperties
  • RoutingCosmosDBSqlApiProperties
  • RoutingEndpoints
  • RoutingEventHubProperties
  • RoutingMessage
  • RoutingProperties
  • RoutingServiceBusQueueEndpointProperties
  • RoutingServiceBusTopicEndpointProperties
  • RoutingSource
    • RoutingSource.DEVICE_CONNECTION_STATE_EVENTS
    • RoutingSource.DEVICE_JOB_LIFECYCLE_EVENTS
    • RoutingSource.DEVICE_LIFECYCLE_EVENTS
    • RoutingSource.DEVICE_MESSAGES
    • RoutingSource.DIGITAL_TWIN_CHANGE_EVENTS
    • RoutingSource.INVALID
    • RoutingSource.MQTT_BROKER_MESSAGES
    • RoutingSource.TWIN_CHANGE_EVENTS
  • RoutingStorageContainerProperties
  • RoutingStorageContainerPropertiesEncoding
    • RoutingStorageContainerPropertiesEncoding.AVRO
    • RoutingStorageContainerPropertiesEncoding.AVRO_DEFLATE
    • RoutingStorageContainerPropertiesEncoding.JSON
  • RoutingTwin
  • RoutingTwinProperties
  • SharedAccessSignatureAuthorizationRule
  • SharedAccessSignatureAuthorizationRuleListResult
  • StorageEndpointProperties
  • SystemData
  • TagsResource
  • TestAllRoutesInput
  • TestAllRoutesResult
  • TestResultStatus
    • TestResultStatus.FALSE
    • TestResultStatus.TRUE
    • TestResultStatus.UNDEFINED
  • TestRouteInput
  • TestRouteResult
  • TestRouteResultDetails
  • UserSubscriptionQuota
  • UserSubscriptionQuotaListResult
• azure.mgmt.iothub.v2023_06_30_preview.operations module
  • CertificatesOperations
    • CertificatesOperations.create_or_update()
    • CertificatesOperations.delete()
    • CertificatesOperations.generate_verification_code()
    • CertificatesOperations.get()
    • CertificatesOperations.list_by_iot_hub()
    • CertificatesOperations.verify()
    • CertificatesOperations.models
  • IotHubOperations
    • IotHubOperations.begin_manual_failover()
    • IotHubOperations.models
  • IotHubResourceOperations
    • IotHubResourceOperations.begin_create_or_update()
    • IotHubResourceOperations.begin_delete()
    • IotHubResourceOperations.begin_update()
    • IotHubResourceOperations.check_name_availability()
    • IotHubResourceOperations.create_event_hub_consumer_group()
    • IotHubResourceOperations.delete_event_hub_consumer_group()
    • IotHubResourceOperations.export_devices()
    • IotHubResourceOperations.get()
    • IotHubResourceOperations.get_endpoint_health()
    • IotHubResourceOperations.get_event_hub_consumer_group()
    • IotHubResourceOperations.get_job()
    • IotHubResourceOperations.get_keys_for_key_name()
    • IotHubResourceOperations.get_quota_metrics()
    • IotHubResourceOperations.get_stats()
    • IotHubResourceOperations.get_valid_skus()
    • IotHubResourceOperations.import_devices()
    • IotHubResourceOperations.list_by_resource_group()
    • IotHubResourceOperations.list_by_subscription()
    • IotHubResourceOperations.list_event_hub_consumer_groups()
    • IotHubResourceOperations.list_jobs()
    • IotHubResourceOperations.list_keys()
    • IotHubResourceOperations.test_all_routes()
    • IotHubResourceOperations.test_route()
    • IotHubResourceOperations.models
  • Operations
    • Operations.list()
    • Operations.models
  • PrivateEndpointConnectionsOperations
    • PrivateEndpointConnectionsOperations.begin_delete()
    • PrivateEndpointConnectionsOperations.begin_update()
    • PrivateEndpointConnectionsOperations.get()
    • PrivateEndpointConnectionsOperations.list()
    • PrivateEndpointConnectionsOperations.models
  • PrivateLinkResourcesOperations
    • PrivateLinkResourcesOperations.get()
    • PrivateLinkResourcesOperations.list()
    • PrivateLinkResourcesOperations.models
  • ResourceProviderCommonOperations
    • ResourceProviderCommonOperations.get_subscription_quota()
    • ResourceProviderCommonOperations.models

Module contents

class azure.mgmt.iothub.v2023_06_30_preview.IotHubClient(credential: TokenCredential, subscription_id: str, base_url: str = 'https://management.azure.com', **kwargs: Any)

Bases: object

Use this API to manage the IoT hubs in your Azure subscription.

Variables:

• operations (azure.mgmt.iothub.v2023_06_30_preview.operations.Operations) – Operations operations

• iot_hub_resource (azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations) – IotHubResourceOperations operations

• resource_provider_common (azure.mgmt.iothub.v2023_06_30_preview.operations.ResourceProviderCommonOperations) – ResourceProviderCommonOperations operations

• certificates (azure.mgmt.iothub.v2023_06_30_preview.operations.CertificatesOperations) – CertificatesOperations operations

• iot_hub (azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubOperations) – IotHubOperations operations

• private_link_resources (azure.mgmt.iothub.v2023_06_30_preview.operations.PrivateLinkResourcesOperations) – PrivateLinkResourcesOperations operations

• private_endpoint_connections (azure.mgmt.iothub.v2023_06_30_preview.operations.PrivateEndpointConnectionsOperations) – PrivateEndpointConnectionsOperations operations

Parameters:

• credential (TokenCredential) – Credential needed for the client to connect to Azure. Required.

• subscription_id (str) – The subscription identifier. Required.

• base_url (str) – Service URL. Default value is “https://management.azure.com”.

Keyword Arguments:

• api_version (str) – Api Version. Default value is “2023-06-30-preview”. Note that overriding this default value may result in unsupported behavior.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

close() → None