IotHubClient Class

Reference

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.

Constructor

IotHubClient(credential: TokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)

Parameters

Name	Description
credential Required	TokenCredential Credential needed for the client to connect to Azure. Required.
subscription_id Required	str The subscription identifier. Required.
api_version	str API version to use if no profile is provided, or if missing in profile. Default value: None
base_url	str Service URL Default value: https://management.azure.com
profile	KnownProfiles A profile definition, from KnownProfiles to dict. Default value: KnownProfiles.default

Keyword-Only Parameters

Name	Description
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Methods

models

Module depends on the API version:

2019-03-22: models
2019-07-01-preview: models
2023-06-30: models
2023-06-30-preview: models

close

close()

models

Module depends on the API version:

2019-03-22: models
2019-07-01-preview: models
2023-06-30: models
2023-06-30-preview: models

models(api_version='2023-06-30')