azure.mgmt.iothub package

Module contents

class azure.mgmt.iothub.IotHubClient(credentials, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>)[source]

Bases: azure.profiles.multiapiclient.MultiApiClientMixin, msrest.service_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 Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, uses latest API version available on public Azure. For production, you should stick a particular api-version and/or profile. The profile sets a mapping between the operation group and an API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Variables:

config (IotHubClientConfiguration) – Configuration for client.

Parameters:
  • credentials (A msrestazure Credentials object) – Credentials needed for the client to connect to Azure.
  • subscription_id (str) – Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • 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.
classmethod models(api_version='2019-11-04')[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-11-04: v2019_11_04.models
DEFAULT_API_VERSION = '2019-11-04'
LATEST_PROFILE = azure.mgmt.iothub.IotHubClient latest
certificates

CertificatesOperations * 2018-01-22: CertificatesOperations * 2018-04-01: CertificatesOperations * 2019-03-22: CertificatesOperations * 2019-11-04: CertificatesOperations

Type:

Instance depends on the API version

Type:
  • 2017-07-01
iot_hub

IotHubOperations * 2019-11-04: IotHubOperations

Type:

Instance depends on the API version

Type:
  • 2019-03-22
iot_hub_resource

IotHubResourceOperations * 2017-01-19: IotHubResourceOperations * 2017-07-01: IotHubResourceOperations * 2018-01-22: IotHubResourceOperations * 2018-04-01: IotHubResourceOperations * 2019-03-22: IotHubResourceOperations * 2019-11-04: IotHubResourceOperations

Type:

Instance depends on the API version

Type:
  • 2016-02-03
operations

Operations * 2018-01-22: Operations * 2018-04-01: Operations * 2019-03-22: Operations * 2019-11-04: Operations

Type:

Instance depends on the API version

Type:
  • 2017-07-01
resource_provider_common

ResourceProviderCommonOperations * 2019-03-22: ResourceProviderCommonOperations * 2019-11-04: ResourceProviderCommonOperations

Type:

Instance depends on the API version

Type:
  • 2018-04-01
class azure.mgmt.iothub.IotHubClientConfiguration(credentials, subscription_id, base_url=None)[source]

Bases: msrestazure.azure_configuration.AzureConfiguration

Configuration for IotHubClient Note that all parameters used to create this instance are saved as instance attributes.

Parameters:
  • credentials (A msrestazure Credentials object) – Credentials needed for the client to connect to Azure.
  • subscription_id (str) – The subscription identifier.
  • base_url (str) – Service URL