azure.mgmt.iothub package

Module contents

class azure.mgmt.iothub.IotHubClient(credential: TokenCredential, subscription_id: str, api_version: Optional[str] = None, base_url: str = 'https://management.azure.com', profile: azure.profiles.KnownProfiles = <KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs: Any)[source]

Bases: azure.profiles.multiapiclient.MultiApiClientMixin, azure.mgmt.iothub._iot_hub_client._SDKClient

Use 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

close()[source]
classmethod models(api_version='2021-07-02')[source]

Module depends on the API version:

  • 2016-02-03: v2016_02_03.models

  • 2017-01-19: v2017_01_19.models

  • 2017-07-01: v2017_07_01.models

  • 2018-01-22: v2018_01_22.models

  • 2018-04-01: v2018_04_01.models

  • 2019-03-22: v2019_03_22.models

  • 2019-07-01-preview: v2019_07_01_preview.models

  • 2019-11-04: v2019_11_04.models

  • 2020-03-01: v2020_03_01.models

  • 2021-03-03-preview: v2021_03_03_preview.models

  • 2021-03-31: v2021_03_31.models

  • 2021-07-01: v2021_07_01.models

  • 2021-07-02: v2021_07_02.models

  • 2022-04-30-preview: v2022_04_30_preview.models

DEFAULT_API_VERSION = '2021-07-02'
LATEST_PROFILE = azure.mgmt.iothub.IotHubClient latest
property certificates

Instance depends on the API version:

  • 2017-07-01: CertificatesOperations

  • 2018-01-22: CertificatesOperations

  • 2018-04-01: CertificatesOperations

  • 2019-03-22: CertificatesOperations

  • 2019-07-01-preview: CertificatesOperations

  • 2019-11-04: CertificatesOperations

  • 2020-03-01: CertificatesOperations

  • 2021-03-03-preview: CertificatesOperations

  • 2021-03-31: CertificatesOperations

  • 2021-07-01: CertificatesOperations

  • 2021-07-02: CertificatesOperations

  • 2022-04-30-preview: CertificatesOperations

property iot_hub

Instance depends on the API version:

  • 2019-03-22: IotHubOperations

  • 2019-07-01-preview: IotHubOperations

  • 2019-11-04: IotHubOperations

  • 2020-03-01: IotHubOperations

  • 2021-03-03-preview: IotHubOperations

  • 2021-03-31: IotHubOperations

  • 2021-07-01: IotHubOperations

  • 2021-07-02: IotHubOperations

  • 2022-04-30-preview: IotHubOperations

property iot_hub_resource

Instance depends on the API version:

  • 2016-02-03: IotHubResourceOperations

  • 2017-01-19: IotHubResourceOperations

  • 2017-07-01: IotHubResourceOperations

  • 2018-01-22: IotHubResourceOperations

  • 2018-04-01: IotHubResourceOperations

  • 2019-03-22: IotHubResourceOperations

  • 2019-07-01-preview: IotHubResourceOperations

  • 2019-11-04: IotHubResourceOperations

  • 2020-03-01: IotHubResourceOperations

  • 2021-03-03-preview: IotHubResourceOperations

  • 2021-03-31: IotHubResourceOperations

  • 2021-07-01: IotHubResourceOperations

  • 2021-07-02: IotHubResourceOperations

  • 2022-04-30-preview: IotHubResourceOperations

property operations

Instance depends on the API version:

  • 2017-07-01: Operations

  • 2018-01-22: Operations

  • 2018-04-01: Operations

  • 2019-03-22: Operations

  • 2019-07-01-preview: Operations

  • 2019-11-04: Operations

  • 2020-03-01: Operations

  • 2021-03-03-preview: Operations

  • 2021-03-31: Operations

  • 2021-07-01: Operations

  • 2021-07-02: Operations

  • 2022-04-30-preview: Operations

property private_endpoint_connections

Instance depends on the API version:

  • 2020-03-01: PrivateEndpointConnectionsOperations

  • 2021-03-03-preview: PrivateEndpointConnectionsOperations

  • 2021-03-31: PrivateEndpointConnectionsOperations

  • 2021-07-01: PrivateEndpointConnectionsOperations

  • 2021-07-02: PrivateEndpointConnectionsOperations

  • 2022-04-30-preview: PrivateEndpointConnectionsOperations

Instance depends on the API version:

  • 2020-03-01: PrivateLinkResourcesOperations

  • 2021-03-03-preview: PrivateLinkResourcesOperations

  • 2021-03-31: PrivateLinkResourcesOperations

  • 2021-07-01: PrivateLinkResourcesOperations

  • 2021-07-02: PrivateLinkResourcesOperations

  • 2022-04-30-preview: PrivateLinkResourcesOperations

property resource_provider_common

Instance depends on the API version:

  • 2018-04-01: ResourceProviderCommonOperations

  • 2019-03-22: ResourceProviderCommonOperations

  • 2019-07-01-preview: ResourceProviderCommonOperations

  • 2019-11-04: ResourceProviderCommonOperations

  • 2020-03-01: ResourceProviderCommonOperations

  • 2021-03-03-preview: ResourceProviderCommonOperations

  • 2021-03-31: ResourceProviderCommonOperations

  • 2021-07-01: ResourceProviderCommonOperations

  • 2021-07-02: ResourceProviderCommonOperations

  • 2022-04-30-preview: ResourceProviderCommonOperations