From 3d5fa6ffc5a45cc60c64682e45cb754e9af679d6 Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Tue, 24 Aug 2021 07:14:40 +0000 Subject: [PATCH] CodeGen from PR 15428 in Azure/azure-rest-api-specs [Hub Generated] Review request for Microsoft.Devices to add version preview/2021-09-01-preview (#15428) * Adds base for updating Microsoft.Devices from version preview/2021-07-01-preview to version 2021-09-01-preview * Updates readme * Updates API version in new specs and examples * Added creation time in the iothub description * implemented system data property * updating examples for iothub bv rg and subscription * Committing unsaved changes * removing creationTime * reverting unformatted change * Fixing josn pretty issue * Adds suppression to readme * Removing external reference to internal reference * reverting the suppression --- .../2021-07-01-preview/Microsoft.Devices.json | 6 +- .../2021-09-01-preview/Microsoft.Devices.json | 1798 +++++++++++++++++ schemas/common/autogeneratedResources.json | 12 + 3 files changed, 1814 insertions(+), 2 deletions(-) create mode 100644 schemas/2021-09-01-preview/Microsoft.Devices.json diff --git a/schemas/2021-07-01-preview/Microsoft.Devices.json b/schemas/2021-07-01-preview/Microsoft.Devices.json index 9deb94ca67..289dca9977 100644 --- a/schemas/2021-07-01-preview/Microsoft.Devices.json +++ b/schemas/2021-07-01-preview/Microsoft.Devices.json @@ -459,7 +459,8 @@ "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", "DigitalTwinChangeEvents", - "DeviceConnectionStateEvents" + "DeviceConnectionStateEvents", + "MqttBrokerMessages" ] }, { @@ -1228,7 +1229,8 @@ "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", "DigitalTwinChangeEvents", - "DeviceConnectionStateEvents" + "DeviceConnectionStateEvents", + "MqttBrokerMessages" ] }, { diff --git a/schemas/2021-09-01-preview/Microsoft.Devices.json b/schemas/2021-09-01-preview/Microsoft.Devices.json new file mode 100644 index 0000000000..8e61d063f9 --- /dev/null +++ b/schemas/2021-09-01-preview/Microsoft.Devices.json @@ -0,0 +1,1798 @@ +{ + "id": "https://schema.management.azure.com/schemas/2021-09-01-preview/Microsoft.Devices.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Devices", + "description": "Microsoft Devices Resource Types", + "resourceDefinitions": { + "IotHubs": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-09-01-preview" + ] + }, + "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." + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ArmIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "name": { + "type": "string", + "description": "The name of the IoT hub." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IotHubProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of an IoT hub." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/IotHubs_certificates_childResource" + }, + { + "$ref": "#/definitions/iotHubs_privateEndpointConnections_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/IotHubSkuInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Information about the SKU of the IoT hub." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource tags." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Devices/IotHubs" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "sku", + "type" + ], + "description": "Microsoft.Devices/IotHubs" + }, + "IotHubs_certificates": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-09-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the certificate" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The description of an X509 CA Certificate." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Devices/IotHubs/certificates" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Devices/IotHubs/certificates" + }, + "IotHubs_eventHubEndpoints_ConsumerGroups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-09-01-preview" + ] + }, + "name": { + "type": "string", + "description": "The name of the consumer group to add." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EventHubConsumerGroupName" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The EventHub consumer group name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups" + }, + "iotHubs_privateEndpointConnections": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-09-01-preview" + ] + }, + "name": { + "type": "string", + "description": "The name of the private endpoint connection" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of a private endpoint connection" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Devices/iotHubs/privateEndpointConnections" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Devices/iotHubs/privateEndpointConnections" + } + }, + "definitions": { + "ArmIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ArmUserIdentity" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + } + }, + "ArmUserIdentity": { + "type": "object", + "properties": {} + }, + "CertificateProperties": { + "type": "object", + "properties": { + "certificate": { + "type": "string", + "description": "The certificate content" + } + }, + "description": "The description of an X509 CA Certificate." + }, + "CloudToDeviceProperties": { + "type": "object", + "properties": { + "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": { + "oneOf": [ + { + "$ref": "#/definitions/FeedbackProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the feedback queue for cloud-to-device messages." + }, + "maxDeliveryCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + } + }, + "description": "The IoT hub cloud-to-device messaging properties." + }, + "EncryptionPropertiesDescription": { + "type": "object", + "properties": { + "keySource": { + "type": "string", + "description": "The source of the key." + }, + "keyVaultProperties": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultKeyProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the KeyVault key." + } + }, + "description": "The encryption properties for the IoT hub." + }, + "EnrichmentProperties": { + "type": "object", + "properties": { + "endpointNames": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of endpoints for which the enrichment is applied to the message." + }, + "key": { + "type": "string", + "description": "The key or name for the enrichment property." + }, + "value": { + "type": "string", + "description": "The value for the enrichment property." + } + }, + "required": [ + "endpointNames", + "key", + "value" + ], + "description": "The properties of an enrichment that your IoT hub applies to messages delivered to endpoints." + }, + "EventHubConsumerGroupName": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "EventHub consumer group name" + } + }, + "required": [ + "name" + ], + "description": "The EventHub consumer group name." + }, + "EventHubProperties": { + "type": "object", + "properties": { + "partitionCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "retentionTimeInDays": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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" + } + }, + "description": "The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub." + }, + "FallbackRouteProperties": { + "type": "object", + "properties": { + "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": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed." + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Used to specify whether the fallback route is enabled." + }, + "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": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents", + "DigitalTwinChangeEvents", + "DeviceConnectionStateEvents" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages." + } + }, + "required": [ + "endpointNames", + "isEnabled", + "source" + ], + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint." + }, + "FeedbackProperties": { + "type": "object", + "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." + }, + "maxDeliveryCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "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." + } + }, + "description": "The properties of the feedback queue for cloud-to-device messages." + }, + "IotHubProperties": { + "type": "object", + "properties": { + "allowedFqdnList": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub." + }, + "authorizationPolicies": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shared access policies you can use to secure a connection to the IoT hub." + }, + "cloudToDevice": { + "oneOf": [ + { + "$ref": "#/definitions/CloudToDeviceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IoT hub cloud-to-device messaging properties." + }, + "comments": { + "type": "string", + "description": "IoT hub comments." + }, + "deviceStreams": { + "oneOf": [ + { + "$ref": "#/definitions/IotHubPropertiesDeviceStreams" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The device streams properties of iothub." + }, + "disableDeviceSAS": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication." + }, + "disableLocalAuth": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication." + }, + "disableModuleSAS": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, all module scoped SAS keys cannot be used for authentication." + }, + "enableFileUploadNotifications": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If True, file upload notifications are enabled." + }, + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionPropertiesDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The encryption properties for the IoT hub." + }, + "eventHubEndpoints": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EventHubProperties" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "features": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "DeviceManagement" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The capabilities and features enabled for the IoT hub." + }, + "ipFilterRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IP filter rules." + }, + "messagingEndpoints": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MessagingEndpointProperties" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The messaging endpoint properties for the file upload notification queue." + }, + "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." + }, + "networkRuleSets": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Network Rule Set Properties of IotHub" + }, + "privateEndpointConnections": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Private endpoint connections created on this IotHub" + }, + "publicNetworkAccess": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether requests from Public Network are allowed." + }, + "restrictOutboundNetworkAccess": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList." + }, + "routing": { + "oneOf": [ + { + "$ref": "#/definitions/RoutingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging" + }, + "storageEndpoints": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StorageEndpointProperties" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + } + }, + "description": "The properties of an IoT hub." + }, + "IotHubPropertiesDeviceStreams": { + "type": "object", + "properties": { + "streamingEndpoints": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Device Streams Endpoints." + } + }, + "description": "The device streams properties of iothub." + }, + "IotHubSkuInfo": { + "type": "object", + "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits." + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "F1", + "S1", + "S2", + "S3", + "B1", + "B2", + "B3" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the SKU." + } + }, + "required": [ + "name" + ], + "description": "Information about the SKU of the IoT hub." + }, + "IotHubs_certificates_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-09-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the certificate" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The description of an X509 CA Certificate." + }, + "type": { + "type": "string", + "enum": [ + "certificates" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Devices/IotHubs/certificates" + }, + "iotHubs_privateEndpointConnections_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-09-01-preview" + ] + }, + "name": { + "type": "string", + "description": "The name of the private endpoint connection" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of a private endpoint connection" + }, + "type": { + "type": "string", + "enum": [ + "privateEndpointConnections" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Devices/iotHubs/privateEndpointConnections" + }, + "IpFilterRule": { + "type": "object", + "properties": { + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Accept", + "Reject" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The desired action for requests captured by this rule." + }, + "filterName": { + "type": "string", + "description": "The name of the IP filter rule." + }, + "ipMask": { + "type": "string", + "description": "A string that contains the IP address range in CIDR notation for the rule." + } + }, + "required": [ + "action", + "filterName", + "ipMask" + ], + "description": "The IP filter rules for the IoT hub." + }, + "KeyVaultKeyProperties": { + "type": "object", + "properties": { + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Managed identity." + }, + "keyIdentifier": { + "type": "string", + "description": "The identifier of the key." + } + }, + "description": "The properties of the KeyVault key." + }, + "ManagedIdentity": { + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity." + } + }, + "description": "The properties of the Managed identity." + }, + "MessagingEndpointProperties": { + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "type": "string", + "format": "duration", + "description": "The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload." + }, + "maxDeliveryCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "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." + } + }, + "description": "The properties of the messaging endpoints used by this IoT hub." + }, + "NetworkRuleSetIpRule": { + "type": "object", + "properties": { + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "IP Filter Action." + }, + "filterName": { + "type": "string", + "description": "Name of the IP filter rule." + }, + "ipMask": { + "type": "string", + "description": "A string that contains the IP address range in CIDR notation for the rule." + } + }, + "required": [ + "filterName", + "ipMask" + ], + "description": "IP Rule to be applied as part of Network Rule Set" + }, + "NetworkRuleSetProperties": { + "type": "object", + "properties": { + "applyToBuiltInEventHubEndpoint": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub" + }, + "defaultAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Deny", + "Allow" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default Action for Network Rule Set." + }, + "ipRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSetIpRule" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of IP Rules" + } + }, + "required": [ + "applyToBuiltInEventHubEndpoint", + "ipRules" + ], + "description": "Network Rule Set Properties of IotHub" + }, + "PrivateEndpoint": { + "type": "object", + "properties": {}, + "description": "The private endpoint property of a private endpoint connection" + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of a private endpoint connection" + } + }, + "required": [ + "properties" + ], + "description": "The private endpoint connection of an IotHub" + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpoint" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The private endpoint property of a private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The current state of a private endpoint connection" + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "The properties of a private endpoint connection" + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The status of a private endpoint connection." + } + }, + "required": [ + "description", + "status" + ], + "description": "The current state of a private endpoint connection" + }, + "RouteProperties": { + "type": "object", + "properties": { + "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": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed." + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Used to specify whether a route is enabled." + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents", + "DigitalTwinChangeEvents", + "DeviceConnectionStateEvents" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source that the routing rule is to be applied to, such as DeviceMessages." + } + }, + "required": [ + "endpointNames", + "isEnabled", + "name", + "source" + ], + "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints." + }, + "RoutingEndpoints": { + "type": "object", + "properties": { + "eventHubs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingEventHubProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "serviceBusQueues": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusQueueEndpointProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules." + }, + "serviceBusTopics": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusTopicEndpointProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules." + }, + "storageContainers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingStorageContainerProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules." + } + }, + "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." + }, + "RoutingEventHubProperties": { + "type": "object", + "properties": { + "authenticationType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "keyBased", + "identityBased" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Method used to authenticate against the event hub endpoint." + }, + "connectionString": { + "type": "string", + "description": "The connection string of the event hub endpoint. " + }, + "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" + }, + "id": { + "type": "string", + "description": "Id of the event hub endpoint" + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Managed identity." + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "resourceGroup": { + "type": "string", + "description": "The name of the resource group of the event hub endpoint." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription identifier of the event hub endpoint." + } + }, + "required": [ + "name" + ], + "description": "The properties related to an event hub endpoint." + }, + "RoutingProperties": { + "type": "object", + "properties": { + "endpoints": { + "oneOf": [ + { + "$ref": "#/definitions/RoutingEndpoints" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "enrichments": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EnrichmentProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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" + }, + "fallbackRoute": { + "oneOf": [ + { + "$ref": "#/definitions/FallbackRouteProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint." + }, + "routes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RouteProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + } + }, + "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging" + }, + "RoutingServiceBusQueueEndpointProperties": { + "type": "object", + "properties": { + "authenticationType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "keyBased", + "identityBased" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Method used to authenticate against the service bus queue endpoint." + }, + "connectionString": { + "type": "string", + "description": "The connection string of the service bus queue endpoint." + }, + "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" + }, + "id": { + "type": "string", + "description": "Id of the service bus queue endpoint" + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Managed identity." + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "resourceGroup": { + "type": "string", + "description": "The name of the resource group of the service bus queue endpoint." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription identifier of the service bus queue endpoint." + } + }, + "required": [ + "name" + ], + "description": "The properties related to service bus queue endpoint types." + }, + "RoutingServiceBusTopicEndpointProperties": { + "type": "object", + "properties": { + "authenticationType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "keyBased", + "identityBased" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Method used to authenticate against the service bus topic endpoint." + }, + "connectionString": { + "type": "string", + "description": "The connection string of the service bus topic endpoint." + }, + "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" + }, + "id": { + "type": "string", + "description": "Id of the service bus topic endpoint" + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Managed identity." + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "resourceGroup": { + "type": "string", + "description": "The name of the resource group of the service bus topic endpoint." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription identifier of the service bus topic endpoint." + } + }, + "required": [ + "name" + ], + "description": "The properties related to service bus topic endpoint types." + }, + "RoutingStorageContainerProperties": { + "type": "object", + "properties": { + "authenticationType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "keyBased", + "identityBased" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Method used to authenticate against the storage endpoint." + }, + "batchFrequencyInSeconds": { + "oneOf": [ + { + "type": "integer", + "minimum": 60, + "maximum": 720 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds." + }, + "connectionString": { + "type": "string", + "description": "The connection string of the storage account." + }, + "containerName": { + "type": "string", + "description": "The name of storage container in the storage account." + }, + "encoding": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Avro", + "AvroDeflate", + "JSON" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'." + }, + "endpointUri": { + "type": "string", + "description": "The url of the storage endpoint. It must include the protocol https://" + }, + "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." + }, + "id": { + "type": "string", + "description": "Id of the storage container endpoint" + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Managed identity." + }, + "maxChunkSizeInBytes": { + "oneOf": [ + { + "type": "integer", + "minimum": 10485760, + "maximum": 524288000 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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)." + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "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." + }, + "resourceGroup": { + "type": "string", + "description": "The name of the resource group of the storage account." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription identifier of the storage account." + } + }, + "required": [ + "containerName", + "name" + ], + "description": "The properties related to a storage container endpoint." + }, + "SharedAccessSignatureAuthorizationRule": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "The name of the shared access policy." + }, + "primaryKey": { + "type": "string", + "description": "The primary key." + }, + "rights": { + "oneOf": [ + { + "type": "string", + "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" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The permissions assigned to the shared access policy." + }, + "secondaryKey": { + "type": "string", + "description": "The secondary key." + } + }, + "required": [ + "keyName", + "rights" + ], + "description": "The properties of an IoT hub shared access policy." + }, + "StorageEndpointProperties": { + "type": "object", + "properties": { + "authenticationType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "keyBased", + "identityBased" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies authentication type being used for connecting to the storage account." + }, + "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." + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Managed identity." + }, + "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." + } + }, + "required": [ + "connectionString", + "containerName" + ], + "description": "The properties of the Azure Storage endpoint for file upload." + } + } +} \ No newline at end of file diff --git a/schemas/common/autogeneratedResources.json b/schemas/common/autogeneratedResources.json index b5839ad970..738f393a77 100644 --- a/schemas/common/autogeneratedResources.json +++ b/schemas/common/autogeneratedResources.json @@ -4285,6 +4285,18 @@ { "$ref": "https://schema.management.azure.com/schemas/2021-07-01-preview/Microsoft.Devices.json#/resourceDefinitions/iotHubs_privateEndpointConnections" }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-09-01-preview/Microsoft.Devices.json#/resourceDefinitions/IotHubs" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-09-01-preview/Microsoft.Devices.json#/resourceDefinitions/IotHubs_certificates" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-09-01-preview/Microsoft.Devices.json#/resourceDefinitions/IotHubs_eventHubEndpoints_ConsumerGroups" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-09-01-preview/Microsoft.Devices.json#/resourceDefinitions/iotHubs_privateEndpointConnections" + }, { "$ref": "https://schema.management.azure.com/schemas/2017-08-21-preview/Microsoft.Devices.Provisioning.json#/resourceDefinitions/provisioningServices" },