Microsoft.Devices (stable:2020-04-01)

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

Operations_List (new)
Description :  Lists all of the available IoT Hub REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Devices/operations
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of IoT Hub operations supported by the Microsoft.Devices resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft Devices ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: IotHubs ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are 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 (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)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_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. ,
Required: True ,
}
string ,
iotHubDescription:
{
Description: The IoT hub metadata and security metadata. ,
Required: True ,
}
{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}
,
If-Match:
{
Description: ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_Update (new)
Description :  Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of iot hub to update. ,
Required: True ,
}
string ,
IotHubTags:
{
Description: Updated tag information to set into the iot hub instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}
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. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
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 ,
}
[
{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_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 hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubDescription objects. ,
Required: False ,
}
[
{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_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: The type of the resource. ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
capacity:
{
Description: IotHub capacity ,
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: List of consumer groups objects ,
Required: False ,
}
[
{
properties:
{
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 ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
etag:
{
Description: The etag. ,
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)

{
properties:
{
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 ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
etag:
{
Description: The etag. ,
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)

{
properties:
{
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 ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
etag:
{
Description: The etag. ,
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_GetEndpointHealth (new)
Description :  Get the health for routing endpoints.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: JSON-serialized array of Endpoint health data ,
Required: False ,
}
[
{
endpointId:
{
Description: Id of the endpoint ,
Required: False ,
}
string ,
healthStatus:
{
Description: Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint ,
Enum:
{
unknown: No description available. ,
healthy: No description available. ,
degraded: No description available. ,
unhealthy: No description available. ,
dead: No description available. ,
}
,
Required: False ,
}
enum ,
lastKnownError:
{
Description: Last error obtained when a message failed to be delivered to iot hub ,
Required: False ,
}
string ,
lastKnownErrorTime:
{
Description: Time at which the last known error occurred ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
lastSuccessfulSendAttemptTime:
{
Description: Last time iot hub successfully sent a message to the endpoint ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
lastSendAttemptTime:
{
Description: Last time iot hub tried to send a message to the endpoint ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to more results ,
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 ,
}
ResourceProviderCommon_GetSubscriptionQuota (new)
Description :  Get the number of free and paid iot hubs in the subscription
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: IotHub type id ,
Required: False ,
}
string ,
type:
{
Description: Response type ,
Required: False ,
}
string ,
unit:
{
Description: Unit of IotHub type ,
Required: False ,
}
string ,
currentValue:
{
Description: Current number of IotHub type ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: Numerical limit on IotHub type ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IotHub type ,
Required: False ,
}
{
value:
{
Description: IotHub type ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized value of name ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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_TestAllRoutes (new)
Description :  Test all routes configured in this Iot Hub
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall
{
input:
{
Description: Input for testing all routes ,
Required: True ,
}
{
routingSource:
{
Description: Routing source ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Routing message ,
Required: False ,
}
{
body:
{
Description: Body of routing message ,
Required: False ,
}
string ,
appProperties:
{
Description: App properties ,
Required: False ,
}
object ,
systemProperties:
{
Description: System properties ,
Required: False ,
}
object ,
}
,
twin:
{
Description: Routing Twin Reference ,
Required: False ,
}
{
tags:
{
Description: Twin Tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
desired:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
reported:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
}
,
}
,
}
,
iotHubName:
{
Description: IotHub to be tested ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: resource group which Iot Hub belongs to ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
routes:
{
Description: JSON-serialized array of matched routes ,
Required: False ,
}
[
{
properties:
{
Description: Properties of routes that matched ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
}
,
]
,
}

⚐ 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_TestRoute (new)
Description :  Test the new route for this Iot Hub
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew
{
input:
{
Description: Route that needs to be tested ,
Required: True ,
}
{
message:
{
Description: Routing message ,
Required: False ,
}
{
body:
{
Description: Body of routing message ,
Required: False ,
}
string ,
appProperties:
{
Description: App properties ,
Required: False ,
}
object ,
systemProperties:
{
Description: System properties ,
Required: False ,
}
object ,
}
,
route:
{
Description: Route properties ,
Required: True ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
twin:
{
Description: Routing Twin Reference ,
Required: False ,
}
{
tags:
{
Description: Twin Tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
desired:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
reported:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
}
,
}
,
}
,
iotHubName:
{
Description: IotHub to be tested ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: resource group which Iot Hub belongs to ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
result:
{
Description: Result of testing route ,
Enum:
{
undefined: No description available. ,
false: No description available. ,
true: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Detailed result of testing route ,
Required: False ,
}
{
compilationErrors:
{
Description: JSON-serialized list of route compilation errors ,
Required: False ,
}
[
{
message:
{
Description: Route error message ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the route error ,
Enum:
{
error: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Location where the route error happened ,
Required: False ,
}
{
start:
{
Description: Start where the route error happened ,
Required: False ,
}
{
line:
{
Description: Line where the route error happened ,
Format: int32 ,
Required: False ,
}
integer ,
column:
{
Description: Column where the route error happened ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
end:
{
Description: End where the route error happened ,
Required: False ,
}
{
line:
{
Description: Line where the route error happened ,
Format: int32 ,
Required: False ,
}
integer ,
column:
{
Description: Column where the route error happened ,
Format: int32 ,
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_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 ,
exportBlobName:
{
Description: The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub. ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies authentication type being used for connecting to the storage account. ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
inputBlobName:
{
Description: The blob name to be used when importing from the provided input blob container. ,
Required: False ,
}
string ,
outputBlobName:
{
Description: The blob name to use for storing the status of the import job. ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies authentication type being used for connecting to the storage account. ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
Certificates_ListByIotHub (new)
Description :  Returns the list of certificates.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates
{
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 Certificate objects. ,
Required: False ,
}
[
{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_Get (new)
Description :  Returns the certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_CreateOrUpdate (new)
Description :  Adds new or replaces existing certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
certificateDescription:
{
Description: The certificate body. ,
Required: True ,
}
{
certificate:
{
Description: base-64 representation of the X509 leaf certificate .cer file or just .pem file content. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_Delete (new)
Description :  Deletes an existing X509 certificate or does nothing if it does not exist.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
Certificates_GenerateVerificationCode (new)
Description :  Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
verificationCode:
{
Description: The certificate's verification code that will be used for proof of possession. ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_Verify (new)
Description :  Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
certificateVerificationBody:
{
Description: The name of the certificate ,
Required: True ,
}
{
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the Certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
IotHub_ManualFailover (new)
Description :  Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover
{
iotHubName:
{
Description: Name of the IoT hub to failover ,
Required: True ,
}
string ,
failoverInput:
{
Description: Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region ,
Required: True ,
}
{
failoverRegion:
{
Description: Region the hub will be failed over to ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group containing the IoT hub resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
PrivateLinkResources_List (new)
Description :  List private link resources for the given IotHub
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources
{
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 available private link resources for an IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties for a group information object ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
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 ,
}
PrivateLinkResources_Get (new)
Description :  Get the specified private link resource for the given IotHub
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}
{
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 ,
groupId:
{
Description: The name of the private link resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties for a group information object ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
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 ,
}
PrivateEndpointConnections_List (new)
Description :  List private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections
{
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)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
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 ,
}
PrivateEndpointConnections_Get (new)
Description :  Get private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
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 ,
}
PrivateEndpointConnections_Update (new)
Description :  Update the status of a private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The private endpoint connection with updated properties ,
Required: True ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
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 ,
}
PrivateEndpointConnections_Delete (new)
Description :  Delete private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ 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 ,
}
Operations_List (removed)
Description :  Lists all of the available IoT Hub REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Devices/operations
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of IoT Hub operations supported by the Microsoft.Devices resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft Devices ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: IotHubs ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are 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)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_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. ,
Required: True ,
}
string ,
iotHubDescription:
{
Description: The IoT hub metadata and security metadata. ,
Required: True ,
}
{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}
,
If-Match:
{
Description: ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_Update (removed)
Description :  Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group identifier. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of iot hub to update. ,
Required: True ,
}
string ,
IotHubTags:
{
Description: Updated tag information to set into the iot hub instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}
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. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
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 ,
}
[
{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_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 hub. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of IotHubDescription objects. ,
Required: False ,
}
[
{
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: IotHub properties ,
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
minTlsVersion:
{
Description: Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections created on this IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
state:
{
Description: The hub state. ,
Required: False ,
}
string ,
hostName:
{
Description: The name of the host. ,
Required: False ,
}
string ,
eventHubEndpoints:
{
Description: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. ,
Required: False ,
}
object ,
routing:
{
Description: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging ,
Required: False ,
}
{
endpoints:
{
Description: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. ,
Required: False ,
}
{
serviceBusQueues:
{
Description: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus queue endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus queue endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus queue endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus queue endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus queue endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus queue endpoint. ,
Required: False ,
}
string ,
}
,
]
,
serviceBusTopics:
{
Description: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the service bus topic endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the service bus topic endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the service bus topic endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Queue name on the service bus topic ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the service bus topic endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the service bus topic endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the service bus topic endpoint. ,
Required: False ,
}
string ,
}
,
]
,
eventHubs:
{
Description: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Id of the event hub endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the event hub endpoint. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the event hub endpoint. It must include the protocol sb:// ,
Required: False ,
}
string ,
entityPath:
{
Description: Event hub name on the event hub namespace ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the event hub endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the event hub endpoint. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the event hub endpoint. ,
Required: False ,
}
string ,
}
,
]
,
storageContainers:
{
Description: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. ,
Required: False ,
}
[
{
id:
{
Description: Id of the storage container endpoint ,
Required: False ,
}
string ,
connectionString:
{
Description: The connection string of the storage account. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The url of the storage endpoint. It must include the protocol https:// ,
Required: False ,
}
string ,
authenticationType:
{
Description: Method used to authenticate against the storage endpoint ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier of the storage account. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The name of the resource group of the storage account. ,
Required: False ,
}
string ,
containerName:
{
Description: The name of storage container in the storage account. ,
Required: True ,
}
string ,
fileNameFormat:
{
Description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. ,
Required: False ,
}
string ,
batchFrequencyInSeconds:
{
Description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxChunkSizeInBytes:
{
Description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). ,
Format: int32 ,
Required: False ,
}
integer ,
encoding:
{
Description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
JSON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
routes:
{
Description: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
]
,
fallbackRoute:
{
Description: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint. ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: False ,
}
string ,
source:
{
Description: The source to which the routing rule is to be applied to. For example, DeviceMessages ,
Enum:
{
DeviceMessages: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether the fallback route is enabled. ,
Required: True ,
}
boolean ,
}
,
enrichments:
{
Description: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid ,
Required: False ,
}
[
{
key:
{
Description: The key or name for the enrichment property. ,
Required: True ,
}
string ,
value:
{
Description: The value for the enrichment property. ,
Required: True ,
}
string ,
endpointNames:
{
Description: The list of endpoints for which the enrichment is applied to the message. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
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: IoT hub comments. ,
Required: False ,
}
string ,
features:
{
Description: The capabilities and features enabled for the IoT hub. ,
Enum:
{
None: No description available. ,
DeviceManagement: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: Primary and secondary location for iot hub ,
Required: False ,
}
[
{
location:
{
Description: The name of the Azure region ,
Required: False ,
}
string ,
role:
{
Description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
sku:
{
Description: IotHub SKU info ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: 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_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: The type of the resource. ,
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. ,
B1: No description available. ,
B2: No description available. ,
B3: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier for the IoT hub. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Basic: 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: False ,
}
integer ,
}
,
capacity:
{
Description: IotHub capacity ,
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: List of consumer groups objects ,
Required: False ,
}
[
{
properties:
{
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 ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
etag:
{
Description: The etag. ,
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)

{
properties:
{
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 ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
etag:
{
Description: The etag. ,
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)

{
properties:
{
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 ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
etag:
{
Description: The etag. ,
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_GetEndpointHealth (removed)
Description :  Get the health for routing endpoints.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: JSON-serialized array of Endpoint health data ,
Required: False ,
}
[
{
endpointId:
{
Description: Id of the endpoint ,
Required: False ,
}
string ,
healthStatus:
{
Description: Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint ,
Enum:
{
unknown: No description available. ,
healthy: No description available. ,
degraded: No description available. ,
unhealthy: No description available. ,
dead: No description available. ,
}
,
Required: False ,
}
enum ,
lastKnownError:
{
Description: Last error obtained when a message failed to be delivered to iot hub ,
Required: False ,
}
string ,
lastKnownErrorTime:
{
Description: Time at which the last known error occurred ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
lastSuccessfulSendAttemptTime:
{
Description: Last time iot hub successfully sent a message to the endpoint ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
lastSendAttemptTime:
{
Description: Last time iot hub tried to send a message to the endpoint ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to more results ,
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 ,
}
ResourceProviderCommon_GetSubscriptionQuota (removed)
Description :  Get the number of free and paid iot hubs in the subscription
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: IotHub type id ,
Required: False ,
}
string ,
type:
{
Description: Response type ,
Required: False ,
}
string ,
unit:
{
Description: Unit of IotHub type ,
Required: False ,
}
string ,
currentValue:
{
Description: Current number of IotHub type ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: Numerical limit on IotHub type ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IotHub type ,
Required: False ,
}
{
value:
{
Description: IotHub type ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized value of name ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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_TestAllRoutes (removed)
Description :  Test all routes configured in this Iot Hub
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall
{
input:
{
Description: Input for testing all routes ,
Required: True ,
}
{
routingSource:
{
Description: Routing source ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Routing message ,
Required: False ,
}
{
body:
{
Description: Body of routing message ,
Required: False ,
}
string ,
appProperties:
{
Description: App properties ,
Required: False ,
}
object ,
systemProperties:
{
Description: System properties ,
Required: False ,
}
object ,
}
,
twin:
{
Description: Routing Twin Reference ,
Required: False ,
}
{
tags:
{
Description: Twin Tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
desired:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
reported:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
}
,
}
,
}
,
iotHubName:
{
Description: IotHub to be tested ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: resource group which Iot Hub belongs to ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
routes:
{
Description: JSON-serialized array of matched routes ,
Required: False ,
}
[
{
properties:
{
Description: Properties of routes that matched ,
Required: False ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
}
,
]
,
}

⚐ 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_TestRoute (removed)
Description :  Test the new route for this Iot Hub
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew
{
input:
{
Description: Route that needs to be tested ,
Required: True ,
}
{
message:
{
Description: Routing message ,
Required: False ,
}
{
body:
{
Description: Body of routing message ,
Required: False ,
}
string ,
appProperties:
{
Description: App properties ,
Required: False ,
}
object ,
systemProperties:
{
Description: System properties ,
Required: False ,
}
object ,
}
,
route:
{
Description: Route properties ,
Required: True ,
}
{
name:
{
Description: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. ,
Required: True ,
}
string ,
source:
{
Description: The source that the routing rule is to be applied to, such as DeviceMessages. ,
Enum:
{
Invalid: No description available. ,
DeviceMessages: No description available. ,
TwinChangeEvents: No description available. ,
DeviceLifecycleEvents: No description available. ,
DeviceJobLifecycleEvents: No description available. ,
}
,
Required: True ,
}
enum ,
condition:
{
Description: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language ,
Required: False ,
}
string ,
endpointNames:
{
Description: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. ,
Required: True ,
}
[
string ,
]
,
isEnabled:
{
Description: Used to specify whether a route is enabled. ,
Required: True ,
}
boolean ,
}
,
twin:
{
Description: Routing Twin Reference ,
Required: False ,
}
{
tags:
{
Description: Twin Tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
desired:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
reported:
{
Description: Twin desired properties ,
Required: False ,
}
object ,
}
,
}
,
}
,
iotHubName:
{
Description: IotHub to be tested ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: resource group which Iot Hub belongs to ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
result:
{
Description: Result of testing route ,
Enum:
{
undefined: No description available. ,
false: No description available. ,
true: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Detailed result of testing route ,
Required: False ,
}
{
compilationErrors:
{
Description: JSON-serialized list of route compilation errors ,
Required: False ,
}
[
{
message:
{
Description: Route error message ,
Required: False ,
}
string ,
severity:
{
Description: Severity of the route error ,
Enum:
{
error: No description available. ,
warning: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Location where the route error happened ,
Required: False ,
}
{
start:
{
Description: Start where the route error happened ,
Required: False ,
}
{
line:
{
Description: Line where the route error happened ,
Format: int32 ,
Required: False ,
}
integer ,
column:
{
Description: Column where the route error happened ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
end:
{
Description: End where the route error happened ,
Required: False ,
}
{
line:
{
Description: Line where the route error happened ,
Format: int32 ,
Required: False ,
}
integer ,
column:
{
Description: Column where the route error happened ,
Format: int32 ,
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_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 ,
exportBlobName:
{
Description: The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub. ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies authentication type being used for connecting to the storage account. ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
inputBlobName:
{
Description: The blob name to be used when importing from the provided input blob container. ,
Required: False ,
}
string ,
outputBlobName:
{
Description: The blob name to use for storing the status of the import job. ,
Required: False ,
}
string ,
authenticationType:
{
Description: Specifies authentication type being used for connecting to the storage account. ,
Enum:
{
keyBased: No description available. ,
identityBased: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
Certificates_ListByIotHub (removed)
Description :  Returns the list of certificates.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates
{
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 Certificate objects. ,
Required: False ,
}
[
{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_Get (removed)
Description :  Returns the certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_CreateOrUpdate (removed)
Description :  Adds new or replaces existing certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
certificateDescription:
{
Description: The certificate body. ,
Required: True ,
}
{
certificate:
{
Description: base-64 representation of the X509 leaf certificate .cer file or just .pem file content. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_Delete (removed)
Description :  Deletes an existing X509 certificate or does nothing if it does not exist.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
Certificates_GenerateVerificationCode (removed)
Description :  Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
verificationCode:
{
Description: The certificate's verification code that will be used for proof of possession. ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
Certificates_Verify (removed)
Description :  Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify
{
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 ,
certificateName:
{
Description: The name of the certificate ,
Required: True ,
}
string ,
certificateVerificationBody:
{
Description: The name of the certificate ,
Required: True ,
}
{
certificate:
{
Description: base-64 representation of X509 certificate .cer file or just .pem file content. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the Certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The description of an X509 CA Certificate. ,
Required: False ,
}
{
subject:
{
Description: The certificate's subject name. ,
Required: False ,
}
string ,
expiry:
{
Description: The certificate's expiration date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate's thumbprint. ,
Required: False ,
}
string ,
isVerified:
{
Description: Determines whether certificate has been verified. ,
Required: False ,
}
boolean ,
created:
{
Description: The certificate's create date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
updated:
{
Description: The certificate's last update date and time. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
certificate:
{
Description: The certificate content ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the certificate. ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
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 ,
}
IotHub_ManualFailover (removed)
Description :  Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover
{
iotHubName:
{
Description: Name of the IoT hub to failover ,
Required: True ,
}
string ,
failoverInput:
{
Description: Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region ,
Required: True ,
}
{
failoverRegion:
{
Description: Region the hub will be failed over to ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group containing the IoT hub resource ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
PrivateLinkResources_List (removed)
Description :  List private link resources for the given IotHub
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources
{
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 available private link resources for an IotHub ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties for a group information object ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
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 ,
}
PrivateLinkResources_Get (removed)
Description :  Get the specified private link resource for the given IotHub
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}
{
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 ,
groupId:
{
Description: The name of the private link resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties for a group information object ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
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 ,
}
PrivateEndpointConnections_List (removed)
Description :  List private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections
{
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)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
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 ,
}
PrivateEndpointConnections_Get (removed)
Description :  Get private endpoint connection properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
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 ,
}
PrivateEndpointConnections_Update (removed)
Description :  Update the status of a private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The private endpoint connection with updated properties ,
Required: True ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
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 ,
}
PrivateEndpointConnections_Delete (removed)
Description :  Delete private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection ,
Required: True ,
}
{
privateEndpoint:
{
Description: The private endpoint property of a private endpoint connection ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The current state of a private endpoint connection ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: True ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ 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 ,
}