Microsoft Azure - API iotHubClient

Microsoft Azure / iotHubClient / Releases / 2018-04-01

iotHubClient

RELEASED
2018-04-01 - Released at 2018-04-01 00:00

The REST APIs for IoT Hub offer programmatic access to the device, messaging, and job services, as well as the resource provder, in IoT Hub.

Further information can be found in the IoT Hub REST docs

Use this API to manage the IoT hubs in your Azure subscription.

Resources

Certificates

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode

Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Certificate.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200The body contains the certificate.

Body

Name	Data Type	Description
`CertificateWithNonceDescription`	object	The X509 Certificate.

Properties


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificatePropertiesWithNonce


                        CertificatePropertiesWithNonce

object

The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

Properties

`certificate`	string Read-only	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.
`verificationCode`	string Read-only	The certificate's verification code that will be used for proof of possession.


                        type

string
Read-only

The resource type.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify

Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Certificate.

Body

Name	Data Type	Description
`CertificateVerificationDescription`	object	The JSON-serialized leaf certificate

Properties


                        certificate

string

base-64 representation of X509 certificate .cer file or just .pem file content.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200The body contains the certificate.

Body

Name	Data Type	Description
`CertificateDescription`	object	The X509 Certificate.

Properties


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.


                        type

string
Read-only

The resource type.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}

Deletes an existing X509 certificate or does nothing if it does not exist.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Certificate.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200Certificate has been deleted.

204Certificate does not exist.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}

Returns the certificate.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200The body contains the certificate.

Body

Name	Data Type	Description
`CertificateDescription`	object	The X509 Certificate.

Properties


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.


                        type

string
Read-only

The resource type.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}

Adds new or replaces existing certificate.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate.

Body

Name	Data Type	Description
`CertificateBodyDescription`	object	The JSON-serialized X509 Certificate.

Properties


                        certificate

string

base-64 representation of the X509 leaf certificate .cer file or just .pem file content.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).

Body

Name	Data Type	Description
`CertificateDescription`	object	The X509 Certificate.

Properties


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.


                        type

string
Read-only

The resource type.

201If certificate didn't exist creation was successful, the operation returns HTTP status code of 201 (OK).

Body

Name	Data Type	Description
`CertificateDescription`	object	The X509 Certificate.

Properties


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.


                        type

string
Read-only

The resource type.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates

Returns the list of certificates.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200The body contains all the certificate list.

Body

Name	Data Type	Description
`CertificateListDescription`	object	The JSON-serialized array of Certificate objects.

Properties


                        value

array [CertificateDescription]

The array of Certificate objects.


                        CertificateDescription

object

The X509 Certificate.

Properties


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.


                        type

string
Read-only

The resource type.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}

Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint in the IoT hub.
`name`	string	The name of the consumer group to delete.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}

Delete an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.

Body

Name	Data Type	Description
`IotHubDescription`	object	The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object

The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

202The Iot Hub resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the IoT Hub service status directly, or query the operation resource.

Body

Name	Data Type	Description
`IotHubDescription`	object	The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

204Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the Iot hub metadata in the service and the status of the delete operation is set to a completed state.

404After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the Iot hub metadata in the service.

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs

Get all the IoT hubs in a subscription.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the subscription.

Body

Name	Data Type	Description
`IotHubDescriptionListResult`	object	The JSON-serialized array of IotHubDescription objects with a next link.

Properties


                        nextLink

string
Read-only

The next link.


                        value

array [IotHubDescription]

The array of IotHubDescription objects.


                        IotHubDescription

object

The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties

`authorizationPolicies`	array [SharedAccessSignatureAuthorizationRule]	The shared access policies you can use to secure a connection to the IoT hub.
`cloudToDevice`	CloudToDeviceProperties
`comments`	string	IoT hub comments.
`enableFileUploadNotifications`	boolean	If True, file upload notifications are enabled.
`eventHubEndpoints`	object	The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
`features`	string Allowed values: - `None` - `DeviceManagement`	The capabilities and features enabled for the IoT hub.
`hostName`	string Read-only	The name of the host.
`ipFilterRules`	array [IpFilterRule]	The IP filter rules.
`messagingEndpoints`	object	The messaging endpoint properties for the file upload notification queue.
`operationsMonitoringProperties`	OperationsMonitoringProperties
`provisioningState`	string Read-only	The provisioning state.
`routing`	RoutingProperties
`state`	string Read-only	The hub state.
`storageEndpoints`	object	The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages

Get the number of free and paid iot hubs in the subscription

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200OK

Body

Name	Data Type	Description
`UserSubscriptionQuotaListResult`	object	Json-serialized array of User subscription quota response

Properties

nextLink string
Read-only

value array [UserSubscriptionQuota]


                        UserSubscriptionQuota

object

User subscription quota response

Properties

`currentValue`	integer	Current number of IotHub type
`id`	string	IotHub type id
`limit`	integer	Numerical limit on IotHub type
`name`	Name	IotHub type
`type`	string	Response type
`unit`	string	Unit of IotHub type

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth

Get the health for routing endpoints.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string
`iotHubName`	string

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200OK

Body

Name	Data Type	Description
`EndpointHealthDataListResult`	object	The JSON-serialized array of EndpointHealthData objects with a next link.

Properties


                        nextLink

string
Read-only

Link to more results


                        value

array [EndpointHealthData]

JSON-serialized array of Endpoint health data


                        EndpointHealthData

object

The health data for an endpoint

Properties

`endpointId`	string	Id of the endpoint
`healthStatus`	string Allowed values: - `unknown` - `healthy` - `unhealthy` - `dead`	Health status

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats

Get the statistics from an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.

Body

Name	Data Type	Description
`RegistryStatistics`	object	Identity registry statistics.

Properties

`disabledDeviceCount`	long Read-only	The count of disabled devices in the identity registry.
`enabledDeviceCount`	long Read-only	The count of enabled devices in the identity registry.
`totalDeviceCount`	long Read-only	The total count of devices in the identity registry.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint in the IoT hub.
`name`	string	The name of the consumer group to retrieve.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized consumer group.

Body

Name	Data Type	Description
`EventHubConsumerGroupInfo`	object	The properties of the EventHubConsumerGroupInfo object.

Properties

`etag`	string Read-only	The etag.
`id`	string Read-only	The Event Hub-compatible consumer group identifier.
`name`	string Read-only	The Event Hub-compatible consumer group name.
`properties`	object	The tags.
`type`	string Read-only	the resource type.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub

Body

Name	Data Type	Description
`EventHubConsumerGroupsListResult`	object	The JSON-serialized array of Event Hub-compatible consumer group names with a next link.

Properties


                        nextLink

string
Read-only

The next link.


                        value

array [EventHubConsumerGroupInfo]

List of consumer groups objects


                        EventHubConsumerGroupInfo

object

The properties of the EventHubConsumerGroupInfo object.

Properties

`etag`	string Read-only	The etag.
`id`	string Read-only	The Event Hub-compatible consumer group identifier.
`name`	string Read-only	The Event Hub-compatible consumer group name.
`properties`	object	The tags.
`type`	string Read-only	the resource type.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}

Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`jobId`	string	The job identifier.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.

Body

Name	Data Type	Description
`JobResponse`	object	The properties of the Job Response object.

Properties

`endTimeUtc`	string Read-only	The time the job stopped processing.
`failureReason`	string Read-only	If status == failed, this string containing the reason for the failure.
`jobId`	string Read-only	The job identifier.
`parentJobId`	string Read-only	The job identifier of the parent job, if any.
`startTimeUtc`	string Read-only	The start time of the job.
`status`	string Read-only Allowed values: - `unknown` - `enqueued` - `running` - `completed` - `failed` - `cancelled`	The status of the job.
`statusMessage`	string Read-only	The status message for the job.
`type`	string Read-only Allowed values: - `unknown` - `export` - `import` - `backup` - `readDeviceProperties` - `writeDeviceProperties` - `updateDeviceConfiguration` - `rebootDevice` - `factoryResetDevice` - `firmwareUpdate`	The type of the job.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs

Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The response contains a JSON-serialized array of all the jobs in the IoT hub.

Body

Name	Data Type	Description
`JobResponseListResult`	object	The JSON-serialized array of JobResponse objects with a next link.

Properties


                        nextLink

string
Read-only

The next link.


                        value

array [JobResponse]

The array of JobResponse objects.


                        JobResponse

object

The properties of the Job Response object.

Properties

`endTimeUtc`	string Read-only	The time the job stopped processing.
`failureReason`	string Read-only	If status == failed, this string containing the reason for the failure.
`jobId`	string Read-only	The job identifier.
`parentJobId`	string Read-only	The job identifier of the parent job, if any.
`startTimeUtc`	string Read-only	The start time of the job.
`status`	string Read-only Allowed values: - `unknown` - `enqueued` - `running` - `completed` - `failed` - `cancelled`	The status of the job.
`statusMessage`	string Read-only	The status message for the job.
`type`	string Read-only Allowed values: - `unknown` - `export` - `import` - `backup` - `readDeviceProperties` - `writeDeviceProperties` - `updateDeviceConfiguration` - `rebootDevice` - `factoryResetDevice` - `firmwareUpdate`	The type of the job.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics

Get the quota metrics for an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The response contains a JSON-serialized array of the quota metrics for the IoT hub.

Body

Name	Data Type	Description
`IotHubQuotaMetricInfoListResult`	object	The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

Properties


                        nextLink

string
Read-only

The next link.


                        value

array [IotHubQuotaMetricInfo]

The array of quota metrics objects.


                        IotHubQuotaMetricInfo

object

Quota metrics properties.

Properties

`currentValue`	long Read-only	The current value for the quota metric.
`maxValue`	long Read-only	The maximum value of the quota metric.
`name`	string Read-only	The name of the quota metric.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus

Get the list of valid SKUs for an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this IoT hub.

Body

Name	Data Type	Description
`IotHubSkuDescriptionListResult`	object	The JSON-serialized array of IotHubSkuDescription objects with a next link.

Properties


                        nextLink

string
Read-only

The next link.


                        value

array [IotHubSkuDescription]

The array of IotHubSkuDescription.


                        IotHubSkuDescription

object

SKU properties.

Properties


                        capacity

IotHubCapacity

IotHub capacity


                        resourceType

string
Read-only

The type of the resource.

sku

IotHubSkuInfo

The type of the resource.


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}

Get the non-security related metadata of an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200The body contains all the non-security properties of the IoT hub. Security-related properties are set to null.

Body

Name	Data Type	Description
`IotHubDescription`	object	The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs

Get all the IoT hubs in a resource group.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the resource group.

Body

Name	Data Type	Description
`IotHubDescriptionListResult`	object	The JSON-serialized array of IotHubDescription objects with a next link.

Properties


                        nextLink

string
Read-only

The next link.


                        value

array [IotHubDescription]

The array of IotHubDescription objects.


                        IotHubDescription

object

The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties

`authorizationPolicies`	array [SharedAccessSignatureAuthorizationRule]	The shared access policies you can use to secure a connection to the IoT hub.
`cloudToDevice`	CloudToDeviceProperties
`comments`	string	IoT hub comments.
`enableFileUploadNotifications`	boolean	If True, file upload notifications are enabled.
`eventHubEndpoints`	object	The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
`features`	string Allowed values: - `None` - `DeviceManagement`	The capabilities and features enabled for the IoT hub.
`hostName`	string Read-only	The name of the host.
`ipFilterRules`	array [IpFilterRule]	The IP filter rules.
`messagingEndpoints`	object	The messaging endpoint properties for the file upload notification queue.
`operationsMonitoringProperties`	OperationsMonitoringProperties
`provisioningState`	string Read-only	The provisioning state.
`routing`	RoutingProperties
`state`	string Read-only	The hub state.
`storageEndpoints`	object	The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

Operations

GET

/providers/Microsoft.Devices/operations

Lists all of the available IoT Hub REST API operations.

Request

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200OK. The request has succeeded.

Body

Name	Data Type	Description
`OperationListResult`		Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.

Properties


                        nextLink

string
Read-only

URL to get the next set of operation list results if there are any.


                        value

array [Operation]

List of IoT Hub operations supported by the Microsoft.Devices resource provider.


                        Operation

object

IoT Hub REST API operation

Properties

`display`
`name`	string Read-only	Operation name: {provider}/{resource}/{read \| write \| action \| delete}

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}

Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	Resource group identifier.
`resourceName`	string	Name of iot hub to update.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Body

Name	Data Type	Description
`TagsResource`		A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.

Properties


                        tags

Resource tags

Responses

200Iot Hub was successfully updated

Body

Name	Data Type	Description
`IotHubDescription`	object	The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

POST

/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability

Check if an IoT hub name is available.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Body

Name	Data Type	Description
`OperationInputs`	object	Input values.

Properties


                        name

string

The name of the IoT hub to check.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT hub name is available. If the name is not available, the body contains the reason.

Body

Name	Data Type	Description
`IotHubNameAvailabilityInfo`	object	The properties indicating whether a given IoT hub name is available.

Properties

`message`	string	The detailed reason message.
`nameAvailable`	boolean Read-only	The value which indicates whether the provided name is available.
`reason`	string Read-only Allowed values: - `Invalid` - `AlreadyExists`	The reason for unavailability.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall

Test all routes configured in this Iot Hub

Request

Path

Name	Data Type	Description
`iotHubName`	string	IotHub to be tested
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	resource group which Iot Hub belongs to

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Body

Name	Data Type	Description
`TestAllRoutesInput`	object	Input for testing all routes

Properties


                        message

RoutingMessage

Routing message


                        RoutingMessage

object

Routing message

Properties

`appProperties`	object	App properties
`body`	string	Body of routing message
`systemProperties`	object	System properties


                        routingSource

string
Allowed values:
- Invalid
- DeviceMessages
- TwinChangeEvents
- DeviceLifecycleEvents
- DeviceJobLifecycleEvents

Routing source


                        twin

RoutingTwin

Routing Twin Reference


                        RoutingTwin

object

Twin reference input parameter. This is an optional parameter

Properties

`properties`
`tags`	object	Twin Tags

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200OK

Body

Name	Data Type	Description
`TestAllRoutesResult`	object	Result of testing all routes

Properties


                        routes

array [MatchedRoute]

JSON-serialized array of matched routes


                        MatchedRoute

object

Routes that matched

Properties


                        properties

RouteProperties

Properties of routes that matched


                        RouteProperties

object

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Properties

`condition`	string	The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
`endpointNames`	array [] Minimum: 1 Maximum: 1	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew

Test the new route for this Iot Hub

Request

Path

Name	Data Type	Description
`iotHubName`	string	IotHub to be tested
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	resource group which Iot Hub belongs to

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Body

Name	Data Type	Description
`TestRouteInput`	object	Input for testing route

Properties


                        message

RoutingMessage

Routing message


                        RoutingMessage

object

Routing message

Properties

`appProperties`	object	App properties
`body`	string	Body of routing message
`systemProperties`	object	System properties


                        route

RouteProperties

Route properties


                        RouteProperties

object

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Properties

`condition`	string	The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
`endpointNames`	array [] Minimum: 1 Maximum: 1	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.


                        twin

RoutingTwin

Routing Twin Reference


                        RoutingTwin

object

Twin reference input parameter. This is an optional parameter

Properties

`properties`
`tags`	object	Twin Tags

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200OK

Body

Name	Data Type	Description
`TestRouteResult`	object	Result of testing one route

Properties


                        details

TestRouteResultDetails

Detailed result of testing route


                        TestRouteResultDetails

object

Detailed result of testing a route

Properties


                        compilationErrors

array [RouteCompilationError]

JSON-serialized list of route compilation errors


                        result

string
Allowed values:
- undefined
- false
- true

Result of testing route

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys

Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`keyName`	string	The name of the shared access policy.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more IoT hub endpoints.

Body

Name	Data Type	Description
`SharedAccessSignatureAuthorizationRule`	object	The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices

Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Body

Name	Data Type	Description
`ExportDevicesRequest`	object	Use to provide parameters when requesting an export of all devices in the IoT hub.

Properties

`excludeKeys`	boolean	The value indicating whether keys should be excluded during export.
`exportBlobContainerUri`	string	The export blob container URI.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200OK

Body

Name	Data Type	Description
`JobResponse`	object	The properties of the Job Response object.

Properties

`endTimeUtc`	string Read-only	The time the job stopped processing.
`failureReason`	string Read-only	If status == failed, this string containing the reason for the failure.
`jobId`	string Read-only	The job identifier.
`parentJobId`	string Read-only	The job identifier of the parent job, if any.
`startTimeUtc`	string Read-only	The start time of the job.
`status`	string Read-only Allowed values: - `unknown` - `enqueued` - `running` - `completed` - `failed` - `cancelled`	The status of the job.
`statusMessage`	string Read-only	The status message for the job.
`type`	string Read-only Allowed values: - `unknown` - `export` - `import` - `backup` - `readDeviceProperties` - `writeDeviceProperties` - `updateDeviceConfiguration` - `rebootDevice` - `factoryResetDevice` - `firmwareUpdate`	The type of the job.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices

Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Body

Name	Data Type	Description
`ImportDevicesRequest`	object	Use to provide parameters when requesting an import of all devices in the hub.

Properties

`inputBlobContainerUri`	string	The input blob container URI.
`outputBlobContainerUri`	string	The output blob container URI.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200OK

Body

Name	Data Type	Description
`JobResponse`	object	The properties of the Job Response object.

Properties

`endTimeUtc`	string Read-only	The time the job stopped processing.
`failureReason`	string Read-only	If status == failed, this string containing the reason for the failure.
`jobId`	string Read-only	The job identifier.
`parentJobId`	string Read-only	The job identifier of the parent job, if any.
`startTimeUtc`	string Read-only	The start time of the job.
`status`	string Read-only Allowed values: - `unknown` - `enqueued` - `running` - `completed` - `failed` - `cancelled`	The status of the job.
`statusMessage`	string Read-only	The status message for the job.
`type`	string Read-only Allowed values: - `unknown` - `export` - `import` - `backup` - `readDeviceProperties` - `writeDeviceProperties` - `updateDeviceConfiguration` - `rebootDevice` - `factoryResetDevice` - `firmwareUpdate`	The type of the job.

POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys

Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the IoT hub endpoints.

Body

Name	Data Type	Description
`SharedAccessSignatureAuthorizationRuleListResult`	object	The list of shared access policies with a next link.

Properties


                        nextLink

string
Read-only

The next link.


                        value

array [SharedAccessSignatureAuthorizationRule]

The list of shared access policies.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}

Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint in the IoT hub.
`name`	string	The name of the consumer group to add.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is a synchronous operation.

Body

Name	Data Type	Description
`EventHubConsumerGroupInfo`	object	The properties of the EventHubConsumerGroupInfo object.

Properties

`etag`	string Read-only	The etag.
`id`	string Read-only	The Event Hub-compatible consumer group identifier.
`name`	string Read-only	The Event Hub-compatible consumer group name.
`properties`	object	The tags.
`type`	string Read-only	the resource type.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}

Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	The subscription identifier.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`resourceName`	string	The name of the IoT hub.

Query

Name	Data Type	Description
`api-version`	string	The version of the API.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.

Body

Name	Data Type	Description
`IotHubDescription`	object	The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

`code`	string Read-only	The error code.
`details`	string Read-only	The error details.
`httpStatusCode`	string Read-only	The HTTP status code.
`message`	string Read-only	The error message.

200This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.

Body

Name	Data Type	Description
`IotHubDescription`	object	The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

201This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).

Body

Name	Data Type	Description
`IotHubDescription`	object	The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

Models

CertificateBodyDescription

CertificateDescription

The X509 Certificate.

Properties

Name Data Type Description


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.


                        type

string
Read-only

The resource type.

CertificateListDescription

The JSON-serialized array of Certificate objects.

Properties

Name Data Type Description


                        value

array [CertificateDescription]

The array of Certificate objects.


                        CertificateDescription

object

The X509 Certificate.

Properties


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.


                        type

string
Read-only

The resource type.

CertificateProperties

The description of an X509 CA Certificate.

Properties

Name	Data Type	Description
`certificate`	string	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.

CertificatePropertiesWithNonce

The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

Properties

Name	Data Type	Description
`certificate`	string Read-only	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.
`verificationCode`	string Read-only	The certificate's verification code that will be used for proof of possession.

CertificateVerificationDescription

CertificateWithNonceDescription

The X509 Certificate.

Properties

Name Data Type Description


                        etag

string
Read-only

The entity tag.

id

string
Read-only

The resource identifier.


                        name

string
Read-only

The name of the certificate.

properties CertificatePropertiesWithNonce


                        CertificatePropertiesWithNonce

object

The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

Properties

`certificate`	string Read-only	The certificate content
`created`	string Read-only	The certificate's create date and time.
`expiry`	string Read-only	The certificate's expiration date and time.
`isVerified`	boolean Read-only	Determines whether certificate has been verified.
`subject`	string Read-only	The certificate's subject name.
`thumbprint`	string Read-only	The certificate's thumbprint.
`updated`	string Read-only	The certificate's last update date and time.
`verificationCode`	string Read-only	The certificate's verification code that will be used for proof of possession.


                        type

string
Read-only

The resource type.

EndpointHealthData

EndpointHealthDataListResult

ErrorDetails

EventHubConsumerGroupInfo

EventHubConsumerGroupsListResult

The JSON-serialized array of Event Hub-compatible consumer group names with a next link.

Properties

Name Data Type Description


                        nextLink

string
Read-only

The next link.


                        value

array [EventHubConsumerGroupInfo]

List of consumer groups objects


                        EventHubConsumerGroupInfo

object

The properties of the EventHubConsumerGroupInfo object.

Properties

`etag`	string Read-only	The etag.
`id`	string Read-only	The Event Hub-compatible consumer group identifier.
`name`	string Read-only	The Event Hub-compatible consumer group name.
`properties`	object	The tags.
`type`	string Read-only	the resource type.

ExportDevicesRequest

ImportDevicesRequest

IotHubDescription

The description of the IoT hub.

Properties

Name Data Type Description


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

IotHubDescriptionListResult

The JSON-serialized array of IotHubDescription objects with a next link.

Properties

Name Data Type Description


                        nextLink

string
Read-only

The next link.


                        value

array [IotHubDescription]

The array of IotHubDescription objects.


                        IotHubDescription

object

The description of the IoT hub.

Properties


                        etag

string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

IotHubNameAvailabilityInfo

IotHubProperties

The properties of an IoT hub.

Properties

Name Data Type Description


                        authorizationPolicies

array [SharedAccessSignatureAuthorizationRule]

The shared access policies you can use to secure a connection to the IoT hub.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

cloudToDevice CloudToDeviceProperties


                        comments

string

IoT hub comments.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        eventHubEndpoints

object


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        hostName

string
Read-only

The name of the host.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.

operationsMonitoringProperties OperationsMonitoringProperties


                        provisioningState

string
Read-only

The provisioning state.

routing RoutingProperties


                        state

string
Read-only

The hub state.


                        storageEndpoints

object

IotHubQuotaMetricInfo

IotHubQuotaMetricInfoListResult

The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

Properties

Name Data Type Description


                        nextLink

string
Read-only

The next link.


                        value

array [IotHubQuotaMetricInfo]

The array of quota metrics objects.


                        IotHubQuotaMetricInfo

object

Quota metrics properties.

Properties

`currentValue`	long Read-only	The current value for the quota metric.
`maxValue`	long Read-only	The maximum value of the quota metric.
`name`	string Read-only	The name of the quota metric.

IotHubSkuDescription

SKU properties.

Properties

Name Data Type Description


                        capacity

IotHubCapacity

IotHub capacity


                        resourceType

string
Read-only

The type of the resource.

sku

IotHubSkuInfo

The type of the resource.


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

IotHubSkuDescriptionListResult

The JSON-serialized array of IotHubSkuDescription objects with a next link.

Properties

Name Data Type Description


                        nextLink

string
Read-only

The next link.


                        value

array [IotHubSkuDescription]

The array of IotHubSkuDescription.


                        IotHubSkuDescription

object

SKU properties.

Properties


                        capacity

IotHubCapacity

IotHub capacity


                        resourceType

string
Read-only

The type of the resource.

sku

IotHubSkuInfo

The type of the resource.


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

`capacity`	long	The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name`	string Allowed values: - `F1` - `S1` - `S2` - `S3` - `B1` - `B2` - `B3`	The name of the SKU.
`tier`	string Read-only Allowed values: - `Free` - `Standard` - `Basic`	The billing tier for the IoT hub.

IotHubSkuInfo

JobResponse

The properties of the Job Response object.

Properties

Name	Data Type	Description
`endTimeUtc`	string Read-only	The time the job stopped processing.
`failureReason`	string Read-only	If status == failed, this string containing the reason for the failure.
`jobId`	string Read-only	The job identifier.
`parentJobId`	string Read-only	The job identifier of the parent job, if any.
`startTimeUtc`	string Read-only	The start time of the job.
`status`	string Read-only Allowed values: - `unknown` - `enqueued` - `running` - `completed` - `failed` - `cancelled`	The status of the job.
`statusMessage`	string Read-only	The status message for the job.
`type`	string Read-only Allowed values: - `unknown` - `export` - `import` - `backup` - `readDeviceProperties` - `writeDeviceProperties` - `updateDeviceConfiguration` - `rebootDevice` - `factoryResetDevice` - `firmwareUpdate`	The type of the job.

JobResponseListResult

The JSON-serialized array of JobResponse objects with a next link.

Properties

Name Data Type Description


                        nextLink

string
Read-only

The next link.


                        value

array [JobResponse]

The array of JobResponse objects.


                        JobResponse

object

The properties of the Job Response object.

Properties

`endTimeUtc`	string Read-only	The time the job stopped processing.
`failureReason`	string Read-only	If status == failed, this string containing the reason for the failure.
`jobId`	string Read-only	The job identifier.
`parentJobId`	string Read-only	The job identifier of the parent job, if any.
`startTimeUtc`	string Read-only	The start time of the job.
`status`	string Read-only Allowed values: - `unknown` - `enqueued` - `running` - `completed` - `failed` - `cancelled`	The status of the job.
`statusMessage`	string Read-only	The status message for the job.
`type`	string Read-only Allowed values: - `unknown` - `export` - `import` - `backup` - `readDeviceProperties` - `writeDeviceProperties` - `updateDeviceConfiguration` - `rebootDevice` - `factoryResetDevice` - `firmwareUpdate`	The type of the job.

MatchedRoute

Routes that matched

Properties

Name Data Type Description


                        properties

RouteProperties

Properties of routes that matched


                        RouteProperties

object

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Properties

`condition`	string	The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
`endpointNames`	array [] Minimum: 1 Maximum: 1	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.

Operation

OperationInputs

OperationListResult

RegistryStatistics

RouteProperties

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Properties

Name	Data Type	Description
`condition`	string	The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
`endpointNames`	array [] Minimum: 1 Maximum: 1	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.

RoutingMessage

RoutingTwin

SharedAccessSignatureAuthorizationRule

SharedAccessSignatureAuthorizationRuleListResult

The list of shared access policies with a next link.

Properties

Name Data Type Description


                        nextLink

string
Read-only

The next link.


                        value

array [SharedAccessSignatureAuthorizationRule]

The list of shared access policies.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`keyName`	string	The name of the shared access policy.
`primaryKey`	string	The primary key.
`rights`	string Allowed values: - `RegistryRead` - `RegistryWrite` - `ServiceConnect` - `DeviceConnect` - `RegistryRead, RegistryWrite` - `RegistryRead, ServiceConnect` - `RegistryRead, DeviceConnect` - `RegistryWrite, ServiceConnect` - `RegistryWrite, DeviceConnect` - `ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect` - `RegistryRead, RegistryWrite, DeviceConnect` - `RegistryRead, ServiceConnect, DeviceConnect` - `RegistryWrite, ServiceConnect, DeviceConnect` - `RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect`	The permissions assigned to the shared access policy.
`secondaryKey`	string	The secondary key.

TagsResource

TestAllRoutesInput

Input for testing all routes

Properties

Name Data Type Description


                        message

RoutingMessage

Routing message


                        RoutingMessage

object

Routing message

Properties

`appProperties`	object	App properties
`body`	string	Body of routing message
`systemProperties`	object	System properties


                        routingSource

string
Allowed values:
- Invalid
- DeviceMessages
- TwinChangeEvents
- DeviceLifecycleEvents
- DeviceJobLifecycleEvents

Routing source


                        twin

RoutingTwin

Routing Twin Reference


                        RoutingTwin

object

Twin reference input parameter. This is an optional parameter

Properties

`properties`
`tags`	object	Twin Tags

TestAllRoutesResult

Result of testing all routes

Properties

Name Data Type Description


                        routes

array [MatchedRoute]

JSON-serialized array of matched routes


                        MatchedRoute

object

Routes that matched

Properties


                        properties

RouteProperties

Properties of routes that matched


                        RouteProperties

object

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Properties

`condition`	string	The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
`endpointNames`	array [] Minimum: 1 Maximum: 1	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.

TestRouteInput

Input for testing route

Properties

Name Data Type Description


                        message

RoutingMessage

Routing message


                        RoutingMessage

object

Routing message

Properties

`appProperties`	object	App properties
`body`	string	Body of routing message
`systemProperties`	object	System properties


                        route

RouteProperties

Route properties


                        RouteProperties

object

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Properties

`condition`	string	The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
`endpointNames`	array [] Minimum: 1 Maximum: 1	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.


                        twin

RoutingTwin

Routing Twin Reference


                        RoutingTwin

object

Twin reference input parameter. This is an optional parameter

Properties

`properties`
`tags`	object	Twin Tags

TestRouteResult

TestRouteResultDetails

UserSubscriptionQuota

UserSubscriptionQuotaListResult

Json-serialized array of User subscription quota response

Properties

Name Data Type Description

nextLink string
Read-only

value array [UserSubscriptionQuota]


                        UserSubscriptionQuota

object

User subscription quota response

Properties

`currentValue`	integer	Current number of IotHub type
`id`	string	IotHub type id
`limit`	integer	Numerical limit on IotHub type
`name`	Name	IotHub type
`type`	string	Response type
`unit`	string	Unit of IotHub type

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Azure Active Directory OAuth2 Flow

Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Scopes:

user_impersonation: impersonate your user account

Metadata (Technical Details)

Ms-code-generation-settings	`{ "header": "MICROSOFT_MIT_NO_VERSION" }`
Origin - Format	`swagger`
Origin - Url	`https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json`
Origin - Version	`2.0`
Preferred	`No`
Provider Name	`azure.com`
Service Name	`iothub`
API Version	`2018-04-01`

Comments

Loading comments ...