{ "swagger": "2.0", "info": { "title": "iotHubClient", "version": "2026-11-01", "description": "Use this API to manage the IoT hubs in your Azure subscription.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "GET" }, { "name": "PUT" }, { "name": "PATCH" }, { "name": "DELETE" }, { "name": "POST" }, { "name": "Certificates" } ], "paths": { "/providers/Microsoft.Devices/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Operations_List": { "$ref": "./examples/iothub_operations.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs": { "get": { "operationId": "IotHubResource_ListBySubscription", "tags": [ "GET" ], "summary": "Get all the IoT hubs in a subscription", "description": "Get all the IoT hubs in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IotHubDescriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ListBySubscription": { "$ref": "./examples/iothub_listbysubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability": { "post": { "operationId": "IotHubResource_CheckNameAvailability", "tags": [ "POST" ], "summary": "Check if an IoT hub name is available", "description": "Check if an IoT hub name is available.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "operationInputs", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/OperationInputs" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IotHubNameAvailabilityInfo" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_CheckNameAvailability": { "$ref": "./examples/checkNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages": { "get": { "operationId": "ResourceProviderCommon_GetSubscriptionQuota", "tags": [ "GET" ], "summary": "Get the number of iot hubs in the subscription", "description": "Get the number of free and paid iot hubs in the subscription", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/UserSubscriptionQuotaListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "ResourceProviderCommon_GetSubscriptionQuota": { "$ref": "./examples/iothub_usages.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs": { "get": { "operationId": "IotHubResource_ListByResourceGroup", "tags": [ "GET" ], "summary": "Get all the IoT hubs in a resource group", "description": "Get all the IoT hubs in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IotHubDescriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ListByResourceGroup": { "$ref": "./examples/iothub_listbyrg.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}": { "get": { "operationId": "IotHubResource_Get", "tags": [ "GET" ], "summary": "Get the non-security related metadata of an IoT hub", "description": "Get the non-security related metadata of an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IotHubDescription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Get_IotHub_With_DeviceRegistry": { "$ref": "./examples/Get_IotHub_With_DeviceRegistry.json" }, "Get_IotHub_With_DeviceRegistry_Linking_Error": { "$ref": "./examples/Get_IotHub_With_DeviceRegistry_Linking_Error.json" }, "IotHubResource_Get": { "$ref": "./examples/iothub_get.json" } } }, "put": { "operationId": "IotHubResource_CreateOrUpdate", "tags": [ "PUT" ], "summary": "Create or update the metadata of an IoT hub.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "If-Match", "in": "header", "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, "type": "string" }, { "name": "iotHubDescription", "in": "body", "description": "The IoT hub metadata and security metadata.", "required": true, "schema": { "$ref": "#/definitions/IotHubDescription" } } ], "responses": { "200": { "description": "Resource 'IotHubDescription' update operation succeeded", "schema": { "$ref": "#/definitions/IotHubDescription" } }, "201": { "description": "Resource 'IotHubDescription' create operation succeeded", "schema": { "$ref": "#/definitions/IotHubDescription" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "CreateOrReplace_IotHub": { "$ref": "./examples/CreateOrReplace_IotHub.json" }, "IotHubResource_CreateOrUpdate": { "$ref": "./examples/iothub_createOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/IotHubDescription" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "IotHubResource_Update", "tags": [ "PATCH" ], "summary": "Update an existing IoT Hubs tags.", "description": "Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "IotHubTags", "in": "body", "description": "Updated tag information to set into the iot hub instance.", "required": true, "schema": { "$ref": "#/definitions/TagsResource" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IotHubDescription" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } } }, "x-ms-examples": { "IotHubResource_Update": { "$ref": "./examples/iothub_patch.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/IotHubDescription" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "IotHubResource_Delete", "tags": [ "DELETE" ], "summary": "Delete an IoT hub", "description": "Delete an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IotHubDescription" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/IotHubDescription" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "404": { "description": "The server cannot find the requested resource.", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_Delete": { "$ref": "./examples/iothub_delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/IotHubDescription" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys": { "post": { "operationId": "IotHubResource_GetKeysForKeyName", "tags": [ "POST" ], "summary": "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", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "keyName", "in": "path", "description": "The name of the shared access policy.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_GetKeysForKeyName": { "$ref": "./examples/iothub_getkey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats": { "get": { "operationId": "IotHubResource_GetStats", "tags": [ "GET" ], "summary": "Get the statistics from an IoT hub", "description": "Get the statistics from an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RegistryStatistics" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_GetStats": { "$ref": "./examples/iothub_stats.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates": { "get": { "operationId": "Certificates_ListByIotHub", "tags": [ "Certificates" ], "summary": "Get the certificate list.", "description": "Returns the list of certificates.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CertificateListDescription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Certificates_ListByIotHub": { "$ref": "./examples/iothub_listcertificates.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}": { "get": { "operationId": "Certificates_Get", "tags": [ "Certificates" ], "summary": "Get the certificate.", "description": "Returns the certificate.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of the certificate", "required": true, "type": "string", "pattern": "^[A-Za-z0-9-._]{1,64}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CertificateDescription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Certificates_Get": { "$ref": "./examples/iothub_getcertificate.json" } } }, "put": { "operationId": "Certificates_CreateOrUpdate", "tags": [ "Certificates" ], "summary": "Upload the certificate to the IoT hub.", "description": "Adds new or replaces existing certificate.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of the certificate", "required": true, "type": "string", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, { "name": "If-Match", "in": "header", "description": "ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate.", "required": false, "type": "string" }, { "name": "certificateDescription", "in": "body", "description": "The certificate body.", "required": true, "schema": { "$ref": "#/definitions/CertificateDescription" } } ], "responses": { "200": { "description": "Resource 'CertificateDescription' update operation succeeded", "schema": { "$ref": "#/definitions/CertificateDescription" } }, "201": { "description": "Resource 'CertificateDescription' create operation succeeded", "schema": { "$ref": "#/definitions/CertificateDescription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Certificates_CreateOrUpdate": { "$ref": "./examples/iothub_certificatescreateorupdate.json" }, "CreateOrReplace_Certificates_With_CertificateAuthorityResourceId": { "$ref": "./examples/CreateOrReplace_Certificates_With_CertificateAuthorityResourceId.json" } } }, "delete": { "operationId": "Certificates_Delete", "tags": [ "Certificates" ], "summary": "Delete an X509 certificate.", "description": "Deletes an existing X509 certificate or does nothing if it does not exist.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of the certificate", "required": true, "type": "string", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, { "name": "If-Match", "in": "header", "description": "ETag of the Certificate.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Certificates_Delete": { "$ref": "./examples/iothub_certificatesdelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode": { "post": { "operationId": "Certificates_GenerateVerificationCode", "tags": [ "Certificates" ], "summary": "Generate verification code for proof of possession flow.", "description": "Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of the certificate", "required": true, "type": "string", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, { "name": "If-Match", "in": "header", "description": "ETag of the Certificate.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CertificateWithNonceDescription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Certificates_GenerateVerificationCode": { "$ref": "./examples/iothub_generateverificationcode.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify": { "post": { "operationId": "Certificates_Verify", "tags": [ "Certificates" ], "summary": "Verify certificate's private key possession.", "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "The name of the certificate", "required": true, "type": "string", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, { "name": "If-Match", "in": "header", "description": "ETag of the Certificate.", "required": true, "type": "string" }, { "name": "certificateVerificationBody", "in": "body", "description": "The name of the certificate", "required": true, "schema": { "$ref": "#/definitions/CertificateVerificationDescription" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CertificateDescription" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "Certificates_Verify": { "$ref": "./examples/iothub_certverify.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups": { "get": { "operationId": "IotHubResource_ListEventHubConsumerGroups", "tags": [ "GET" ], "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub", "description": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "eventHubEndpointName", "in": "path", "description": "The name of the EventHubEndpoint", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EventHubConsumerGroupsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ListEventHubConsumerGroups": { "$ref": "./examples/iothub_listehgroups.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}": { "get": { "operationId": "IotHubResource_GetEventHubConsumerGroup", "tags": [ "GET" ], "summary": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub", "description": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "eventHubEndpointName", "in": "path", "description": "The name of the EventHubEndpoint", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The name of the consumer group to retrieve.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EventHubConsumerGroupInfo" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ListEventHubConsumerGroups": { "$ref": "./examples/iothub_getconsumergroup.json" } } }, "put": { "operationId": "IotHubResource_CreateEventHubConsumerGroup", "tags": [ "PUT" ], "summary": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub", "description": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "eventHubEndpointName", "in": "path", "description": "The name of the EventHubEndpoint", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The name of the consumer group to retrieve.", "required": true, "type": "string" }, { "name": "consumerGroupBody", "in": "body", "description": "The consumer group to add.", "required": true, "schema": { "$ref": "#/definitions/EventHubConsumerGroupBodyDescription" } } ], "responses": { "200": { "description": "Resource 'EventHubConsumerGroupInfo' update operation succeeded", "schema": { "$ref": "#/definitions/EventHubConsumerGroupInfo" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_CreateEventHubConsumerGroup": { "$ref": "./examples/iothub_createconsumergroup.json" } } }, "delete": { "operationId": "IotHubResource_DeleteEventHubConsumerGroup", "tags": [ "DELETE" ], "summary": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub", "description": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "eventHubEndpointName", "in": "path", "description": "The name of the EventHubEndpoint", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The name of the consumer group to retrieve.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_DeleteEventHubConsumerGroup": { "$ref": "./examples/iothub_deleteconsumergroup.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices": { "post": { "operationId": "IotHubResource_ExportDevices", "tags": [ "POST" ], "summary": "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", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "exportDevicesParameters", "in": "body", "description": "The parameters that specify the export devices operation.", "required": true, "schema": { "$ref": "#/definitions/ExportDevicesRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ExportDevices": { "$ref": "./examples/iothub_exportdevices.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover": { "post": { "operationId": "IotHub_ManualFailover", "tags": [ "POST" ], "summary": "Manually initiate a failover for the IoT Hub to its secondary region", "description": "Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "iotHubName", "in": "path", "required": true, "type": "string" }, { "name": "failoverInput", "in": "body", "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, "schema": { "$ref": "#/definitions/FailoverInput" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHub_ManualFailover": { "$ref": "./examples/IotHub_ManualFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices": { "post": { "operationId": "IotHubResource_ImportDevices", "tags": [ "POST" ], "summary": "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", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "importDevicesParameters", "in": "body", "description": "The parameters that specify the import devices operation.", "required": true, "schema": { "$ref": "#/definitions/ImportDevicesRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ImportDevices": { "$ref": "./examples/iothub_importdevices.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs": { "get": { "operationId": "IotHubResource_ListJobs", "tags": [ "GET" ], "summary": "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", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobResponseListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ListJobs": { "$ref": "./examples/iothub_listjobs.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}": { "get": { "operationId": "IotHubResource_GetJob", "tags": [ "GET" ], "summary": "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", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" }, { "name": "jobId", "in": "path", "description": "The job identifier.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_GetJob": { "$ref": "./examples/iothub_getjob.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys": { "post": { "operationId": "IotHubResource_ListKeys", "tags": [ "POST" ], "summary": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", "description": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_ListKeys": { "$ref": "./examples/iothub_listkeys.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics": { "get": { "operationId": "IotHubResource_GetQuotaMetrics", "tags": [ "GET" ], "summary": "Get the quota metrics for an IoT hub", "description": "Get the quota metrics for an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IotHubQuotaMetricInfoListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_GetQuotaMetrics": { "$ref": "./examples/iothub_quotametrics.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall": { "post": { "operationId": "IotHubResource_TestAllRoutes", "tags": [ "POST" ], "summary": "Test all routes", "description": "Test all routes configured in this Iot Hub", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "iotHubName", "in": "path", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Input for testing all routes", "required": true, "schema": { "$ref": "#/definitions/TestAllRoutesInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TestAllRoutesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_TestAllRoutes": { "$ref": "./examples/iothub_testallroutes.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew": { "post": { "operationId": "IotHubResource_TestRoute", "tags": [ "POST" ], "summary": "Test the new route", "description": "Test the new route for this Iot Hub", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "iotHubName", "in": "path", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Route that needs to be tested", "required": true, "schema": { "$ref": "#/definitions/TestRouteInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TestRouteResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_TestRoute": { "$ref": "./examples/iothub_testnewroute.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth": { "get": { "operationId": "IotHubResource_GetEndpointHealth", "tags": [ "GET" ], "summary": "Get the health for routing endpoints", "description": "Get the health for routing endpoints.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "iotHubName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EndpointHealthDataListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_GetEndpointHealth": { "$ref": "./examples/iothub_routingendpointhealth.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus": { "get": { "operationId": "IotHubResource_GetValidSkus", "tags": [ "GET" ], "summary": "Get the list of valid SKUs for an IoT hub", "description": "Get the list of valid SKUs for an IoT hub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IotHubSkuDescriptionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "IotHubResource_GetValidSkus": { "$ref": "./examples/iothub_getskus.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_List", "tags": [ "GET" ], "summary": "List private endpoint connections", "description": "List private endpoint connection properties", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT Hub", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "PrivateEndpointConnections_List": { "$ref": "./examples/iothub_listprivateendpointconnections.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "GET" ], "summary": "Get private endpoint connection", "description": "Get private endpoint connection properties", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT Hub", "required": true, "type": "string" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "PrivateEndpointConnection_Get": { "$ref": "./examples/iothub_getprivateendpointconnection.json" } } }, "put": { "operationId": "PrivateEndpointConnections_Update", "tags": [ "PUT" ], "summary": "Update private endpoint connection", "description": "Update the status of a private endpoint connection with the specified name", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT Hub", "required": true, "type": "string" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection", "required": true, "type": "string" }, { "name": "privateEndpointConnection", "in": "body", "description": "The private endpoint connection with updated properties", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Resource 'PrivateEndpointConnection' create operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "PrivateEndpointConnection_Update": { "$ref": "./examples/iothub_updateprivateendpointconnection.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "DELETE" ], "summary": "Delete private endpoint connection", "description": "Delete private endpoint connection with the specified name", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT Hub", "required": true, "type": "string" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "PrivateEndpointConnection_Delete": { "$ref": "./examples/iothub_deleteprivateendpointconnection.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources": { "get": { "operationId": "PrivateLinkResources_List", "tags": [ "GET" ], "summary": "List private link resources", "description": "List private link resources for the given IotHub", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT Hub", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResources" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "PrivateLinkResources_List": { "$ref": "./examples/iothub_listprivatelinkresources.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}": { "get": { "operationId": "PrivateLinkResources_Get", "tags": [ "GET" ], "summary": "Get the specified private link resource", "description": "Get the specified private link resource for the given IotHub", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the IoT Hub", "required": true, "type": "string" }, { "name": "groupId", "in": "path", "description": "The name of the private link resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GroupIdInformation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "x-ms-examples": { "PrivateLinkResources_List": { "$ref": "./examples/iothub_getprivatelinkresources.json" } } } } }, "definitions": { "AccessRights": { "type": "string", "description": "The permissions assigned to the shared access policy.", "enum": [ "RegistryRead", "RegistryWrite", "ServiceConnect", "DeviceConnect", "RegistryRead, RegistryWrite", "RegistryRead, ServiceConnect", "RegistryRead, DeviceConnect", "RegistryWrite, ServiceConnect", "RegistryWrite, DeviceConnect", "ServiceConnect, DeviceConnect", "RegistryRead, RegistryWrite, ServiceConnect", "RegistryRead, RegistryWrite, DeviceConnect", "RegistryRead, ServiceConnect, DeviceConnect", "RegistryWrite, ServiceConnect, DeviceConnect", "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" ], "x-ms-enum": { "name": "AccessRights", "modelAsString": false, "values": [ { "name": "RegistryRead", "value": "RegistryRead", "description": "RegistryRead" }, { "name": "RegistryWrite", "value": "RegistryWrite", "description": "RegistryWrite" }, { "name": "ServiceConnect", "value": "ServiceConnect", "description": "ServiceConnect" }, { "name": "DeviceConnect", "value": "DeviceConnect", "description": "DeviceConnect" }, { "name": "RegistryRead, RegistryWrite", "value": "RegistryRead, RegistryWrite", "description": "RegistryRead, RegistryWrite" }, { "name": "RegistryRead, ServiceConnect", "value": "RegistryRead, ServiceConnect", "description": "RegistryRead, ServiceConnect" }, { "name": "RegistryRead, DeviceConnect", "value": "RegistryRead, DeviceConnect", "description": "RegistryRead, DeviceConnect" }, { "name": "RegistryWrite, ServiceConnect", "value": "RegistryWrite, ServiceConnect", "description": "RegistryWrite, ServiceConnect" }, { "name": "RegistryWrite, DeviceConnect", "value": "RegistryWrite, DeviceConnect", "description": "RegistryWrite, DeviceConnect" }, { "name": "ServiceConnect, DeviceConnect", "value": "ServiceConnect, DeviceConnect", "description": "ServiceConnect, DeviceConnect" }, { "name": "RegistryRead, RegistryWrite, ServiceConnect", "value": "RegistryRead, RegistryWrite, ServiceConnect", "description": "RegistryRead, RegistryWrite, ServiceConnect" }, { "name": "RegistryRead, RegistryWrite, DeviceConnect", "value": "RegistryRead, RegistryWrite, DeviceConnect", "description": "RegistryRead, RegistryWrite, DeviceConnect" }, { "name": "RegistryRead, ServiceConnect, DeviceConnect", "value": "RegistryRead, ServiceConnect, DeviceConnect", "description": "RegistryRead, ServiceConnect, DeviceConnect" }, { "name": "RegistryWrite, ServiceConnect, DeviceConnect", "value": "RegistryWrite, ServiceConnect, DeviceConnect", "description": "RegistryWrite, ServiceConnect, DeviceConnect" }, { "name": "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect", "value": "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect", "description": "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" } ] } }, "ArmIdentity": { "type": "object", "properties": { "principalId": { "type": "string", "description": "Principal Id", "readOnly": true }, "tenantId": { "type": "string", "description": "Tenant Id", "readOnly": true }, "type": { "$ref": "#/definitions/ResourceIdentityType", "description": "The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service." }, "userAssignedIdentities": { "type": "object", "description": "Dictionary of ", "additionalProperties": { "$ref": "#/definitions/ArmUserIdentity" } } } }, "ArmUserIdentity": { "type": "object", "properties": { "principalId": { "type": "string", "readOnly": true }, "clientId": { "type": "string", "readOnly": true } } }, "AuthenticationType": { "type": "string", "description": "Specifies authentication type being used for connecting to the storage account.", "enum": [ "keyBased", "identityBased" ], "x-ms-enum": { "name": "AuthenticationType", "modelAsString": true, "values": [ { "name": "keyBased", "value": "keyBased", "description": "keyBased" }, { "name": "identityBased", "value": "identityBased", "description": "identityBased" } ] } }, "Capabilities": { "type": "string", "description": "The capabilities and features enabled for the IoT hub.", "enum": [ "None", "DeviceManagement" ], "x-ms-enum": { "name": "Capabilities", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "DeviceManagement", "value": "DeviceManagement", "description": "DeviceManagement" } ] } }, "CertificateDescription": { "type": "object", "description": "The X509 Certificate.", "properties": { "properties": { "$ref": "#/definitions/CertificateProperties", "description": "The description of an X509 CA Certificate." }, "etag": { "type": "string", "description": "The entity tag.", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CertificateListDescription": { "type": "object", "description": "The JSON-serialized array of Certificate objects.", "properties": { "value": { "type": "array", "description": "The array of Certificate objects.", "items": { "$ref": "#/definitions/CertificateDescription" } } } }, "CertificateProperties": { "type": "object", "description": "The description of an X509 CA Certificate.", "properties": { "subject": { "type": "string", "description": "The certificate's subject name.", "readOnly": true }, "expiry": { "type": "string", "format": "date-time-rfc7231", "description": "The certificate's expiration date and time.", "readOnly": true }, "thumbprint": { "type": "string", "description": "The certificate's thumbprint.", "readOnly": true }, "isVerified": { "type": "boolean", "description": "Determines whether certificate has been verified." }, "created": { "type": "string", "format": "date-time-rfc7231", "description": "The certificate's create date and time.", "readOnly": true }, "updated": { "type": "string", "format": "date-time-rfc7231", "description": "The certificate's last update date and time.", "readOnly": true }, "certificate": { "type": "string", "description": "The certificate content" }, "certificateAuthorityResourceId": { "type": "string", "format": "arm-id", "description": "Full certificate authority resource ID for ADR linked standard SKU hubs." } } }, "CertificatePropertiesWithNonce": { "type": "object", "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.", "properties": { "subject": { "type": "string", "description": "The certificate's subject name.", "readOnly": true }, "expiry": { "type": "string", "format": "date-time-rfc7231", "description": "The certificate's expiration date and time.", "readOnly": true }, "thumbprint": { "type": "string", "description": "The certificate's thumbprint.", "readOnly": true }, "isVerified": { "type": "boolean", "description": "Determines whether certificate has been verified.", "readOnly": true }, "created": { "type": "string", "format": "date-time-rfc7231", "description": "The certificate's create date and time.", "readOnly": true }, "updated": { "type": "string", "format": "date-time-rfc7231", "description": "The certificate's last update date and time.", "readOnly": true }, "verificationCode": { "type": "string", "description": "The certificate's verification code that will be used for proof of possession.", "readOnly": true }, "certificate": { "type": "string", "description": "The certificate content", "readOnly": true }, "certificateAuthorityResourceId": { "type": "string", "format": "arm-id", "description": "Full certificate authority resource ID for ADR linked standard SKU hubs." } } }, "CertificateVerificationDescription": { "type": "object", "description": "The JSON-serialized leaf certificate", "properties": { "certificate": { "type": "string", "description": "base-64 representation of X509 certificate .cer file or just .pem file content." } } }, "CertificateWithNonceDescription": { "type": "object", "description": "The X509 Certificate.", "properties": { "properties": { "$ref": "#/definitions/CertificatePropertiesWithNonce", "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow." }, "id": { "type": "string", "description": "The resource identifier.", "readOnly": true }, "name": { "type": "string", "description": "The name of the certificate.", "readOnly": true }, "etag": { "type": "string", "description": "The entity tag.", "readOnly": true }, "type": { "type": "string", "description": "The resource type.", "readOnly": true } }, "x-ms-azure-resource": true }, "CloudToDeviceProperties": { "type": "object", "description": "The IoT hub cloud-to-device messaging properties.", "properties": { "maxDeliveryCount": { "type": "integer", "format": "int32", "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.", "minimum": 1, "maximum": 100 }, "defaultTtlAsIso8601": { "type": "string", "format": "duration", "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." }, "feedback": { "$ref": "#/definitions/FeedbackProperties", "description": "The properties of the feedback queue for cloud-to-device messages." } } }, "DeviceRegistry": { "type": "object", "description": "Represents properties related to the Azure Device Registry (ADR).", "properties": { "namespaceResourceId": { "type": "string", "format": "arm-id", "description": "The identifier of the Azure Device Registry namespace" }, "namespaceUuid": { "type": "string", "description": "The UUID of the associated Azure Device Registry namespace." }, "dataPlaneHostName": { "type": "string", "description": "The host name for the data plane endpoint of the associated Azure Device Registry." }, "identity": { "$ref": "#/definitions/DeviceRegistryIdentity", "description": "The identity used to manage the ADR namespace from the data plane." }, "linkingProperties": { "$ref": "#/definitions/DeviceRegistryLinkingProperties", "description": "The properties related to linking the IoT Hub with the Azure Device Registry.", "readOnly": true } } }, "DeviceRegistryIdentity": { "type": "object", "description": "The identity used to manage the ADR namespace from the data plane.", "properties": { "type": { "$ref": "#/definitions/DeviceRegistryIdentityType", "description": "The type of the identity." }, "userAssignedIdentity": { "type": "string", "format": "arm-id", "description": "The user assigned identity if the identity type is 'UserAssigned'." } } }, "DeviceRegistryIdentityType": { "type": "string", "description": "The type of the identity.", "enum": [ "SystemAssigned", "UserAssigned" ], "x-ms-enum": { "name": "DeviceRegistryIdentityType", "modelAsString": true, "values": [ { "name": "SystemAssigned", "value": "SystemAssigned", "description": "Use a system-assigned managed identity to manage the ADR namespace." }, { "name": "UserAssigned", "value": "UserAssigned", "description": "Use a user-assigned managed identity to manage the ADR namespace." } ] } }, "DeviceRegistryLinkingProperties": { "type": "object", "description": "The properties related to linking the IoT Hub with the Azure Device Registry.", "properties": { "state": { "$ref": "#/definitions/DeviceRegistryLinkingState", "description": "Indicates whether the IoT Hub is linked with an Azure Device Registry.", "readOnly": true }, "error": { "$ref": "#/definitions/ErrorDetails", "description": "The last error encountered when linking the IoT Hub with an Azure Device Registry.", "readOnly": true } } }, "DeviceRegistryLinkingState": { "type": "string", "description": "Indicates whether the IoT Hub is linked with an Azure Device Registry.", "enum": [ "InProgress", "Success", "Orphaned", "Failed" ], "x-ms-enum": { "name": "DeviceRegistryLinkingState", "modelAsString": true, "values": [ { "name": "InProgress", "value": "InProgress", "description": "The IoT Hub linking with an Azure Device Registry is in progress." }, { "name": "Success", "value": "Success", "description": "The IoT Hub is successfully linked with an Azure Device Registry." }, { "name": "Orphaned", "value": "Orphaned", "description": "The linked Azure Device Registry is no longer associated with the IoT Hub." }, { "name": "Failed", "value": "Failed", "description": "The IoT Hub failed to link with an Azure Device Registry." } ] } }, "EndpointHealthData": { "type": "object", "description": "The health data for an endpoint", "properties": { "endpointId": { "type": "string", "description": "Id of the endpoint" }, "healthStatus": { "$ref": "#/definitions/EndpointHealthStatus", "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" }, "lastKnownError": { "type": "string", "description": "Last error obtained when a message failed to be delivered to iot hub" }, "lastKnownErrorTime": { "type": "string", "format": "date-time-rfc7231", "description": "Time at which the last known error occurred" }, "lastSuccessfulSendAttemptTime": { "type": "string", "format": "date-time-rfc7231", "description": "Last time iot hub successfully sent a message to the endpoint" }, "lastSendAttemptTime": { "type": "string", "format": "date-time-rfc7231", "description": "Last time iot hub tried to send a message to the endpoint" } } }, "EndpointHealthDataListResult": { "type": "object", "description": "The JSON-serialized array of EndpointHealthData objects with a next link.", "properties": { "value": { "type": "array", "description": "The EndpointHealthData items on this page", "items": { "$ref": "#/definitions/EndpointHealthData" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "EndpointHealthStatus": { "type": "string", "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", "healthy", "degraded", "unhealthy", "dead" ], "x-ms-enum": { "name": "EndpointHealthStatus", "modelAsString": true, "values": [ { "name": "unknown", "value": "unknown", "description": "unknown" }, { "name": "healthy", "value": "healthy", "description": "healthy" }, { "name": "degraded", "value": "degraded", "description": "degraded" }, { "name": "unhealthy", "value": "unhealthy", "description": "unhealthy" }, { "name": "dead", "value": "dead", "description": "dead" } ] } }, "EnrichmentProperties": { "type": "object", "description": "The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.", "properties": { "key": { "type": "string", "description": "The key or name for the enrichment property." }, "value": { "type": "string", "description": "The value for the enrichment property." }, "endpointNames": { "type": "array", "description": "The list of endpoints for which the enrichment is applied to the message.", "minItems": 1, "items": { "type": "string" } } }, "required": [ "key", "value", "endpointNames" ] }, "ErrorDetails": { "type": "object", "description": "Error details.", "properties": { "code": { "type": "string", "description": "The error code.", "readOnly": true }, "httpStatusCode": { "type": "string", "description": "The HTTP status code.", "readOnly": true }, "message": { "type": "string", "description": "The error message.", "readOnly": true }, "details": { "type": "string", "description": "The error details.", "readOnly": true } } }, "EventHubConsumerGroupBodyDescription": { "type": "object", "description": "The EventHub consumer group.", "properties": { "properties": { "$ref": "#/definitions/EventHubConsumerGroupName", "description": "The EventHub consumer group name." } }, "required": [ "properties" ] }, "EventHubConsumerGroupInfo": { "type": "object", "description": "The properties of the EventHubConsumerGroupInfo object.", "properties": { "properties": { "type": "object", "description": "The tags.", "additionalProperties": {} }, "etag": { "type": "string", "description": "The etag.", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "EventHubConsumerGroupName": { "type": "object", "description": "The EventHub consumer group name.", "properties": { "name": { "type": "string", "description": "EventHub consumer group name" } }, "required": [ "name" ] }, "EventHubConsumerGroupsListResult": { "type": "object", "description": "The JSON-serialized list of consumer groups for the Event Hub-compatible endpoint.", "properties": { "value": { "type": "array", "description": "The EventHubConsumerGroupInfo items on this page", "items": { "$ref": "#/definitions/EventHubConsumerGroupInfo" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "EventHubProperties": { "type": "object", "description": "The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.", "properties": { "retentionTimeInDays": { "type": "integer", "format": "int64", "description": "The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages" }, "partitionCount": { "type": "integer", "format": "int32", "description": "The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages." }, "partitionIds": { "type": "array", "description": "The partition ids in the Event Hub-compatible endpoint.", "items": { "type": "string" }, "readOnly": true }, "path": { "type": "string", "description": "The Event Hub-compatible name.", "readOnly": true }, "endpoint": { "type": "string", "description": "The Event Hub-compatible endpoint.", "readOnly": true } } }, "EventStreamAuthenticationType": { "type": "string", "description": "Specifies authentication type being used for connecting to the event stream account.", "enum": [ "identityBased" ], "x-ms-enum": { "name": "EventStreamAuthenticationType", "modelAsString": true, "values": [ { "name": "identityBased", "value": "identityBased", "description": "identityBased authentication" } ] } }, "ExportDevicesRequest": { "type": "object", "description": "Use to provide parameters when requesting an export of all devices in the IoT hub.", "properties": { "exportBlobContainerUri": { "type": "string", "description": "The export blob container URI." }, "excludeKeys": { "type": "boolean", "description": "The value indicating whether keys should be excluded during export." }, "exportBlobName": { "type": "string", "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." }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Specifies authentication type being used for connecting to the storage account." }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of storage endpoint for export devices." }, "includeConfigurations": { "type": "boolean", "description": "The value indicating whether configurations should be exported." }, "configurationsBlobName": { "type": "string", "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub." } }, "required": [ "exportBlobContainerUri", "excludeKeys" ] }, "FailoverInput": { "type": "object", "description": "Use to provide failover region when requesting manual Failover for a hub.", "properties": { "failoverRegion": { "type": "string", "description": "Region the hub will be failed over to" } }, "required": [ "failoverRegion" ] }, "FallbackRouteProperties": { "type": "object", "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", "properties": { "name": { "type": "string", "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." }, "source": { "$ref": "#/definitions/FallbackRouteSource", "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages" }, "condition": { "type": "string", "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" }, "endpointNames": { "type": "array", "description": "The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.", "minItems": 1, "maxItems": 1, "items": { "type": "string" } }, "isEnabled": { "type": "boolean", "description": "Used to specify whether the fallback route is enabled." } }, "required": [ "source", "endpointNames", "isEnabled" ] }, "FallbackRouteSource": { "type": "string", "description": "The source to which the fallback route is applied.", "enum": [ "DeviceMessages" ], "x-ms-enum": { "name": "FallbackRouteSource", "modelAsString": true, "values": [ { "name": "DeviceMessages", "value": "DeviceMessages", "description": "Device-to-cloud messages sent by devices." } ] } }, "FeedbackProperties": { "type": "object", "description": "The properties of the feedback queue for cloud-to-device messages.", "properties": { "lockDurationAsIso8601": { "type": "string", "format": "duration", "description": "The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages." }, "ttlAsIso8601": { "type": "string", "format": "duration", "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." }, "maxDeliveryCount": { "type": "integer", "format": "int32", "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.", "minimum": 1, "maximum": 100 } } }, "GatewayVersion": { "type": "string", "description": "The IoT hub Gateway version.", "enum": [ "V1", "V2" ], "x-ms-enum": { "name": "GatewayVersion", "modelAsString": true, "values": [ { "name": "V1", "value": "V1", "description": "V1" }, { "name": "V2", "value": "V2", "description": "V2" } ] } }, "GroupIdInformation": { "type": "object", "description": "The group information for creating a private endpoint on an IotHub", "properties": { "id": { "type": "string", "description": "The resource identifier.", "readOnly": true }, "name": { "type": "string", "description": "The resource name.", "readOnly": true }, "type": { "type": "string", "description": "The resource type.", "readOnly": true }, "properties": { "$ref": "#/definitions/GroupIdInformationProperties", "description": "The properties for a group information object" } }, "required": [ "properties" ] }, "GroupIdInformationProperties": { "type": "object", "description": "The properties for a group information object", "properties": { "groupId": { "type": "string", "description": "The group id" }, "requiredMembers": { "type": "array", "description": "The required members for a specific group id", "items": { "type": "string" } }, "requiredZoneNames": { "type": "array", "description": "The required DNS zones for a specific group id", "items": { "type": "string" } } } }, "ImportDevicesRequest": { "type": "object", "description": "Use to provide parameters when requesting an import of all devices in the hub.", "properties": { "inputBlobContainerUri": { "type": "string", "description": "The input blob container URI." }, "outputBlobContainerUri": { "type": "string", "description": "The output blob container URI." }, "inputBlobName": { "type": "string", "description": "The blob name to be used when importing from the provided input blob container." }, "outputBlobName": { "type": "string", "description": "The blob name to use for storing the status of the import job." }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Specifies authentication type being used for connecting to the storage account." }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of storage endpoint for import devices." }, "includeConfigurations": { "type": "boolean", "description": "The value indicating whether configurations should be imported." }, "configurationsBlobName": { "type": "string", "description": "The blob name to be used when importing configurations from the provided input blob container." } }, "required": [ "inputBlobContainerUri", "outputBlobContainerUri" ] }, "IotHubCapacity": { "type": "object", "description": "IoT Hub capacity information.", "properties": { "minimum": { "type": "integer", "format": "int64", "description": "The minimum number of units.", "minimum": 1, "maximum": 1, "readOnly": true }, "maximum": { "type": "integer", "format": "int64", "description": "The maximum number of units.", "readOnly": true }, "default": { "type": "integer", "format": "int64", "description": "The default number of units.", "readOnly": true }, "scaleType": { "$ref": "#/definitions/IotHubScaleType", "description": "The type of the scaling enabled.", "readOnly": true } } }, "IotHubDescription": { "type": "object", "description": "The description of the IoT hub.", "properties": { "properties": { "$ref": "#/definitions/IotHubProperties", "description": "IotHub properties" }, "etag": { "type": "string", "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." }, "sku": { "$ref": "#/definitions/IotHubSkuInfo", "description": "IotHub SKU info" }, "identity": { "$ref": "#/definitions/ArmIdentity", "description": "The managed identities for the IotHub." } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "IotHubDescriptionListResult": { "type": "object", "description": "The response of a IotHubDescription list operation.", "properties": { "value": { "type": "array", "description": "The IotHubDescription items on this page", "items": { "$ref": "#/definitions/IotHubDescription" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "IotHubDetails": { "type": "object", "description": "Set of additional read-only properties for the IoT hub.", "properties": { "gatewayVersion": { "$ref": "#/definitions/GatewayVersion", "description": "The IoT hub Gateway version." } } }, "IotHubLocationDescription": { "type": "object", "description": "Public representation of one of the locations where a resource is provisioned.", "properties": { "location": { "type": "string", "description": "The name of the Azure region" }, "role": { "$ref": "#/definitions/IotHubReplicaRoleType", "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." } } }, "IotHubNameAvailabilityInfo": { "type": "object", "description": "The properties indicating whether a given IoT hub name is available.", "properties": { "nameAvailable": { "type": "boolean", "description": "The value which indicates whether the provided name is available.", "readOnly": true }, "reason": { "$ref": "#/definitions/IotHubNameUnavailabilityReason", "description": "The reason for unavailability.", "readOnly": true }, "message": { "type": "string", "description": "The detailed reason message." } } }, "IotHubNameUnavailabilityReason": { "type": "string", "description": "The reason for unavailability.", "enum": [ "Invalid", "AlreadyExists" ], "x-ms-enum": { "name": "IotHubNameUnavailabilityReason", "modelAsString": false, "values": [ { "name": "Invalid", "value": "Invalid", "description": "Invalid" }, { "name": "AlreadyExists", "value": "AlreadyExists", "description": "AlreadyExists" } ] } }, "IotHubProperties": { "type": "object", "description": "The properties of an IoT hub.", "properties": { "authorizationPolicies": { "type": "array", "description": "The shared access policies you can use to secure a connection to the IoT hub.", "items": { "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" }, "x-ms-identifiers": [] }, "disableLocalAuth": { "type": "boolean", "description": "If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication." }, "disableDeviceSAS": { "type": "boolean", "description": "If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication." }, "disableModuleSAS": { "type": "boolean", "description": "If true, all module scoped SAS keys cannot be used for authentication." }, "restrictOutboundNetworkAccess": { "type": "boolean", "description": "If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList." }, "allowedFqdnList": { "type": "array", "description": "List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.", "items": { "type": "string" } }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Whether requests from Public Network are allowed" }, "ipFilterRules": { "type": "array", "description": "The IP filter rules.", "items": { "$ref": "#/definitions/IpFilterRule" }, "x-ms-identifiers": [] }, "networkRuleSets": { "$ref": "#/definitions/NetworkRuleSetProperties", "description": "Network Rule Set Properties of IotHub" }, "minTlsVersion": { "type": "string", "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." }, "privateEndpointConnections": { "type": "array", "description": "Private endpoint connections created on this IotHub", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "provisioningState": { "type": "string", "description": "The provisioning state.", "readOnly": true }, "state": { "type": "string", "description": "The hub state.", "readOnly": true }, "hostName": { "type": "string", "description": "The name of the host.", "readOnly": true }, "deviceHostName": { "type": "string", "description": "The name of the device host. Supports secure connections over TLS 1.3.", "readOnly": true }, "serviceHostName": { "type": "string", "description": "The name of the service host. Supports secure connections over TLS 1.3.", "readOnly": true }, "eventHubEndpoints": { "type": "object", "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.", "additionalProperties": { "$ref": "#/definitions/EventHubProperties" } }, "routing": { "$ref": "#/definitions/RoutingProperties", "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging" }, "storageEndpoints": { "type": "object", "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.", "additionalProperties": { "$ref": "#/definitions/StorageEndpointProperties" } }, "messagingEndpoints": { "type": "object", "description": "The messaging endpoint properties for the file upload notification queue.", "additionalProperties": { "$ref": "#/definitions/MessagingEndpointProperties" } }, "enableFileUploadNotifications": { "type": "boolean", "description": "If True, file upload notifications are enabled." }, "cloudToDevice": { "$ref": "#/definitions/CloudToDeviceProperties", "description": "The IoT hub cloud-to-device messaging properties." }, "comments": { "type": "string", "description": "IoT hub comments." }, "features": { "$ref": "#/definitions/Capabilities", "description": "The capabilities and features enabled for the IoT hub." }, "locations": { "type": "array", "description": "Primary and secondary location for iot hub", "items": { "$ref": "#/definitions/IotHubLocationDescription" }, "readOnly": true, "x-ms-identifiers": [] }, "enableDataResidency": { "type": "boolean", "description": "This property when set to true, will enable data residency, thus, disabling disaster recovery." }, "deviceRegistry": { "$ref": "#/definitions/DeviceRegistry", "description": "Represents properties related to the Azure Device Registry (ADR).", "readOnly": true }, "iotHubDetails": { "$ref": "#/definitions/IotHubDetails", "description": "Set of additional read-only properties for the IoT hub.", "readOnly": true } } }, "IotHubQuotaMetricInfo": { "type": "object", "description": "Quota metrics properties.", "properties": { "name": { "type": "string", "description": "The name of the quota metric.", "readOnly": true }, "currentValue": { "type": "integer", "format": "int64", "description": "The current value for the quota metric.", "readOnly": true }, "maxValue": { "type": "integer", "format": "int64", "description": "The maximum value of the quota metric.", "readOnly": true } } }, "IotHubQuotaMetricInfoListResult": { "type": "object", "description": "The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.", "properties": { "value": { "type": "array", "description": "The IotHubQuotaMetricInfo items on this page", "items": { "$ref": "#/definitions/IotHubQuotaMetricInfo" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "IotHubReplicaRoleType": { "type": "string", "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", "secondary" ], "x-ms-enum": { "name": "IotHubReplicaRoleType", "modelAsString": true, "values": [ { "name": "primary", "value": "primary", "description": "primary" }, { "name": "secondary", "value": "secondary", "description": "secondary" } ] } }, "IotHubScaleType": { "type": "string", "description": "The type of the scaling enabled.", "enum": [ "Automatic", "Manual", "None" ], "x-ms-enum": { "name": "IotHubScaleType", "modelAsString": false, "values": [ { "name": "Automatic", "value": "Automatic", "description": "Automatic" }, { "name": "Manual", "value": "Manual", "description": "Manual" }, { "name": "None", "value": "None", "description": "None" } ] } }, "IotHubSku": { "type": "string", "description": "The name of the SKU.", "enum": [ "F1", "S1", "S2", "S3", "B1", "B2", "B3" ], "x-ms-enum": { "name": "IotHubSku", "modelAsString": true, "values": [ { "name": "F1", "value": "F1", "description": "F1" }, { "name": "S1", "value": "S1", "description": "S1" }, { "name": "S2", "value": "S2", "description": "S2" }, { "name": "S3", "value": "S3", "description": "S3" }, { "name": "B1", "value": "B1", "description": "B1" }, { "name": "B2", "value": "B2", "description": "B2" }, { "name": "B3", "value": "B3", "description": "B3" } ] } }, "IotHubSkuDescription": { "type": "object", "description": "SKU properties.", "properties": { "resourceType": { "type": "string", "description": "The type of the resource.", "readOnly": true }, "sku": { "$ref": "#/definitions/IotHubSkuInfo", "description": "The type of the resource." }, "capacity": { "$ref": "#/definitions/IotHubCapacity", "description": "IotHub capacity" } }, "required": [ "sku", "capacity" ] }, "IotHubSkuDescriptionListResult": { "type": "object", "description": "The JSON-serialized array of IotHubSkuDescription objects with a next link.", "properties": { "value": { "type": "array", "description": "The IotHubSkuDescription items on this page", "items": { "$ref": "#/definitions/IotHubSkuDescription" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "IotHubSkuInfo": { "type": "object", "description": "Information about the SKU of the IoT hub.", "properties": { "name": { "$ref": "#/definitions/IotHubSku", "description": "The name of the SKU." }, "tier": { "$ref": "#/definitions/IotHubSkuTier", "description": "The billing tier for the IoT hub.", "readOnly": true }, "capacity": { "type": "integer", "format": "int64", "description": "The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits." } }, "required": [ "name" ] }, "IotHubSkuTier": { "type": "string", "description": "The billing tier for the IoT hub.", "enum": [ "Free", "Standard", "Basic" ], "x-ms-enum": { "name": "IotHubSkuTier", "modelAsString": false, "values": [ { "name": "Free", "value": "Free", "description": "Free" }, { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Basic", "value": "Basic", "description": "Basic" } ] } }, "IpFilterActionType": { "type": "string", "description": "The desired action for requests captured by this rule.", "enum": [ "Accept", "Reject" ], "x-ms-enum": { "name": "IpFilterActionType", "modelAsString": false, "values": [ { "name": "Accept", "value": "Accept", "description": "Accept" }, { "name": "Reject", "value": "Reject", "description": "Reject" } ] } }, "IpFilterRule": { "type": "object", "description": "The IP filter rules for the IoT hub.", "properties": { "filterName": { "type": "string", "description": "The name of the IP filter rule." }, "action": { "$ref": "#/definitions/IpFilterActionType", "description": "The desired action for requests captured by this rule." }, "ipMask": { "type": "string", "description": "A string that contains the IP address range in CIDR notation for the rule." } }, "required": [ "filterName", "action", "ipMask" ] }, "JobResponse": { "type": "object", "description": "The properties of the Job Response object.", "properties": { "jobId": { "type": "string", "description": "The job identifier.", "readOnly": true }, "startTimeUtc": { "type": "string", "format": "date-time-rfc7231", "description": "The start time of the job.", "readOnly": true }, "endTimeUtc": { "type": "string", "format": "date-time-rfc7231", "description": "The time the job stopped processing.", "readOnly": true }, "type": { "$ref": "#/definitions/JobType", "description": "The type of the job.", "readOnly": true }, "status": { "$ref": "#/definitions/JobStatus", "description": "The status of the job.", "readOnly": true }, "failureReason": { "type": "string", "description": "If status == failed, this string containing the reason for the failure.", "readOnly": true }, "statusMessage": { "type": "string", "description": "The status message for the job.", "readOnly": true }, "parentJobId": { "type": "string", "description": "The job identifier of the parent job, if any.", "readOnly": true } } }, "JobResponseListResult": { "type": "object", "description": "The JSON-serialized array of JobResponse objects with a next link.", "properties": { "value": { "type": "array", "description": "The JobResponse items on this page", "items": { "$ref": "#/definitions/JobResponse" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "JobStatus": { "type": "string", "description": "The status of the job.", "enum": [ "unknown", "enqueued", "running", "completed", "failed", "cancelled" ], "x-ms-enum": { "name": "JobStatus", "modelAsString": false, "values": [ { "name": "unknown", "value": "unknown", "description": "unknown" }, { "name": "enqueued", "value": "enqueued", "description": "enqueued" }, { "name": "running", "value": "running", "description": "running" }, { "name": "completed", "value": "completed", "description": "completed" }, { "name": "failed", "value": "failed", "description": "failed" }, { "name": "cancelled", "value": "cancelled", "description": "cancelled" } ] } }, "JobType": { "type": "string", "description": "The type of the job.", "enum": [ "unknown", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate" ], "x-ms-enum": { "name": "JobType", "modelAsString": true, "values": [ { "name": "unknown", "value": "unknown", "description": "unknown" }, { "name": "export", "value": "export", "description": "export" }, { "name": "import", "value": "import", "description": "import" }, { "name": "backup", "value": "backup", "description": "backup" }, { "name": "readDeviceProperties", "value": "readDeviceProperties", "description": "readDeviceProperties" }, { "name": "writeDeviceProperties", "value": "writeDeviceProperties", "description": "writeDeviceProperties" }, { "name": "updateDeviceConfiguration", "value": "updateDeviceConfiguration", "description": "updateDeviceConfiguration" }, { "name": "rebootDevice", "value": "rebootDevice", "description": "rebootDevice" }, { "name": "factoryResetDevice", "value": "factoryResetDevice", "description": "factoryResetDevice" }, { "name": "firmwareUpdate", "value": "firmwareUpdate", "description": "firmwareUpdate" } ] } }, "ManagedIdentity": { "type": "object", "description": "The properties of the Managed identity.", "properties": { "userAssignedIdentity": { "type": "string", "description": "The user assigned identity." } } }, "MatchedRoute": { "type": "object", "description": "Routes that matched", "properties": { "properties": { "$ref": "#/definitions/RouteProperties", "description": "Properties of routes that matched" } } }, "MessagingEndpointProperties": { "type": "object", "description": "The properties of the messaging endpoints used by this IoT hub.", "properties": { "lockDurationAsIso8601": { "type": "string", "format": "duration", "description": "The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload." }, "ttlAsIso8601": { "type": "string", "format": "duration", "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-file-upload." }, "maxDeliveryCount": { "type": "integer", "format": "int32", "description": "The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", "minimum": 1, "maximum": 100 } } }, "Name": { "type": "object", "description": "Name of Iot Hub type", "properties": { "value": { "type": "string", "description": "IotHub type" }, "localizedValue": { "type": "string", "description": "Localized value of name" } } }, "NetworkRuleSetIpRule": { "type": "object", "description": "IP Rule to be applied as part of Network Rule Set", "properties": { "filterName": { "type": "string", "description": "Name of the IP filter rule." }, "action": { "type": "string", "description": "IP Filter Action", "default": "Allow", "enum": [ "Allow" ], "x-ms-enum": { "name": "NetworkRuleIPAction", "modelAsString": true, "values": [ { "name": "Allow", "value": "Allow", "description": "Allow" } ] } }, "ipMask": { "type": "string", "description": "A string that contains the IP address range in CIDR notation for the rule." } }, "required": [ "filterName", "ipMask" ] }, "NetworkRuleSetProperties": { "type": "object", "description": "Network Rule Set Properties of IotHub", "properties": { "defaultAction": { "type": "string", "description": "Default Action for Network Rule Set", "default": "Deny", "enum": [ "Deny", "Allow" ], "x-ms-enum": { "name": "DefaultAction", "modelAsString": true, "values": [ { "name": "Deny", "value": "Deny", "description": "Deny" }, { "name": "Allow", "value": "Allow", "description": "Allow" } ] } }, "applyToBuiltInEventHubEndpoint": { "type": "boolean", "description": "If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub" }, "ipRules": { "type": "array", "description": "List of IP Rules", "items": { "$ref": "#/definitions/NetworkRuleSetIpRule" }, "x-ms-identifiers": [] } }, "required": [ "applyToBuiltInEventHubEndpoint", "ipRules" ] }, "Operation": { "type": "object", "description": "IoT Hub REST API operation", "properties": { "name": { "type": "string", "description": "Operation name: {provider}/{resource}/{read | write | action | delete}", "readOnly": true }, "display": { "$ref": "#/definitions/OperationDisplay", "description": "The object that represents the operation." } } }, "OperationDisplay": { "type": "object", "description": "The object that represents the operation.", "properties": { "provider": { "type": "string", "description": "Service provider: Microsoft Devices", "readOnly": true }, "resource": { "type": "string", "description": "Resource Type: IotHubs", "readOnly": true }, "operation": { "type": "string", "description": "Name of the operation", "readOnly": true }, "description": { "type": "string", "description": "Description of the operation", "readOnly": true } } }, "OperationInputs": { "type": "object", "description": "Input values.", "properties": { "name": { "type": "string", "description": "The name of the IoT hub to check." } }, "required": [ "name" ] }, "OperationListResult": { "type": "object", "description": "Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.", "properties": { "value": { "type": "array", "description": "List of IoT Hub operations supported by the Microsoft.Devices resource provider.", "items": { "$ref": "#/definitions/Operation" }, "readOnly": true }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any.", "readOnly": true } } }, "PrivateEndpoint": { "type": "object", "description": "The private endpoint property of a private endpoint connection", "properties": { "id": { "type": "string", "description": "The resource identifier.", "readOnly": true } } }, "PrivateEndpointConnection": { "type": "object", "description": "The private endpoint connection of an IotHub", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "The properties of a private endpoint connection" } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionProperties": { "type": "object", "description": "The properties of a private endpoint connection", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The private endpoint property of a private endpoint connection" }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState", "description": "The current state of a private endpoint connection" } }, "required": [ "privateLinkServiceConnectionState" ] }, "PrivateLinkResources": { "type": "object", "description": "The available private link resources for an IotHub", "properties": { "value": { "type": "array", "description": "The list of available private link resources for an IotHub", "items": { "$ref": "#/definitions/GroupIdInformation" } } } }, "PrivateLinkServiceConnectionState": { "type": "object", "description": "The current state of a private endpoint connection", "properties": { "status": { "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", "description": "The status of a private endpoint connection" }, "description": { "type": "string", "description": "The description for the current state of a private endpoint connection" }, "actionsRequired": { "type": "string", "description": "Actions required for a private endpoint connection" } }, "required": [ "status", "description" ] }, "PrivateLinkServiceConnectionStatus": { "type": "string", "description": "The status of a private endpoint connection", "enum": [ "Pending", "Approved", "Rejected", "Disconnected" ], "x-ms-enum": { "name": "PrivateLinkServiceConnectionStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "Approved", "value": "Approved", "description": "Approved" }, { "name": "Rejected", "value": "Rejected", "description": "Rejected" }, { "name": "Disconnected", "value": "Disconnected", "description": "Disconnected" } ] } }, "PublicNetworkAccess": { "type": "string", "description": "Whether requests from Public Network are allowed", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } }, "RegistryStatistics": { "type": "object", "description": "Identity registry statistics.", "properties": { "totalDeviceCount": { "type": "integer", "format": "int64", "description": "The total count of devices in the identity registry.", "readOnly": true }, "enabledDeviceCount": { "type": "integer", "format": "int64", "description": "The count of enabled devices in the identity registry.", "readOnly": true }, "disabledDeviceCount": { "type": "integer", "format": "int64", "description": "The count of disabled devices in the identity registry.", "readOnly": true } } }, "ResourceIdentityType": { "type": "string", "description": "The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.", "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", "None" ], "x-ms-enum": { "name": "ResourceIdentityType", "modelAsString": false, "values": [ { "name": "SystemAssigned", "value": "SystemAssigned", "description": "SystemAssigned" }, { "name": "UserAssigned", "value": "UserAssigned", "description": "UserAssigned" }, { "name": "SystemAssigned, UserAssigned", "value": "SystemAssigned, UserAssigned", "description": "SystemAssigned, UserAssigned" }, { "name": "None", "value": "None", "description": "None" } ] } }, "RouteCompilationError": { "type": "object", "description": "Compilation error when evaluating route", "properties": { "message": { "type": "string", "description": "Route error message" }, "severity": { "$ref": "#/definitions/RouteErrorSeverity", "description": "Severity of the route error" }, "location": { "$ref": "#/definitions/RouteErrorRange", "description": "Location where the route error happened" } } }, "RouteErrorPosition": { "type": "object", "description": "Position where the route error happened", "properties": { "line": { "type": "integer", "format": "int32", "description": "Line where the route error happened" }, "column": { "type": "integer", "format": "int32", "description": "Column where the route error happened" } } }, "RouteErrorRange": { "type": "object", "description": "Range of route errors", "properties": { "start": { "$ref": "#/definitions/RouteErrorPosition", "description": "Start where the route error happened" }, "end": { "$ref": "#/definitions/RouteErrorPosition", "description": "End where the route error happened" } } }, "RouteErrorSeverity": { "type": "string", "description": "Severity of the route error", "enum": [ "error", "warning" ], "x-ms-enum": { "name": "RouteErrorSeverity", "modelAsString": true, "values": [ { "name": "error", "value": "error", "description": "error" }, { "name": "warning", "value": "warning", "description": "warning" } ] } }, "RouteProperties": { "type": "object", "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", "properties": { "name": { "type": "string", "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.", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "source": { "$ref": "#/definitions/RoutingSource", "description": "The source that the routing rule is to be applied to, such as DeviceMessages." }, "condition": { "type": "string", "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" }, "endpointNames": { "type": "array", "description": "The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.", "minItems": 1, "maxItems": 1, "items": { "type": "string" } }, "isEnabled": { "type": "boolean", "description": "Used to specify whether a route is enabled." } }, "required": [ "name", "source", "endpointNames", "isEnabled" ] }, "RoutingCosmosDBSqlApiProperties": { "type": "object", "description": "The properties related to a cosmos DB sql container endpoint.", "properties": { "name": { "type": "string", "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.", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "id": { "type": "string", "description": "Id of the cosmos DB sql container endpoint", "readOnly": true }, "subscriptionId": { "type": "string", "description": "The subscription identifier of the cosmos DB account." }, "resourceGroup": { "type": "string", "description": "The name of the resource group of the cosmos DB account." }, "endpointUri": { "type": "string", "format": "uri", "description": "The url of the cosmos DB account. It must include the protocol https://" }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Method used to authenticate against the cosmos DB sql container endpoint" }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of routing cosmos DB container endpoint." }, "primaryKey": { "type": "string", "format": "password", "description": "The primary key of the cosmos DB account.", "x-ms-secret": true }, "secondaryKey": { "type": "string", "format": "password", "description": "The secondary key of the cosmos DB account.", "x-ms-secret": true }, "databaseName": { "type": "string", "description": "The name of the cosmos DB database in the cosmos DB account." }, "containerName": { "type": "string", "description": "The name of the cosmos DB sql container in the cosmos DB database." }, "partitionKeyName": { "type": "string", "description": "The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter." }, "partitionKeyTemplate": { "type": "string", "description": "The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified." } }, "required": [ "name", "endpointUri", "databaseName", "containerName" ] }, "RoutingEndpoints": { "type": "object", "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.", "properties": { "serviceBusQueues": { "type": "array", "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.", "items": { "$ref": "#/definitions/RoutingServiceBusQueueEndpointProperties" } }, "serviceBusTopics": { "type": "array", "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.", "items": { "$ref": "#/definitions/RoutingServiceBusTopicEndpointProperties" } }, "eventHubs": { "type": "array", "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.", "items": { "$ref": "#/definitions/RoutingEventHubProperties" } }, "storageContainers": { "type": "array", "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", "items": { "$ref": "#/definitions/RoutingStorageContainerProperties" } }, "cosmosDBSqlContainers": { "type": "array", "description": "The list of Cosmos DB container endpoints that IoT hub routes messages to, based on the routing rules.", "items": { "$ref": "#/definitions/RoutingCosmosDBSqlApiProperties" } }, "eventStreams": { "type": "array", "description": "The list of event stream endpoints that IoT hub routes messages to, based on the routing rules.", "items": { "$ref": "#/definitions/RoutingEventStreamProperties" } } } }, "RoutingEventHubProperties": { "type": "object", "description": "The properties related to an event hub endpoint.", "properties": { "id": { "type": "string", "description": "Id of the event hub endpoint" }, "connectionString": { "type": "string", "format": "password", "description": "The connection string of the event hub endpoint.", "x-ms-secret": true }, "endpointUri": { "type": "string", "description": "The url of the event hub endpoint. It must include the protocol sb://" }, "entityPath": { "type": "string", "description": "Event hub name on the event hub namespace" }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Method used to authenticate against the event hub endpoint" }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of routing event hub endpoint." }, "name": { "type": "string", "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.", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "subscriptionId": { "type": "string", "description": "The subscription identifier of the event hub endpoint." }, "resourceGroup": { "type": "string", "description": "The name of the resource group of the event hub endpoint." } }, "required": [ "name" ] }, "RoutingEventStreamProperties": { "type": "object", "description": "The properties related to an event stream endpoint.", "properties": { "name": { "type": "string", "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.", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "id": { "type": "string", "description": "Id of the event stream endpoint", "readOnly": true }, "endpointUri": { "type": "string", "description": "The url of the underlying event hub namespace of the event stream endpoint. It must include the protocol sb://" }, "entityPath": { "type": "string", "description": "Event hub name on the event hub namespace" }, "authenticationType": { "$ref": "#/definitions/EventStreamAuthenticationType", "description": "Method used to authenticate against the event stream endpoint" }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of routing event stream endpoint." }, "workspaceId": { "type": "string", "description": "The unique GUID of the target Microsoft Fabric workspace for the event stream endpoint." }, "eventStreamId": { "type": "string", "description": "The unique GUID of the target event stream under the workspace." }, "sourceId": { "type": "string", "description": "The unique GUID of the custom source for the event stream." } }, "required": [ "name", "endpointUri", "entityPath" ] }, "RoutingMessage": { "type": "object", "description": "Routing message", "properties": { "body": { "type": "string", "description": "Body of routing message" }, "appProperties": { "type": "object", "description": "App properties", "additionalProperties": { "type": "string" } }, "systemProperties": { "type": "object", "description": "System properties", "additionalProperties": { "type": "string" } } } }, "RoutingProperties": { "type": "object", "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging", "properties": { "endpoints": { "$ref": "#/definitions/RoutingEndpoints", "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." }, "routes": { "type": "array", "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.", "items": { "$ref": "#/definitions/RouteProperties" } }, "fallbackRoute": { "$ref": "#/definitions/FallbackRouteProperties", "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." }, "enrichments": { "type": "array", "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", "items": { "$ref": "#/definitions/EnrichmentProperties" }, "x-ms-identifiers": [] } } }, "RoutingServiceBusQueueEndpointProperties": { "type": "object", "description": "The properties related to service bus queue endpoint types.", "properties": { "id": { "type": "string", "description": "Id of the service bus queue endpoint" }, "connectionString": { "type": "string", "format": "password", "description": "The connection string of the service bus queue endpoint.", "x-ms-secret": true }, "endpointUri": { "type": "string", "description": "The url of the service bus queue endpoint. It must include the protocol sb://" }, "entityPath": { "type": "string", "description": "Queue name on the service bus namespace" }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Method used to authenticate against the service bus queue endpoint" }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of routing service bus queue endpoint." }, "name": { "type": "string", "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.", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "subscriptionId": { "type": "string", "description": "The subscription identifier of the service bus queue endpoint." }, "resourceGroup": { "type": "string", "description": "The name of the resource group of the service bus queue endpoint." } }, "required": [ "name" ] }, "RoutingServiceBusTopicEndpointProperties": { "type": "object", "description": "The properties related to service bus topic endpoint types.", "properties": { "id": { "type": "string", "description": "Id of the service bus topic endpoint" }, "connectionString": { "type": "string", "format": "password", "description": "The connection string of the service bus topic endpoint.", "x-ms-secret": true }, "endpointUri": { "type": "string", "description": "The url of the service bus topic endpoint. It must include the protocol sb://" }, "entityPath": { "type": "string", "description": "Queue name on the service bus topic" }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Method used to authenticate against the service bus topic endpoint" }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of routing service bus topic endpoint." }, "name": { "type": "string", "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.", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "subscriptionId": { "type": "string", "description": "The subscription identifier of the service bus topic endpoint." }, "resourceGroup": { "type": "string", "description": "The name of the resource group of the service bus topic endpoint." } }, "required": [ "name" ] }, "RoutingSource": { "type": "string", "description": "The source that the routing rule is to be applied to, such as DeviceMessages.", "enum": [ "Invalid", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", "DeviceConnectionStateEvents" ], "x-ms-enum": { "name": "RoutingSource", "modelAsString": true, "values": [ { "name": "Invalid", "value": "Invalid", "description": "Invalid" }, { "name": "DeviceMessages", "value": "DeviceMessages", "description": "DeviceMessages" }, { "name": "TwinChangeEvents", "value": "TwinChangeEvents", "description": "TwinChangeEvents" }, { "name": "DeviceLifecycleEvents", "value": "DeviceLifecycleEvents", "description": "DeviceLifecycleEvents" }, { "name": "DeviceJobLifecycleEvents", "value": "DeviceJobLifecycleEvents", "description": "DeviceJobLifecycleEvents" }, { "name": "DeviceConnectionStateEvents", "value": "DeviceConnectionStateEvents", "description": "DeviceConnectionStateEvents" } ] } }, "RoutingStorageContainerProperties": { "type": "object", "description": "The properties related to a storage container endpoint.", "properties": { "id": { "type": "string", "description": "Id of the storage container endpoint" }, "connectionString": { "type": "string", "format": "password", "description": "The connection string of the storage account.", "x-ms-secret": true }, "endpointUri": { "type": "string", "description": "The url of the storage endpoint. It must include the protocol https://" }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Method used to authenticate against the storage endpoint" }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of routing storage endpoint." }, "name": { "type": "string", "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.", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "subscriptionId": { "type": "string", "description": "The subscription identifier of the storage account." }, "resourceGroup": { "type": "string", "description": "The name of the resource group of the storage account." }, "containerName": { "type": "string", "description": "The name of storage container in the storage account." }, "fileNameFormat": { "type": "string", "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." }, "batchFrequencyInSeconds": { "type": "integer", "format": "int32", "description": "Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.", "minimum": 60, "maximum": 720 }, "maxChunkSizeInBytes": { "type": "integer", "format": "int32", "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).", "minimum": 10485760, "maximum": 524288000 }, "encoding": { "$ref": "#/definitions/RoutingStorageContainerPropertiesEncoding", "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'." } }, "required": [ "name", "containerName" ] }, "RoutingStorageContainerPropertiesEncoding": { "type": "string", "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.", "enum": [ "Avro", "AvroDeflate", "JSON" ], "x-ms-enum": { "name": "RoutingStorageContainerPropertiesEncoding", "modelAsString": true, "values": [ { "name": "Avro", "value": "Avro", "description": "Avro" }, { "name": "AvroDeflate", "value": "AvroDeflate", "description": "AvroDeflate" }, { "name": "JSON", "value": "JSON", "description": "JSON" } ] } }, "RoutingTwin": { "type": "object", "description": "Twin reference input parameter. This is an optional parameter", "properties": { "tags": { "type": "object", "description": "Twin Tags", "additionalProperties": {} }, "properties": { "$ref": "#/definitions/RoutingTwinProperties" } } }, "RoutingTwinProperties": { "type": "object", "properties": { "desired": { "type": "object", "description": "Twin desired properties", "additionalProperties": {} }, "reported": { "type": "object", "description": "Twin reported properties", "additionalProperties": {} } } }, "SharedAccessSignatureAuthorizationRule": { "type": "object", "description": "The properties of an IoT hub shared access policy.", "properties": { "keyName": { "type": "string", "description": "The name of the shared access policy." }, "primaryKey": { "type": "string", "description": "The primary key." }, "secondaryKey": { "type": "string", "description": "The secondary key." }, "rights": { "$ref": "#/definitions/AccessRights", "description": "The permissions assigned to the shared access policy." } }, "required": [ "keyName", "rights" ] }, "SharedAccessSignatureAuthorizationRuleListResult": { "type": "object", "description": "The list of shared access policies with a next link.", "properties": { "value": { "type": "array", "description": "The SharedAccessSignatureAuthorizationRule items on this page", "items": { "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "StorageEndpointProperties": { "type": "object", "description": "The properties of the Azure Storage endpoint for file upload.", "properties": { "sasTtlAsIso8601": { "type": "string", "format": "duration", "description": "The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options." }, "connectionString": { "type": "string", "description": "The connection string for the Azure Storage account to which files are uploaded." }, "containerName": { "type": "string", "description": "The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified." }, "authenticationType": { "$ref": "#/definitions/AuthenticationType", "description": "Specifies authentication type being used for connecting to the storage account." }, "identity": { "$ref": "#/definitions/ManagedIdentity", "description": "Managed identity properties of storage endpoint for file upload." } }, "required": [ "connectionString", "containerName" ] }, "TagsResource": { "type": "object", "description": "A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.", "properties": { "tags": { "type": "object", "description": "Resource tags", "additionalProperties": { "type": "string" } } } }, "TestAllRoutesInput": { "type": "object", "description": "Input for testing all routes", "properties": { "routingSource": { "$ref": "#/definitions/RoutingSource", "description": "Routing source" }, "message": { "$ref": "#/definitions/RoutingMessage", "description": "Routing message" }, "twin": { "$ref": "#/definitions/RoutingTwin", "description": "Routing Twin Reference" } } }, "TestAllRoutesResult": { "type": "object", "description": "Result of testing all routes", "properties": { "routes": { "type": "array", "description": "JSON-serialized array of matched routes", "items": { "$ref": "#/definitions/MatchedRoute" }, "x-ms-identifiers": [] } } }, "TestResultStatus": { "type": "string", "description": "Result of testing route", "enum": [ "undefined", "false", "true" ], "x-ms-enum": { "name": "TestResultStatus", "modelAsString": true, "values": [ { "name": "undefined", "value": "undefined", "description": "undefined" }, { "name": "false", "value": "false", "description": "false" }, { "name": "true", "value": "true", "description": "true" } ] } }, "TestRouteInput": { "type": "object", "description": "Input for testing route", "properties": { "message": { "$ref": "#/definitions/RoutingMessage", "description": "Routing message" }, "route": { "$ref": "#/definitions/RouteProperties", "description": "Route properties" }, "twin": { "$ref": "#/definitions/RoutingTwin", "description": "Routing Twin Reference" } }, "required": [ "route" ] }, "TestRouteResult": { "type": "object", "description": "Result of testing one route", "properties": { "result": { "$ref": "#/definitions/TestResultStatus", "description": "Result of testing route" }, "details": { "$ref": "#/definitions/TestRouteResultDetails", "description": "Detailed result of testing route" } } }, "TestRouteResultDetails": { "type": "object", "description": "Detailed result of testing a route", "properties": { "compilationErrors": { "type": "array", "description": "JSON-serialized list of route compilation errors", "items": { "$ref": "#/definitions/RouteCompilationError" }, "x-ms-identifiers": [] } } }, "UserSubscriptionQuota": { "type": "object", "description": "User subscription quota response", "properties": { "id": { "type": "string", "description": "IotHub type id" }, "type": { "type": "string", "description": "Response type" }, "unit": { "type": "string", "description": "Unit of IotHub type" }, "currentValue": { "type": "integer", "format": "int32", "description": "Current number of IotHub type" }, "limit": { "type": "integer", "format": "int32", "description": "Numerical limit on IotHub type" }, "name": { "$ref": "#/definitions/Name", "description": "IotHub type" } } }, "UserSubscriptionQuotaListResult": { "type": "object", "description": "Json-serialized array of User subscription quota response", "properties": { "value": { "type": "array", "description": "The UserSubscriptionQuota items on this page", "items": { "$ref": "#/definitions/UserSubscriptionQuota" } }, "nextLink": { "type": "string", "description": "The link to the next page of items", "readOnly": true } } } }, "parameters": {} }