Microsoft.Devices (stable:2016-02-03)

2025/09/26 • 19 new, 19 deleted methods

IotHubResource_Get (new)
Description :  Get the non-security related metadata of an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_CreateOrUpdate (new)
Description :  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. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub to create or update. ,
Required: True ,
}
string ,
iotHubDescription:
{
Description: The IoT hub metadata and security metadata. ,
Required: True ,
}
{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (200)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_Delete (new)
Description :  Delete an IoT hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub to delete. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (200)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (404)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListBySubscription (new)
Description :  Get all the IoT hubs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubDescription objects. ,
Required: False ,
}
[
{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListByResourceGroup (new)
Description :  Get all the IoT hubs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hubs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubDescription objects. ,
Required: False ,
}
[
{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetStats (new)
Description :  Get the statistics from an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
totalDeviceCount:
{
Description: The total count of devices in the identity registry. ,
Format: int64 ,
Required: False ,
}
integer ,
enabledDeviceCount:
{
Description: The count of enabled devices in the identity registry. ,
Format: int64 ,
Required: False ,
}
integer ,
disabledDeviceCount:
{
Description: The count of disabled devices in the identity registry. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetValidSkus (new)
Description :  Get the list of valid SKUs for an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubSkuDescription. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
capacity:
{
Description: IoT Hub capacity information. ,
Required: True ,
}
{
minimum:
{
Description: The minimum number of units. ,
Format: int64 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum number of units. ,
Format: int64 ,
Required: False ,
}
integer ,
default:
{
Description: The default number of units. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The type of the scaling enabled. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListEventHubConsumerGroups (new)
Description :  Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of Event Hub-compatible consumer group names. ,
Required: False ,
}
[
string ,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetEventHubConsumerGroup (new)
Description :  Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint in the IoT hub. ,
Required: True ,
}
string ,
name:
{
Description: The name of the consumer group to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tags:
{
Description: The tags. ,
Required: False ,
}
object ,
id:
{
Description: The Event Hub-compatible consumer group identifier. ,
Required: False ,
}
string ,
name:
{
Description: The Event Hub-compatible consumer group name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_CreateEventHubConsumerGroup (new)
Description :  Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint in the IoT hub. ,
Required: True ,
}
string ,
name:
{
Description: The name of the consumer group to add. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tags:
{
Description: The tags. ,
Required: False ,
}
object ,
id:
{
Description: The Event Hub-compatible consumer group identifier. ,
Required: False ,
}
string ,
name:
{
Description: The Event Hub-compatible consumer group name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_DeleteEventHubConsumerGroup (new)
Description :  Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint in the IoT hub. ,
Required: True ,
}
string ,
name:
{
Description: The name of the consumer group to delete. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListJobs (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of JobResponse objects. ,
Required: False ,
}
[
{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetJob (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
jobId:
{
Description: The job identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetQuotaMetrics (new)
Description :  Get the quota metrics for an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of quota metrics objects. ,
Required: False ,
}
[
{
Name:
{
Description: The name of the quota metric. ,
Required: False ,
}
string ,
CurrentValue:
{
Description: The current value for the quota metric. ,
Format: int64 ,
Required: False ,
}
integer ,
MaxValue:
{
Description: The maximum value of the quota metric. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_CheckNameAvailability (new)
Description :  Check if an IoT hub name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
operationInputs:
{
Description: Set the name parameter in the OperationInputs structure to the name of the IoT hub to check. ,
Required: True ,
}
{
Name:
{
Description: The name of the IoT hub to check. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value which indicates whether the provided name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed reason message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListKeys (new)
Description :  Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of shared access policies. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetKeysForKeyName (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ExportDevices (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
exportDevicesParameters:
{
Description: The parameters that specify the export devices operation. ,
Required: True ,
}
{
ExportBlobContainerUri:
{
Description: The export blob container URI. ,
Required: True ,
}
string ,
ExcludeKeys:
{
Description: The value indicating whether keys should be excluded during export. ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ImportDevices (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
importDevicesParameters:
{
Description: The parameters that specify the import devices operation. ,
Required: True ,
}
{
InputBlobContainerUri:
{
Description: The input blob container URI. ,
Required: True ,
}
string ,
OutputBlobContainerUri:
{
Description: The output blob container URI. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_Get (removed)
Description :  Get the non-security related metadata of an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_CreateOrUpdate (removed)
Description :  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. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub to create or update. ,
Required: True ,
}
string ,
iotHubDescription:
{
Description: The IoT hub metadata and security metadata. ,
Required: True ,
}
{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (200)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_Delete (removed)
Description :  Delete an IoT hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub to delete. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (200)

{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (404)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListBySubscription (removed)
Description :  Get all the IoT hubs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubDescription objects. ,
Required: False ,
}
[
{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListByResourceGroup (removed)
Description :  Get all the IoT hubs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hubs. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubDescription objects. ,
Required: False ,
}
[
{
subscriptionid:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourcegroup:
{
Description: The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription. ,
Required: True ,
}
string ,
etag:
{
Description: 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. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an IoT hub. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The shared access policies you can use to secure a connection to the IoT hub. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
ipFilterRules:
{
Description: The IP filter rules. ,
Required: False ,
}
[
{
filterName:
{
Description: The name of the IP filter rule. ,
Required: True ,
}
string ,
action:
{
Description: The desired action for requests captured by this rule. ,
Enum:
{
Accept: No description available. ,
Reject: No description available. ,
}
,
Required: True ,
}
enum ,
ipMask:
{
Description: A string that contains the IP address range in CIDR notation for the rule. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
storageEndpoints:
{
Description: 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. ,
Required: False ,
}
object ,
messagingEndpoints:
{
Description: The messaging endpoint properties for the file upload notification queue. ,
Required: False ,
}
object ,
enableFileUploadNotifications:
{
Description: If True, file upload notifications are enabled. ,
Required: False ,
}
boolean ,
cloudToDevice:
{
Description: The IoT hub cloud-to-device messaging properties. ,
Required: False ,
}
{
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultTtlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
feedback:
{
Description: The properties of the feedback queue for cloud-to-device messages. ,
Required: False ,
}
{
lockDurationAsIso8601:
{
Description: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. ,
Format: duration ,
Required: False ,
}
string ,
ttlAsIso8601:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxDeliveryCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
comments:
{
Description: Comments. ,
Required: False ,
}
string ,
operationsMonitoringProperties:
{
Description: The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations. ,
Required: False ,
}
{
events:
{
Required: False ,
}
object ,
}
,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetStats (removed)
Description :  Get the statistics from an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
totalDeviceCount:
{
Description: The total count of devices in the identity registry. ,
Format: int64 ,
Required: False ,
}
integer ,
enabledDeviceCount:
{
Description: The count of enabled devices in the identity registry. ,
Format: int64 ,
Required: False ,
}
integer ,
disabledDeviceCount:
{
Description: The count of disabled devices in the identity registry. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetValidSkus (removed)
Description :  Get the list of valid SKUs for an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubSkuDescription. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
sku:
{
Description: Information about the SKU of the IoT hub. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
S2: No description available. ,
S3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
capacity:
{
Description: IoT Hub capacity information. ,
Required: True ,
}
{
minimum:
{
Description: The minimum number of units. ,
Format: int64 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum number of units. ,
Format: int64 ,
Required: False ,
}
integer ,
default:
{
Description: The default number of units. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The type of the scaling enabled. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListEventHubConsumerGroups (removed)
Description :  Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of Event Hub-compatible consumer group names. ,
Required: False ,
}
[
string ,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetEventHubConsumerGroup (removed)
Description :  Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint in the IoT hub. ,
Required: True ,
}
string ,
name:
{
Description: The name of the consumer group to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tags:
{
Description: The tags. ,
Required: False ,
}
object ,
id:
{
Description: The Event Hub-compatible consumer group identifier. ,
Required: False ,
}
string ,
name:
{
Description: The Event Hub-compatible consumer group name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_CreateEventHubConsumerGroup (removed)
Description :  Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint in the IoT hub. ,
Required: True ,
}
string ,
name:
{
Description: The name of the consumer group to add. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tags:
{
Description: The tags. ,
Required: False ,
}
object ,
id:
{
Description: The Event Hub-compatible consumer group identifier. ,
Required: False ,
}
string ,
name:
{
Description: The Event Hub-compatible consumer group name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_DeleteEventHubConsumerGroup (removed)
Description :  Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
eventHubEndpointName:
{
Description: The name of the Event Hub-compatible endpoint in the IoT hub. ,
Required: True ,
}
string ,
name:
{
Description: The name of the consumer group to delete. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListJobs (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of JobResponse objects. ,
Required: False ,
}
[
{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetJob (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
jobId:
{
Description: The job identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetQuotaMetrics (removed)
Description :  Get the quota metrics for an IoT hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of quota metrics objects. ,
Required: False ,
}
[
{
Name:
{
Description: The name of the quota metric. ,
Required: False ,
}
string ,
CurrentValue:
{
Description: The current value for the quota metric. ,
Format: int64 ,
Required: False ,
}
integer ,
MaxValue:
{
Description: The maximum value of the quota metric. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_CheckNameAvailability (removed)
Description :  Check if an IoT hub name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
operationInputs:
{
Description: Set the name parameter in the OperationInputs structure to the name of the IoT hub to check. ,
Required: True ,
}
{
Name:
{
Description: The name of the IoT hub to check. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value which indicates whether the provided name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed reason message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ListKeys (removed)
Description :  Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of shared access policies. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_GetKeysForKeyName (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keyName:
{
Description: The name of the shared access policy. ,
Required: True ,
}
string ,
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
Required: False ,
}
string ,
rights:
{
Description: The permissions assigned to the shared access policy. ,
Enum:
{
RegistryRead: No description available. ,
RegistryWrite: No description available. ,
ServiceConnect: No description available. ,
DeviceConnect: No description available. ,
RegistryRead, RegistryWrite: No description available. ,
RegistryRead, ServiceConnect: No description available. ,
RegistryRead, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect: No description available. ,
RegistryWrite, DeviceConnect: No description available. ,
ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect: No description available. ,
RegistryRead, RegistryWrite, DeviceConnect: No description available. ,
RegistryRead, ServiceConnect, DeviceConnect: No description available. ,
RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ExportDevices (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
exportDevicesParameters:
{
Description: The parameters that specify the export devices operation. ,
Required: True ,
}
{
ExportBlobContainerUri:
{
Description: The export blob container URI. ,
Required: True ,
}
string ,
ExcludeKeys:
{
Description: The value indicating whether keys should be excluded during export. ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
IotHubResource_ImportDevices (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the IoT hub. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the IoT hub. ,
Required: True ,
}
string ,
importDevicesParameters:
{
Description: The parameters that specify the import devices operation. ,
Required: True ,
}
{
InputBlobContainerUri:
{
Description: The input blob container URI. ,
Required: True ,
}
string ,
OutputBlobContainerUri:
{
Description: The output blob container URI. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
jobId:
{
Description: The job identifier. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The start time of the job. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The time the job stopped processing. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
type:
{
Description: The type of the job. ,
Enum:
{
unknown: No description available. ,
export: No description available. ,
import: No description available. ,
backup: No description available. ,
readDeviceProperties: No description available. ,
writeDeviceProperties: No description available. ,
updateDeviceConfiguration: No description available. ,
rebootDevice: No description available. ,
factoryResetDevice: No description available. ,
firmwareUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the job. ,
Enum:
{
unknown: No description available. ,
enqueued: No description available. ,
running: No description available. ,
completed: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: If status == failed, this string containing the reason for the failure. ,
Required: False ,
}
string ,
statusMessage:
{
Description: The status message for the job. ,
Required: False ,
}
string ,
parentJobId:
{
Description: The job identifier of the parent job, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
Code:
{
Description: The error code. ,
Required: False ,
}
string ,
HttpStatusCode:
{
Description: The HTTP status code. ,
Required: False ,
}
string ,
Message:
{
Description: The error message. ,
Required: False ,
}
string ,
Details:
{
Description: The error details. ,
Required: False ,
}
string ,
}