IotHubClient Class

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
IotHubClient
azure.mgmt.iothub._iot_hub_client._SDKClient
IotHubClient

Constructor

IotHubClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)

Parameters

credential
<xref:azure.core.credentials.TokenCredential>
Required

Credential needed for the client to connect to Azure.

subscription_id
str
Required

The subscription identifier.

api_version
str
Required

API version to use if no profile is provided, or if missing in profile.

base_url
str
Required

Service URL

profile
KnownProfiles
Required

A profile definition, from KnownProfiles to dict.

polling_interval
int
Required

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='2021-03-31')

Parameters

cls
Required
api_version
default value: 2021-03-31

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

DEFAULT_API_VERSION

DEFAULT_API_VERSION = '2021-03-31'

LATEST_PROFILE

LATEST_PROFILE = azure.mgmt.iothub.IotHubClient latest