Use this API to manage the IoT hubs in your Azure subscription.
Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Certificate. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
CertificateWithNonceDescription
|
object |
The X509 Certificate. |
type
|
string Read-only |
The resource type. |
||||||||||||||||||||||||||||
properties
|
CertificatePropertiesWithNonce | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
name
|
string Read-only |
The name of the certificate. |
||||||||||||||||||||||||||||
id
|
string Read-only |
The resource identifier. |
||||||||||||||||||||||||||||
etag
|
string Read-only |
The entity tag. |
Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Certificate. |
Name | Data Type | Description |
---|---|---|
CertificateVerificationDescription
|
object |
The JSON-serialized leaf certificate |
certificate
|
string |
base-64 representation of X509 certificate .cer file or just .pem file content. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
CertificateDescription
|
object |
The X509 Certificate. |
type
|
string Read-only |
The resource type. |
|||||||||||||||||||||||||
properties
|
CertificateProperties | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name
|
string Read-only |
The name of the certificate. |
|||||||||||||||||||||||||
id
|
string Read-only |
The resource identifier. |
|||||||||||||||||||||||||
etag
|
string Read-only |
The entity tag. |
Deletes an existing X509 certificate or does nothing if it does not exist.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Certificate. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Returns the certificate.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
CertificateDescription
|
object |
The X509 Certificate. |
type
|
string Read-only |
The resource type. |
|||||||||||||||||||||||||
properties
|
CertificateProperties | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name
|
string Read-only |
The name of the certificate. |
|||||||||||||||||||||||||
id
|
string Read-only |
The resource identifier. |
|||||||||||||||||||||||||
etag
|
string Read-only |
The entity tag. |
Adds new or replaces existing certificate.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
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. |
Name | Data Type | Description |
---|---|---|
CertificateBodyDescription
|
object |
The JSON-serialized X509 Certificate. |
certificate
|
string |
base-64 representation of the X509 leaf certificate .cer file or just .pem file content. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
CertificateDescription
|
object |
The X509 Certificate. |
type
|
string Read-only |
The resource type. |
|||||||||||||||||||||||||
properties
|
CertificateProperties | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name
|
string Read-only |
The name of the certificate. |
|||||||||||||||||||||||||
id
|
string Read-only |
The resource identifier. |
|||||||||||||||||||||||||
etag
|
string Read-only |
The entity tag. |
Name | Data Type | Description |
---|---|---|
CertificateDescription
|
object |
The X509 Certificate. |
type
|
string Read-only |
The resource type. |
|||||||||||||||||||||||||
properties
|
CertificateProperties | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name
|
string Read-only |
The name of the certificate. |
|||||||||||||||||||||||||
id
|
string Read-only |
The resource identifier. |
|||||||||||||||||||||||||
etag
|
string Read-only |
The entity tag. |
Returns the list of certificates.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
CertificateListDescription
|
object |
The JSON-serialized array of Certificate objects. |
value
|
array [CertificateDescription] |
The array of Certificate objects. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Delete an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescription
|
object |
The description of the IoT hub. |
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescription
|
object |
The description of the IoT hub. |
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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 all the IoT hubs in a subscription.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
The subscription identifier. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescriptionListResult
|
object |
The JSON-serialized array of IotHubDescription objects with a next link. |
value
|
array [IotHubDescription] |
The array of IotHubDescription objects. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
The common properties of an Azure resource. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
Get the number of free and paid iot hubs in the subscription
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
The subscription identifier. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
UserSubscriptionQuotaListResult
|
object |
Json-serialized array of User subscription quota response |
value
|
array [UserSubscriptionQuota] | ||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Get the health for routing endpoints.
Name | Data Type | Description |
---|---|---|
iotHubName
|
string | |
resourceGroupName
|
string | |
subscriptionId
|
string |
The subscription identifier. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
EndpointHealthDataListResult
|
object |
The JSON-serialized array of EndpointHealthData objects with a next link. |
value
|
array [EndpointHealthData] |
JSON-serialized array of Endpoint health data |
||||||||||
Properties
|
||||||||||||
nextLink
|
string Read-only |
Link to more results |
Get the statistics from an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
RegistryStatistics
|
object |
Identity registry statistics. |
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 a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
EventHubConsumerGroupInfo
|
object |
The properties of the EventHubConsumerGroupInfo object. |
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 a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
EventHubConsumerGroupsListResult
|
object |
The JSON-serialized array of Event Hub-compatible consumer group names with a next link. |
value
|
array [EventHubConsumerGroupInfo] |
List of consumer groups objects |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
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.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
JobResponse
|
object |
The properties of the Job Response object. |
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 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.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
JobResponseListResult
|
object |
The JSON-serialized array of JobResponse objects with a next link. |
value
|
array [JobResponse] |
The array of JobResponse objects. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
Get the quota metrics for an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubQuotaMetricInfoListResult
|
object |
The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link. |
value
|
array [IotHubQuotaMetricInfo] |
The array of quota metrics objects. |
|||||||||||||
Properties
|
|||||||||||||||
nextLink
|
string Read-only |
The next link. |
Get the list of valid SKUs for an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubSkuDescriptionListResult
|
object |
The JSON-serialized array of IotHubSkuDescription objects with a next link. |
value
|
array [IotHubSkuDescription] |
The array of IotHubSkuDescription. |
||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
Get the non-security related metadata of an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescription
|
object |
The description of the IoT hub. |
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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 all the IoT hubs in a resource group.
Name | Data Type | Description |
---|---|---|
resourceGroupName
|
string |
The name of the resource group that contains the IoT hub. |
subscriptionId
|
string |
The subscription identifier. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescriptionListResult
|
object |
The JSON-serialized array of IotHubDescription objects with a next link. |
value
|
array [IotHubDescription] |
The array of IotHubDescription objects. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
The common properties of an Azure resource. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
Lists all of the available IoT Hub REST API operations.
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
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. |
value
|
array [Operation] |
List of IoT Hub operations supported by the Microsoft.Devices resource provider. |
||||||||||
Properties
|
||||||||||||
nextLink
|
string Read-only |
URL to get the next set of operation list results if there are any. |
Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method
Name | Data Type | Description |
---|---|---|
resourceName
|
string |
Name of iot hub to update. |
resourceGroupName
|
string |
Resource group identifier. |
subscriptionId
|
string |
The subscription identifier. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
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. |
tags
|
Resource tags |
Name | Data Type | Description |
---|---|---|
IotHubDescription
|
object |
The description of the IoT hub. |
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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. |
Check if an IoT hub name is available.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
The subscription identifier. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
OperationInputs
|
object |
Input values. |
name
|
string |
The name of the IoT hub to check. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubNameAvailabilityInfo
|
object |
The properties indicating whether a given IoT hub name is available. |
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. |
Test all routes configured in this Iot Hub
Name | Data Type | Description |
---|---|---|
resourceGroupName
|
string |
resource group which Iot Hub belongs to |
subscriptionId
|
string |
The subscription identifier. |
iotHubName
|
string |
IotHub to be tested |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
TestAllRoutesInput
|
object |
Input for testing all routes |
twin
|
RoutingTwin |
Routing Twin Reference |
|||||||||||||
Properties
|
|||||||||||||||
routingSource
|
string Allowed values: - Invalid - DeviceMessages - TwinChangeEvents - DeviceLifecycleEvents - DeviceJobLifecycleEvents |
Routing source |
|||||||||||||
message
|
RoutingMessage |
Routing message |
|||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
TestAllRoutesResult
|
object |
Result of testing all routes |
routes
|
array [MatchedRoute] |
JSON-serialized array of matched routes |
|||||||||||||||||||||||||||||
Properties
|
Test the new route for this Iot Hub
Name | Data Type | Description |
---|---|---|
resourceGroupName
|
string |
resource group which Iot Hub belongs to |
subscriptionId
|
string |
The subscription identifier. |
iotHubName
|
string |
IotHub to be tested |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
TestRouteInput
|
object |
Input for testing route |
twin
|
RoutingTwin |
Routing Twin Reference |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
route
|
RouteProperties |
Route properties |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
message
|
RoutingMessage |
Routing message |
|||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
TestRouteResult
|
object |
Result of testing one route |
result
|
string Allowed values: - undefined - false - true |
Result of testing route |
|||||||||||||||||||||||
details
|
TestRouteResultDetails |
Detailed result of testing route |
|||||||||||||||||||||||
Properties
|
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.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
SharedAccessSignatureAuthorizationRule
|
object |
The properties of an IoT hub shared access policy. |
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. |
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.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ExportDevicesRequest
|
object |
Use to provide parameters when requesting an export of all devices in the IoT hub. |
exportBlobContainerUri
|
string |
The export blob container URI. |
excludeKeys
|
boolean |
The value indicating whether keys should be excluded during export. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
JobResponse
|
object |
The properties of the Job Response object. |
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. |
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.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ImportDevicesRequest
|
object |
Use to provide parameters when requesting an import of all devices in the hub. |
outputBlobContainerUri
|
string |
The output blob container URI. |
inputBlobContainerUri
|
string |
The input blob container URI. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
JobResponse
|
object |
The properties of the Job Response object. |
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 the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
SharedAccessSignatureAuthorizationRuleListResult
|
object |
The list of shared access policies with a next link. |
value
|
array [SharedAccessSignatureAuthorizationRule] |
The list of shared access policies. |
||||||||||||||||
Properties
|
||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
EventHubConsumerGroupInfo
|
object |
The properties of the EventHubConsumerGroupInfo object. |
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. |
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.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
The version of the API. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescription
|
object |
The description of the IoT hub. |
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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. |
Name | Data Type | Description |
---|---|---|
ErrorDetails
|
object |
Error details. |
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescription
|
object |
The description of the IoT hub. |
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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. |
Name | Data Type | Description |
---|---|---|
IotHubDescription
|
object |
The description of the IoT hub. |
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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. |
The JSON-serialized X509 Certificate.
Name | Data Type | Description |
---|---|---|
certificate
|
string |
base-64 representation of the X509 leaf certificate .cer file or just .pem file content. |
The X509 Certificate.
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
string Read-only |
The resource type. |
|||||||||||||||||||||||||
properties
|
CertificateProperties | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name
|
string Read-only |
The name of the certificate. |
|||||||||||||||||||||||||
id
|
string Read-only |
The resource identifier. |
|||||||||||||||||||||||||
etag
|
string Read-only |
The entity tag. |
The JSON-serialized array of Certificate objects.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [CertificateDescription] |
The array of Certificate objects. |
|||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The description of an X509 CA Certificate.
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 |
The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.
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 |
The JSON-serialized leaf certificate
Name | Data Type | Description |
---|---|---|
certificate
|
string |
base-64 representation of X509 certificate .cer file or just .pem file content. |
The X509 Certificate.
Name | Data Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
string Read-only |
The resource type. |
||||||||||||||||||||||||||||
properties
|
CertificatePropertiesWithNonce | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
name
|
string Read-only |
The name of the certificate. |
||||||||||||||||||||||||||||
id
|
string Read-only |
The resource identifier. |
||||||||||||||||||||||||||||
etag
|
string Read-only |
The entity tag. |
The IoT hub cloud-to-device messaging properties.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||||||||||
Properties
|
|||||||||||||||
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. |
The health data for an endpoint
Name | Data Type | Description |
---|---|---|
healthStatus
|
string Allowed values: - unknown - healthy - unhealthy - dead |
Health status |
endpointId
|
string |
Id of the endpoint |
The JSON-serialized array of EndpointHealthData objects with a next link.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [EndpointHealthData] |
JSON-serialized array of Endpoint health data |
||||||||||
Properties
|
||||||||||||
nextLink
|
string Read-only |
Link to more results |
Error details.
Name | Data Type | Description |
---|---|---|
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. |
The properties of the EventHubConsumerGroupInfo object.
Name | Data Type | Description |
---|---|---|
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. |
The JSON-serialized array of Event Hub-compatible consumer group names with a next link.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [EventHubConsumerGroupInfo] |
List of consumer groups objects |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
Name | Data Type | Description |
---|---|---|
retentionTimeInDays
|
long |
The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages |
path
|
string Read-only |
The Event Hub-compatible name. |
partitionIds
|
array [string] |
The partition ids in the Event Hub-compatible endpoint. |
partitionCount
|
integer |
The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. |
endpoint
|
string Read-only |
The Event Hub-compatible endpoint. |
Use to provide parameters when requesting an export of all devices in the IoT hub.
Name | Data Type | Description |
---|---|---|
exportBlobContainerUri
|
string |
The export blob container URI. |
excludeKeys
|
boolean |
The value indicating whether keys should be excluded during export. |
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
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 |
The properties of the feedback queue for cloud-to-device messages.
Name | Data Type | Description |
---|---|---|
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. |
Use to provide parameters when requesting an import of all devices in the hub.
Name | Data Type | Description |
---|---|---|
outputBlobContainerUri
|
string |
The output blob container URI. |
inputBlobContainerUri
|
string |
The input blob container URI. |
IoT Hub capacity information.
Name | Data Type | Description |
---|---|---|
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. |
The description of the IoT hub.
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
IotHubProperties |
IotHub properties |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. |
The common properties of an Azure resource.
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. |
The JSON-serialized array of IotHubDescription objects with a next link.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [IotHubDescription] |
The array of IotHubDescription objects. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
The common properties of an Azure resource. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
The properties indicating whether a given IoT hub name is available.
Name | Data Type | Description |
---|---|---|
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. |
The properties of an IoT hub.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisioningState
|
string Read-only |
The provisioning state. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
operationsMonitoringProperties
|
OperationsMonitoringProperties | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
messagingEndpoints
|
object |
The messaging endpoint properties for the file upload notification queue. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipFilterRules
|
array [IpFilterRule] |
The IP filter rules. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorizationPolicies
|
array [SharedAccessSignatureAuthorizationRule] |
The shared access policies you can use to secure a connection to the IoT hub. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Quota metrics properties.
Name | Data Type | Description |
---|---|---|
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. |
The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [IotHubQuotaMetricInfo] |
The array of quota metrics objects. |
|||||||||||||
Properties
|
|||||||||||||||
nextLink
|
string Read-only |
The next link. |
SKU properties.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sku
|
IotHubSkuInfo |
The type of the resource. |
||||||||||||||||
Properties
|
||||||||||||||||||
resourceType
|
string Read-only |
The type of the resource. |
||||||||||||||||
capacity
|
IotHubCapacity |
IotHub capacity |
||||||||||||||||
Properties
|
The JSON-serialized array of IotHubSkuDescription objects with a next link.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [IotHubSkuDescription] |
The array of IotHubSkuDescription. |
||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The next link. |
Information about the SKU of the IoT hub.
Name | Data Type | Description |
---|---|---|
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. |