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.

Inheritance
MultiApiClientMixin
IotHubClient
azure.mgmt.iothub._iot_hub_client._SDKClient
IotHubClient

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

close
models

Module depends on the API version:

close 

close()

models

Module depends on the API version:

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

Parameters

Name Description
api_version
default value: 2023-06-30

Attributes

certificates

Instance depends on the API version:

iot_hub

Instance depends on the API version:

iot_hub_resource

Instance depends on the API version:

operations

Instance depends on the API version:

private_endpoint_connections

Instance depends on the API version:

Instance depends on the API version:

resource_provider_common

Instance depends on the API version:

DEFAULT_API_VERSION 

DEFAULT_API_VERSION = '2023-06-30'

LATEST_PROFILE 

LATEST_PROFILE = azure.mgmt.iothub.IotHubClient latest