azure.mgmt.iothub package
Module contents
- class azure.mgmt.iothub.IotHubClient(credential: TokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)[source]
Bases:
MultiApiClientMixin,_SDKClientUse this API to manage the IoT hubs in your Azure subscription.
This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.
- Parameters:
credential (TokenCredential) – Credential needed for the client to connect to Azure. Required.
subscription_id (str) – The subscription identifier. Required.
api_version (str) – API version to use if no profile is provided, or if missing in profile.
base_url (str) – Service URL
profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.
- Keyword Arguments:
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
This is a fake class to support current implemetation of MultiApiClientMixin.” Will be removed in final version of multiapi azure-core based client
- classmethod models(api_version='2023-06-30')[source]
Module depends on the API version:
2019-03-22:
v2019_03_22.models2019-07-01-preview:
v2019_07_01_preview.models2023-06-30:
v2023_06_30.models2023-06-30-preview:
v2023_06_30_preview.models
- DEFAULT_API_VERSION = '2023-06-30'
- LATEST_PROFILE = azure.mgmt.iothub.IotHubClient latest
- property certificates
Instance depends on the API version:
2019-03-22:
CertificatesOperations2019-07-01-preview:
CertificatesOperations2023-06-30:
CertificatesOperations2023-06-30-preview:
CertificatesOperations
- property iot_hub
Instance depends on the API version:
2019-03-22:
IotHubOperations2019-07-01-preview:
IotHubOperations2023-06-30:
IotHubOperations2023-06-30-preview:
IotHubOperations
- property iot_hub_resource
Instance depends on the API version:
2019-03-22:
IotHubResourceOperations2019-07-01-preview:
IotHubResourceOperations2023-06-30:
IotHubResourceOperations2023-06-30-preview:
IotHubResourceOperations
- property operations
Instance depends on the API version:
2019-03-22:
Operations2019-07-01-preview:
Operations2023-06-30:
Operations2023-06-30-preview:
Operations
- property private_endpoint_connections
Instance depends on the API version:
2023-06-30:
PrivateEndpointConnectionsOperations2023-06-30-preview:
PrivateEndpointConnectionsOperations
- property private_link_resources
Instance depends on the API version:
2023-06-30:
PrivateLinkResourcesOperations2023-06-30-preview:
PrivateLinkResourcesOperations
- property resource_provider_common
Instance depends on the API version:
2019-03-22:
ResourceProviderCommonOperations2019-07-01-preview:
ResourceProviderCommonOperations2023-06-30:
ResourceProviderCommonOperations2023-06-30-preview:
ResourceProviderCommonOperations
Submodules
- azure.mgmt.iothub.v2023_06_30_preview package
- Submodules
- azure.mgmt.iothub.v2023_06_30_preview.models module
AccessRightsAccessRights.DEVICE_CONNECTAccessRights.REGISTRY_READAccessRights.REGISTRY_READ_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITEAccessRights.REGISTRY_READ_REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_WRITEAccessRights.REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.SERVICE_CONNECTAccessRights.SERVICE_CONNECT_DEVICE_CONNECT
ArmIdentityArmUserIdentityAuthenticationTypeCapabilitiesCertificateBodyDescriptionCertificateDescriptionCertificateListDescriptionCertificatePropertiesCertificatePropertiesWithNonceCertificateVerificationDescriptionCertificateWithNonceDescriptionCloudToDevicePropertiesCreatedByTypeDefaultActionEncryptionPropertiesDescriptionEndpointHealthDataEndpointHealthDataListResultEndpointHealthStatusEnrichmentPropertiesErrorDetailsEventHubConsumerGroupBodyDescriptionEventHubConsumerGroupInfoEventHubConsumerGroupNameEventHubConsumerGroupsListResultEventHubPropertiesExportDevicesRequestFailoverInputFallbackRoutePropertiesFeedbackPropertiesGroupIdInformationGroupIdInformationPropertiesImportDevicesRequestIotHubCapacityIotHubDescriptionIotHubDescriptionListResultIotHubLocationDescriptionIotHubNameAvailabilityInfoIotHubNameUnavailabilityReasonIotHubPropertiesIotHubPropertiesDeviceStreamsIotHubQuotaMetricInfoIotHubQuotaMetricInfoListResultIotHubReplicaRoleTypeIotHubScaleTypeIotHubSkuIotHubSkuDescriptionIotHubSkuDescriptionListResultIotHubSkuInfoIotHubSkuTierIpFilterActionTypeIpFilterRuleIpVersionJobResponseJobResponseListResultJobStatusJobTypeKeyVaultKeyPropertiesManagedIdentityMatchedRouteMessagingEndpointPropertiesNameNetworkRuleIPActionNetworkRuleSetIpRuleNetworkRuleSetPropertiesOperationOperationDisplayOperationInputsOperationListResultPrivateEndpointPrivateEndpointConnectionPrivateEndpointConnectionPropertiesPrivateLinkResourcesPrivateLinkServiceConnectionStatePrivateLinkServiceConnectionStatusPublicNetworkAccessRegistryStatisticsResourceResourceIdentityTypeRootCertificatePropertiesRouteCompilationErrorRouteErrorPositionRouteErrorRangeRouteErrorSeverityRoutePropertiesRoutingCosmosDBSqlApiPropertiesRoutingEndpointsRoutingEventHubPropertiesRoutingMessageRoutingPropertiesRoutingServiceBusQueueEndpointPropertiesRoutingServiceBusTopicEndpointPropertiesRoutingSourceRoutingStorageContainerPropertiesRoutingStorageContainerPropertiesEncodingRoutingTwinRoutingTwinPropertiesSharedAccessSignatureAuthorizationRuleSharedAccessSignatureAuthorizationRuleListResultStorageEndpointPropertiesSystemDataTagsResourceTestAllRoutesInputTestAllRoutesResultTestResultStatusTestRouteInputTestRouteResultTestRouteResultDetailsUserSubscriptionQuotaUserSubscriptionQuotaListResult
- azure.mgmt.iothub.v2023_06_30_preview.operations module
CertificatesOperationsIotHubOperationsIotHubResourceOperationsIotHubResourceOperations.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
OperationsPrivateEndpointConnectionsOperationsPrivateLinkResourcesOperationsResourceProviderCommonOperations
- azure.mgmt.iothub.v2023_06_30_preview.models module
- Module contents
- Submodules
- azure.mgmt.iothub.v2023_06_30 package
- Submodules
- azure.mgmt.iothub.v2023_06_30.models module
AccessRightsAccessRights.DEVICE_CONNECTAccessRights.REGISTRY_READAccessRights.REGISTRY_READ_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITEAccessRights.REGISTRY_READ_REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_WRITEAccessRights.REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.SERVICE_CONNECTAccessRights.SERVICE_CONNECT_DEVICE_CONNECT
ArmIdentityArmUserIdentityAuthenticationTypeCapabilitiesCertificateBodyDescriptionCertificateDescriptionCertificateListDescriptionCertificatePropertiesCertificatePropertiesWithNonceCertificateVerificationDescriptionCertificateWithNonceDescriptionCloudToDevicePropertiesCreatedByTypeDefaultActionEndpointHealthDataEndpointHealthDataListResultEndpointHealthStatusEnrichmentPropertiesErrorDetailsEventHubConsumerGroupBodyDescriptionEventHubConsumerGroupInfoEventHubConsumerGroupNameEventHubConsumerGroupsListResultEventHubPropertiesExportDevicesRequestFailoverInputFallbackRoutePropertiesFeedbackPropertiesGroupIdInformationGroupIdInformationPropertiesImportDevicesRequestIotHubCapacityIotHubDescriptionIotHubDescriptionListResultIotHubLocationDescriptionIotHubNameAvailabilityInfoIotHubNameUnavailabilityReasonIotHubPropertiesIotHubQuotaMetricInfoIotHubQuotaMetricInfoListResultIotHubReplicaRoleTypeIotHubScaleTypeIotHubSkuIotHubSkuDescriptionIotHubSkuDescriptionListResultIotHubSkuInfoIotHubSkuTierIpFilterActionTypeIpFilterRuleJobResponseJobResponseListResultJobStatusJobTypeManagedIdentityMatchedRouteMessagingEndpointPropertiesNameNetworkRuleIPActionNetworkRuleSetIpRuleNetworkRuleSetPropertiesOperationOperationDisplayOperationInputsOperationListResultPrivateEndpointPrivateEndpointConnectionPrivateEndpointConnectionPropertiesPrivateLinkResourcesPrivateLinkServiceConnectionStatePrivateLinkServiceConnectionStatusPublicNetworkAccessRegistryStatisticsResourceResourceIdentityTypeRouteCompilationErrorRouteErrorPositionRouteErrorRangeRouteErrorSeverityRoutePropertiesRoutingCosmosDBSqlApiPropertiesRoutingEndpointsRoutingEventHubPropertiesRoutingMessageRoutingPropertiesRoutingServiceBusQueueEndpointPropertiesRoutingServiceBusTopicEndpointPropertiesRoutingSourceRoutingStorageContainerPropertiesRoutingStorageContainerPropertiesEncodingRoutingTwinRoutingTwinPropertiesSharedAccessSignatureAuthorizationRuleSharedAccessSignatureAuthorizationRuleListResultStorageEndpointPropertiesSystemDataTagsResourceTestAllRoutesInputTestAllRoutesResultTestResultStatusTestRouteInputTestRouteResultTestRouteResultDetailsUserSubscriptionQuotaUserSubscriptionQuotaListResult
- azure.mgmt.iothub.v2023_06_30.operations module
CertificatesOperationsIotHubOperationsIotHubResourceOperationsIotHubResourceOperations.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
OperationsPrivateEndpointConnectionsOperationsPrivateLinkResourcesOperationsResourceProviderCommonOperations
- azure.mgmt.iothub.v2023_06_30.models module
- Module contents
- Submodules
- azure.mgmt.iothub.v2019_07_01_preview package
- Submodules
- azure.mgmt.iothub.v2019_07_01_preview.models module
AccessRightsAccessRights.DEVICE_CONNECTAccessRights.REGISTRY_READAccessRights.REGISTRY_READ_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITEAccessRights.REGISTRY_READ_REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_WRITEAccessRights.REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.SERVICE_CONNECTAccessRights.SERVICE_CONNECT_DEVICE_CONNECT
CapabilitiesCertificateBodyDescriptionCertificateDescriptionCertificateListDescriptionCertificatePropertiesCertificatePropertiesWithNonceCertificateVerificationDescriptionCertificateWithNonceDescriptionCloudToDevicePropertiesEndpointHealthDataEndpointHealthDataListResultEndpointHealthStatusEnrichmentPropertiesErrorDetailsEventHubConsumerGroupInfoEventHubConsumerGroupsListResultEventHubPropertiesExportDevicesRequestFailoverInputFallbackRoutePropertiesFeedbackPropertiesImportDevicesRequestIotHubCapacityIotHubDescriptionIotHubDescriptionListResultIotHubLocationDescriptionIotHubNameAvailabilityInfoIotHubNameUnavailabilityReasonIotHubPropertiesIotHubPropertiesDeviceStreamsIotHubQuotaMetricInfoIotHubQuotaMetricInfoListResultIotHubReplicaRoleTypeIotHubScaleTypeIotHubSkuIotHubSkuDescriptionIotHubSkuDescriptionListResultIotHubSkuInfoIotHubSkuTierIpFilterActionTypeIpFilterRuleJobResponseJobResponseListResultJobStatusJobTypeMatchedRouteMessagingEndpointPropertiesNameOperationOperationDisplayOperationInputsOperationListResultRegistryStatisticsResourceRouteCompilationErrorRouteErrorPositionRouteErrorRangeRouteErrorSeverityRoutePropertiesRoutingEndpointsRoutingEventHubPropertiesRoutingMessageRoutingPropertiesRoutingServiceBusQueueEndpointPropertiesRoutingServiceBusTopicEndpointPropertiesRoutingSourceRoutingStorageContainerPropertiesRoutingStorageContainerPropertiesEncodingRoutingTwinRoutingTwinPropertiesSharedAccessSignatureAuthorizationRuleSharedAccessSignatureAuthorizationRuleListResultStorageEndpointPropertiesTagsResourceTestAllRoutesInputTestAllRoutesResultTestResultStatusTestRouteInputTestRouteResultTestRouteResultDetailsUserSubscriptionQuotaUserSubscriptionQuotaListResult
- azure.mgmt.iothub.v2019_07_01_preview.operations module
CertificatesOperationsIotHubOperationsIotHubResourceOperationsIotHubResourceOperations.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
OperationsResourceProviderCommonOperations
- azure.mgmt.iothub.v2019_07_01_preview.models module
- Module contents
- Submodules
- azure.mgmt.iothub.v2019_03_22 package
- Submodules
- azure.mgmt.iothub.v2019_03_22.models module
AccessRightsAccessRights.DEVICE_CONNECTAccessRights.REGISTRY_READAccessRights.REGISTRY_READ_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITEAccessRights.REGISTRY_READ_REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_READ_REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECTAccessRights.REGISTRY_READ_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.REGISTRY_WRITEAccessRights.REGISTRY_WRITE_DEVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECTAccessRights.REGISTRY_WRITE_SERVICE_CONNECT_DEVICE_CONNECTAccessRights.SERVICE_CONNECTAccessRights.SERVICE_CONNECT_DEVICE_CONNECT
CapabilitiesCertificateBodyDescriptionCertificateDescriptionCertificateListDescriptionCertificatePropertiesCertificatePropertiesWithNonceCertificateVerificationDescriptionCertificateWithNonceDescriptionCloudToDevicePropertiesEndpointHealthDataEndpointHealthDataListResultEndpointHealthStatusErrorDetailsEventHubConsumerGroupInfoEventHubConsumerGroupsListResultEventHubPropertiesExportDevicesRequestFailoverInputFallbackRoutePropertiesFeedbackPropertiesImportDevicesRequestIotHubCapacityIotHubDescriptionIotHubDescriptionListResultIotHubLocationDescriptionIotHubNameAvailabilityInfoIotHubNameUnavailabilityReasonIotHubPropertiesIotHubQuotaMetricInfoIotHubQuotaMetricInfoListResultIotHubReplicaRoleTypeIotHubScaleTypeIotHubSkuIotHubSkuDescriptionIotHubSkuDescriptionListResultIotHubSkuInfoIotHubSkuTierIpFilterActionTypeIpFilterRuleJobResponseJobResponseListResultJobStatusJobTypeMatchedRouteMessagingEndpointPropertiesNameOperationOperationDisplayOperationInputsOperationListResultRegistryStatisticsResourceRouteCompilationErrorRouteErrorPositionRouteErrorRangeRouteErrorSeverityRoutePropertiesRoutingEndpointsRoutingEventHubPropertiesRoutingMessageRoutingPropertiesRoutingServiceBusQueueEndpointPropertiesRoutingServiceBusTopicEndpointPropertiesRoutingSourceRoutingStorageContainerPropertiesRoutingStorageContainerPropertiesEncodingRoutingTwinRoutingTwinPropertiesSharedAccessSignatureAuthorizationRuleSharedAccessSignatureAuthorizationRuleListResultStorageEndpointPropertiesTagsResourceTestAllRoutesInputTestAllRoutesResultTestResultStatusTestRouteInputTestRouteResultTestRouteResultDetailsUserSubscriptionQuotaUserSubscriptionQuotaListResult
- azure.mgmt.iothub.v2019_03_22.operations module
CertificatesOperationsIotHubOperationsIotHubResourceOperationsIotHubResourceOperations.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
OperationsResourceProviderCommonOperations
- azure.mgmt.iothub.v2019_03_22.models module
- Module contents
- Submodules