Microsoft Azure - API iotHubClient

Microsoft Azure / iotHubClient

iotHubClient

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
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`subscriptionId`	string	The subscription identifier.

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

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

200The body contains the certificate.

Body

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

Properties


                        type

string
Read-only

The resource type.

properties CertificatePropertiesWithNonce


                        CertificatePropertiesWithNonce

object

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

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

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
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`subscriptionId`	string	The subscription identifier.

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

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

200The body contains the certificate.

Body

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

Properties


                        type

string
Read-only

The resource type.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

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
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`subscriptionId`	string	The subscription identifier.

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

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

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
`certificateName`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name of the certificate
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

200The body contains the certificate.

Body

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

Properties


                        type

string
Read-only

The resource type.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

PUT

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

Adds new or replaces existing certificate.

Request

Path

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

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

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

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


                        type

string
Read-only

The resource type.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

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


                        type

string
Read-only

The resource type.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

GET

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

Returns the list of certificates.

Request

Path

Name	Data Type	Description
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        type

string
Read-only

The resource type.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

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
`name`	string	The name of the consumer group to delete.
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint in the IoT hub.
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        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.


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        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.


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

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


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

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

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

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

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

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


                        value

array [IotHubDescription]

The array of IotHubDescription objects.


                        IotHubDescription

object

The description of the IoT hub.

Properties


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties

`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.
`state`	string Read-only	The hub state.
`routing`	RoutingProperties
`provisioningState`	string Read-only	The provisioning state.
`operationsMonitoringProperties`	OperationsMonitoringProperties
`messagingEndpoints`	object	The messaging endpoint properties for the file upload notification queue.
`ipFilterRules`	array [IpFilterRule]	The IP filter rules.
`hostName`	string Read-only	The name of the host.
`features`	string Allowed values: - `None` - `DeviceManagement`	The capabilities and features enabled for the IoT hub.
`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.
`enableFileUploadNotifications`	boolean	If True, file upload notifications are enabled.
`comments`	string	IoT hub comments.
`cloudToDevice`	CloudToDeviceProperties
`authorizationPolicies`	array [SharedAccessSignatureAuthorizationRule]	The shared access policies you can use to secure a connection to the IoT hub.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.


                        nextLink

string
Read-only

The next link.

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

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

200OK

Body

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

Properties

value array [UserSubscriptionQuota]


                        UserSubscriptionQuota

object

User subscription quota response

Properties


                        unit

string

Unit of IotHub type


                        type

string

Response type


                        name

Name

IotHub type


                        Name

object

Name of Iot Hub type

Properties

`value`	string	IotHub type
`localizedValue`	string	Localized value of name


                        limit

integer

Numerical limit on IotHub type

id

string

IotHub type id


                        currentValue

integer

Current number of IotHub type

nextLink string
Read-only

GET

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

Get the health for routing endpoints.

Request

Path

Name	Data Type	Description
`iotHubName`	string
`resourceGroupName`	string
`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

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

200OK

Body

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

Properties


                        value

array [EndpointHealthData]

JSON-serialized array of Endpoint health data


                        EndpointHealthData

object

The health data for an endpoint

Properties

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


                        nextLink

string
Read-only

Link to more results

GET

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

Get the statistics from an IoT hub.

Request

Path

Name	Data Type	Description
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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

`totalDeviceCount`	long Read-only	The total count of devices in the identity registry.
`enabledDeviceCount`	long Read-only	The count of enabled devices in the identity registry.
`disabledDeviceCount`	long Read-only	The count of disabled 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
`name`	string	The name of the consumer group to retrieve.
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint in the IoT hub.
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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

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

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
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint.
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        value

array [EventHubConsumerGroupInfo]

List of consumer groups objects


                        EventHubConsumerGroupInfo

object

The properties of the EventHubConsumerGroupInfo object.

Properties

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


                        nextLink

string
Read-only

The next link.

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
`jobId`	string	The job identifier.
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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

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

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        value

array [JobResponse]

The array of JobResponse objects.


                        JobResponse

object

The properties of the Job Response object.

Properties

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


                        nextLink

string
Read-only

The next link.

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        value

array [IotHubQuotaMetricInfo]

The array of quota metrics objects.


                        IotHubQuotaMetricInfo

object

Quota metrics properties.

Properties

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


                        nextLink

string
Read-only

The next link.

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        value

array [IotHubSkuDescription]

The array of IotHubSkuDescription.


                        IotHubSkuDescription

object

SKU properties.

Properties

sku

IotHubSkuInfo

The type of the resource.


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        resourceType

string
Read-only

The type of the resource.


                        capacity

IotHubCapacity

IotHub capacity


                        IotHubCapacity

object

IoT Hub capacity information.

Properties

`scaleType`	string Read-only Allowed values: - `Automatic` - `Manual` - `None`	The type of the scaling enabled.
`minimum`	long Read-only Minimum: 1 Maximum: 1	The minimum number of units.
`maximum`	long Read-only	The maximum number of units.
`default`	long Read-only	The default number of units.


                        nextLink

string
Read-only

The next link.

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

GET

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

Get all the IoT hubs in a resource group.

Request

Path

Name	Data Type	Description
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        value

array [IotHubDescription]

The array of IotHubDescription objects.


                        IotHubDescription

object

The description of the IoT hub.

Properties


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties

`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.
`state`	string Read-only	The hub state.
`routing`	RoutingProperties
`provisioningState`	string Read-only	The provisioning state.
`operationsMonitoringProperties`	OperationsMonitoringProperties
`messagingEndpoints`	object	The messaging endpoint properties for the file upload notification queue.
`ipFilterRules`	array [IpFilterRule]	The IP filter rules.
`hostName`	string Read-only	The name of the host.
`features`	string Allowed values: - `None` - `DeviceManagement`	The capabilities and features enabled for the IoT hub.
`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.
`enableFileUploadNotifications`	boolean	If True, file upload notifications are enabled.
`comments`	string	IoT hub comments.
`cloudToDevice`	CloudToDeviceProperties
`authorizationPolicies`	array [SharedAccessSignatureAuthorizationRule]	The shared access policies you can use to secure a connection to the IoT hub.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.


                        nextLink

string
Read-only

The next link.

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

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

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


                        value

array [Operation]

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


                        Operation

object

IoT Hub REST API operation

Properties

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


                        nextLink

string
Read-only

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

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
`resourceName`	string	Name of iot hub to update.
`resourceGroupName`	string	Resource group identifier.
`subscriptionId`	string	The subscription identifier.

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


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

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

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

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

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

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
`resourceGroupName`	string	resource group which Iot Hub belongs to
`subscriptionId`	string	The subscription identifier.
`iotHubName`	string	IotHub to be tested

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


                        twin

RoutingTwin

Routing Twin Reference


                        RoutingTwin

object

Twin reference input parameter. This is an optional parameter

Properties

`tags`	object	Twin Tags
`properties`


                        routingSource

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

Routing source


                        message

RoutingMessage

Routing message


                        RoutingMessage

object

Routing message

Properties

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

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

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

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

`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.
`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.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`endpointNames`	array [string]	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`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

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
`resourceGroupName`	string	resource group which Iot Hub belongs to
`subscriptionId`	string	The subscription identifier.
`iotHubName`	string	IotHub to be tested

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


                        twin

RoutingTwin

Routing Twin Reference


                        RoutingTwin

object

Twin reference input parameter. This is an optional parameter

Properties

`tags`	object	Twin Tags
`properties`


                        route

RouteProperties

Route properties


                        RouteProperties

object

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

Properties

`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.
`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.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`endpointNames`	array [string]	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`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


                        message

RoutingMessage

Routing message


                        RoutingMessage

object

Routing message

Properties

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

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

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

200OK

Body

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

Properties


                        result

string
Allowed values:
- undefined
- false
- true

Result of testing route


                        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


                        RouteCompilationError

object

Compilation error when evaluating route

Properties

`severity`	string Allowed values: - `error` - `warning`	Severity of the route error
`message`	string	Route error message
`location`	RouteErrorRange	Location where the route error happened

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
`keyName`	string	The name of the shared access policy.
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`subscriptionId`	string	The subscription identifier.

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

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

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

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

200OK

Body

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

Properties

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

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`subscriptionId`	string	The subscription identifier.

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

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

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

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

200OK

Body

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

Properties

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

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

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


                        value

array [SharedAccessSignatureAuthorizationRule]

The list of shared access policies.


                        SharedAccessSignatureAuthorizationRule

object

The properties of an IoT hub shared access policy.

Properties

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        nextLink

string
Read-only

The next link.

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
`name`	string	The name of the consumer group to add.
`eventHubEndpointName`	string	The name of the Event Hub-compatible endpoint in the IoT hub.
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`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

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

200This is a synchronous operation.

Body

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

Properties

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

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
`resourceName`	string	The name of the IoT hub.
`resourceGroupName`	string	The name of the resource group that contains the IoT hub.
`subscriptionId`	string	The subscription identifier.

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


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

Responses

200DefaultErrorResponse

Body

Name	Data Type	Description
`ErrorDetails`	object	Error details.

Properties

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

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


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

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


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

Models

CertificateBodyDescription

CertificateDescription

The X509 Certificate.

Properties

Name Data Type Description


                        type

string
Read-only

The resource type.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

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


                        type

string
Read-only

The resource type.

properties CertificateProperties


                        CertificateProperties

object

The description of an X509 CA Certificate.

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

CertificateProperties

The description of an X509 CA Certificate.

Properties

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

CertificatePropertiesWithNonce

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

Properties

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

CertificateVerificationDescription

CertificateWithNonceDescription

The X509 Certificate.

Properties

Name Data Type Description


                        type

string
Read-only

The resource type.

properties CertificatePropertiesWithNonce


                        CertificatePropertiesWithNonce

object

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

Properties

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


                        name

string
Read-only

The name of the certificate.

id

string
Read-only

The resource identifier.


                        etag

string
Read-only

The entity tag.

CloudToDeviceProperties

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


                        value

array [EventHubConsumerGroupInfo]

List of consumer groups objects


                        EventHubConsumerGroupInfo

object

The properties of the EventHubConsumerGroupInfo object.

Properties

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


                        nextLink

string
Read-only

The next link.

EventHubProperties

ExportDevicesRequest

FallbackRouteProperties

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

Properties

Name	Data Type	Description
`source`	string Allowed values: - `DeviceMessages`	The source to which the routing rule is to be applied to. For example, DeviceMessages
`name`	string	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.
`isEnabled`	boolean	Used to specify whether the fallback route is enabled.
`endpointNames`	array [string]	The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
`condition`	string	The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

FeedbackProperties

ImportDevicesRequest

IotHubCapacity

IotHubDescription

The description of the IoT hub.

Properties

Name Data Type Description


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties


                        routes

array [RouteProperties]

The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.


                        RouteProperties

object

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

Properties

`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.
`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.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`endpointNames`	array [string]	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`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


                        fallbackRoute

FallbackRouteProperties

The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.


                        FallbackRouteProperties

object

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

Properties

`source`	string Allowed values: - `DeviceMessages`	The source to which the routing rule is to be applied to. For example, DeviceMessages
`name`	string	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.
`isEnabled`	boolean	Used to specify whether the fallback route is enabled.
`endpointNames`	array [string]	The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
`condition`	string	The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpoints RoutingEndpoints


                        RoutingEndpoints

object

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

Properties

`storageContainers`	array [RoutingStorageContainerProperties]	The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
`serviceBusTopics`	array [RoutingServiceBusTopicEndpointProperties]	The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
`serviceBusQueues`	array [RoutingServiceBusQueueEndpointProperties]	The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
`eventHubs`	array [RoutingEventHubProperties]	The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties


                        maxDeliveryCount

integer
Minimum: 1
Maximum: 100

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback FeedbackProperties


                        FeedbackProperties

object

The properties of the feedback queue for cloud-to-device messages.

Properties

`ttlAsIso8601`	string	The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`lockDurationAsIso8601`	string	The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        defaultTtlAsIso8601

string

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.

IotHubDescriptionListResult

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

Properties

Name Data Type Description


                        value

array [IotHubDescription]

The array of IotHubDescription objects.


                        IotHubDescription

object

The description of the IoT hub.

Properties


                        type

string
Read-only

The resource type.


                        tags

object

The resource tags.


                        name

string
Read-only
Pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

The resource name.


                        location

string

The resource location.

id

string
Read-only

The resource identifier.

sku

IotHubSkuInfo

IotHub SKU info


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        properties

IotHubProperties

IotHub properties


                        IotHubProperties

object

The properties of an IoT hub.

Properties


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties

`routes`	array [RouteProperties]	The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
`fallbackRoute`	FallbackRouteProperties	The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
`endpoints`	RoutingEndpoints


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties

`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`feedback`	FeedbackProperties
`defaultTtlAsIso8601`	string	The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.


                        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.

Extends

Resource

The common properties of an Azure resource.

Properties

Name	Data Type	Description
`type`	string Read-only	The resource type.
`tags`	object	The resource tags.
`name`	string Read-only Pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`	The resource name.
`location`	string	The resource location.
`id`	string Read-only	The resource identifier.


                        nextLink

string
Read-only

The next link.

IotHubNameAvailabilityInfo

IotHubProperties

The properties of an IoT hub.

Properties

Name Data Type Description


                        storageEndpoints

object


                        state

string
Read-only

The hub state.

routing RoutingProperties


                        RoutingProperties

object

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Properties


                        routes

array [RouteProperties]


                        RouteProperties

object

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

Properties

`source`	string Allowed values: - `Invalid` - `DeviceMessages` - `TwinChangeEvents` - `DeviceLifecycleEvents` - `DeviceJobLifecycleEvents`	The source that the routing rule is to be applied to, such as DeviceMessages.
`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.
`isEnabled`	boolean	Used to specify whether a route is enabled.
`endpointNames`	array [string]	The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`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


                        fallbackRoute

FallbackRouteProperties


                        FallbackRouteProperties

object

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

Properties

`source`	string Allowed values: - `DeviceMessages`	The source to which the routing rule is to be applied to. For example, DeviceMessages
`name`	string	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.
`isEnabled`	boolean	Used to specify whether the fallback route is enabled.
`endpointNames`	array [string]	The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
`condition`	string	The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpoints RoutingEndpoints


                        RoutingEndpoints

object

Properties


                        storageContainers

array [RoutingStorageContainerProperties]

The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.


                        RoutingStorageContainerProperties

object

The properties related to a storage container endpoint.

Properties

`subscriptionId`	string	The subscription identifier of the storage account.
`resourceGroup`	string	The name of the resource group of the storage account.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
`maxChunkSizeInBytes`	integer Minimum: 10485760 Maximum: 524288000	Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
`fileNameFormat`	string	File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
`encoding`	string	Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.
`containerName`	string	The name of storage container in the storage account.
`connectionString`	string	The connection string of the storage account.
`batchFrequencyInSeconds`	integer Minimum: 60 Maximum: 720	Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.


                        serviceBusTopics

array [RoutingServiceBusTopicEndpointProperties]

The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.


                        RoutingServiceBusTopicEndpointProperties

object

The properties related to service bus topic endpoint types.

Properties

`subscriptionId`	string	The subscription identifier of the service bus topic endpoint.
`resourceGroup`	string	The name of the resource group of the service bus topic endpoint.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
`connectionString`	string	The connection string of the service bus topic endpoint.


                        serviceBusQueues

array [RoutingServiceBusQueueEndpointProperties]

The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.


                        RoutingServiceBusQueueEndpointProperties

object

The properties related to service bus queue endpoint types.

Properties

`subscriptionId`	string	The subscription identifier of the service bus queue endpoint.
`resourceGroup`	string	The name of the resource group of the service bus queue endpoint.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
`connectionString`	string	The connection string of the service bus queue endpoint.


                        eventHubs

array [RoutingEventHubProperties]

The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.


                        RoutingEventHubProperties

object

The properties related to an event hub endpoint.

Properties

`subscriptionId`	string	The subscription identifier of the event hub endpoint.
`resourceGroup`	string	The name of the resource group of the event hub endpoint.
`name`	string Pattern: `^[A-Za-z0-9-._]{1,64}$`	The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
`connectionString`	string	The connection string of the event hub endpoint.


                        provisioningState

string
Read-only

The provisioning state.

operationsMonitoringProperties OperationsMonitoringProperties


                        OperationsMonitoringProperties

object

Properties

events object


                        messagingEndpoints

object

The messaging endpoint properties for the file upload notification queue.


                        ipFilterRules

array [IpFilterRule]

The IP filter rules.


                        IpFilterRule

object

The IP filter rules for the IoT hub.

Properties

`ipMask`	string	A string that contains the IP address range in CIDR notation for the rule.
`filterName`	string	The name of the IP filter rule.
`action`	string Allowed values: - `Accept` - `Reject`	The desired action for requests captured by this rule.


                        hostName

string
Read-only

The name of the host.


                        features

string
Allowed values:
- None
- DeviceManagement

The capabilities and features enabled for the IoT hub.


                        eventHubEndpoints

object


                        enableFileUploadNotifications

boolean

If True, file upload notifications are enabled.


                        comments

string

IoT hub comments.

cloudToDevice CloudToDeviceProperties


                        CloudToDeviceProperties

object

The IoT hub cloud-to-device messaging properties.

Properties


                        maxDeliveryCount

integer
Minimum: 1
Maximum: 100

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback FeedbackProperties


                        FeedbackProperties

object

The properties of the feedback queue for cloud-to-device messages.

Properties

`ttlAsIso8601`	string	The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`maxDeliveryCount`	integer Minimum: 1 Maximum: 100	The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`lockDurationAsIso8601`	string	The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        defaultTtlAsIso8601

string

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.


                        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

`secondaryKey`	string	The secondary 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.
`primaryKey`	string	The primary key.
`keyName`	string	The name of the shared access policy.

IotHubQuotaMetricInfo

IotHubQuotaMetricInfoListResult

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

Properties

Name Data Type Description


                        value

array [IotHubQuotaMetricInfo]

The array of quota metrics objects.


                        IotHubQuotaMetricInfo

object

Quota metrics properties.

Properties

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


                        nextLink

string
Read-only

The next link.

IotHubSkuDescription

SKU properties.

Properties

Name Data Type Description

sku

IotHubSkuInfo

The type of the resource.


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        resourceType

string
Read-only

The type of the resource.


                        capacity

IotHubCapacity

IotHub capacity


                        IotHubCapacity

object

IoT Hub capacity information.

Properties

`scaleType`	string Read-only Allowed values: - `Automatic` - `Manual` - `None`	The type of the scaling enabled.
`minimum`	long Read-only Minimum: 1 Maximum: 1	The minimum number of units.
`maximum`	long Read-only	The maximum number of units.
`default`	long Read-only	The default number of units.

IotHubSkuDescriptionListResult

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

Properties

Name Data Type Description


                        value

array [IotHubSkuDescription]

The array of IotHubSkuDescription.


                        IotHubSkuDescription

object

SKU properties.

Properties

sku

IotHubSkuInfo

The type of the resource.


                        IotHubSkuInfo

object

Information about the SKU of the IoT hub.

Properties

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


                        resourceType

string
Read-only

The type of the resource.


                        capacity

IotHubCapacity

IotHub capacity


                        IotHubCapacity

object

IoT Hub capacity information.

Properties

`scaleType`	string Read-only Allowed values: - `Automatic` - `Manual` - `None`	The type of the scaling enabled.
`minimum`	long Read-only Minimum: 1 Maximum: 1	The minimum number of units.
`maximum`	long Read-only	The maximum number of units.
`default`	long Read-only	The default number of units.


                        nextLink

string
Read-only

The next link.

IotHubSkuInfo