Microsoft Azure GET API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GET API
schemes:
- https
tags:
- name: GET
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get The Non Security Related Metadata Of An Iot Hub
      description: Get the non-security related metadata of an IoT hub.
      operationId: microsoftAzureIothubresourceGet
      x-ms-examples:
        IotHubResource_Get:
          $ref: ./examples/iothub_get.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: The body contains all the non-security properties of the IoT hub. Security-related properties are set to null.
          schema:
            $ref: '#/definitions/IotHubDescription'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get All The Iot Hubs In A Subscription
      description: Get all the IoT hubs in a subscription.
      operationId: microsoftAzureIothubresourceListbysubscription
      x-ms-examples:
        IotHubResource_ListBySubscription:
          $ref: ./examples/iothub_listbysubscription.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the subscription.
          schema:
            $ref: '#/definitions/IotHubDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get All The Iot Hubs In A Resource Group
      description: Get all the IoT hubs in a resource group.
      operationId: microsoftAzureIothubresourceListbyresourcegroup
      x-ms-examples:
        IotHubResource_ListByResourceGroup:
          $ref: ./examples/iothub_listbyrg.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the resource group.
          schema:
            $ref: '#/definitions/IotHubDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats
  : get:
      tags:
      - GET
      summary: Microsoft Azure Get The Statistics From An Iot Hub
      description: Get the statistics from an IoT hub.
      operationId: microsoftAzureIothubresourceGetstats
      x-ms-examples:
        IotHubResource_GetStats:
          $ref: ./examples/iothub_stats.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.
          schema:
            $ref: '#/definitions/RegistryStatistics'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get The List Of Valid Skus For An Iot Hub
      description: Get the list of valid SKUs for an IoT hub.
      operationId: microsoftAzureIothubresourceGetvalidskus
      x-ms-examples:
        IotHubResource_GetValidSkus:
          $ref: ./examples/iothub_getskus.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this IoT hub.
          schema:
            $ref: '#/definitions/IotHubSkuDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups
  : get:
      tags:
      - GET
      summary: Microsoft Azure 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.
      operationId: microsoftAzureIothubresourceListeventhubconsumergroups
      x-ms-examples:
        IotHubResource_ListEventHubConsumerGroups:
          $ref: ./examples/iothub_listehgroups.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - name: eventHubEndpointName
        in: path
        description: The name of the Event Hub-compatible endpoint.
        required: true
        type: string
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub
          schema:
            $ref: '#/definitions/EventHubConsumerGroupsListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
  : get:
      tags:
      - GET
      summary: Microsoft Azure 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.
      operationId: microsoftAzureIothubresourceGeteventhubconsumergroup
      x-ms-examples:
        IotHubResource_ListEventHubConsumerGroups:
          $ref: ./examples/iothub_getconsumergroup.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - name: eventHubEndpointName
        in: path
        description: The name of the Event Hub-compatible endpoint in the IoT hub.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the consumer group to retrieve.
        required: true
        type: string
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized consumer group.
          schema:
            $ref: '#/definitions/EventHubConsumerGroupInfo'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs:
    get:
      tags:
      - GET
      summary: 'Microsoft Azure 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.'
      operationId: microsoftAzureIothubresourceListjobs
      x-ms-examples:
        IotHubResource_ListJobs:
          $ref: ./examples/iothub_listjobs.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: This is a synchronous operation. The response contains a JSON-serialized array of all the jobs in the IoT hub.
          schema:
            $ref: '#/definitions/JobResponseListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}
  : get:
      tags:
      - GET
      summary: 'Microsoft Azure 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.'
      operationId: microsoftAzureIothubresourceGetjob
      x-ms-examples:
        IotHubResource_GetJob:
          $ref: ./examples/iothub_getjob.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - name: jobId
        in: path
        description: The job identifier.
        required: true
        type: string
      responses:
        '200':
          description: This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.
          schema:
            $ref: '#/definitions/JobResponse'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics
  : get:
      tags:
      - GET
      summary: Microsoft Azure Get The Quota Metrics For An Iot Hub
      description: Get the quota metrics for an IoT hub.
      operationId: microsoftAzureIothubresourceGetquotametrics
      x-ms-examples:
        IotHubResource_GetQuotaMetrics:
          $ref: ./examples/iothub_quotametrics.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: This is a synchronous operation. The response contains a JSON-serialized array of the quota metrics for the IoT hub.
          schema:
            $ref: '#/definitions/IotHubQuotaMetricInfoListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth
  : get:
      tags:
      - GET
      operationId: microsoftAzureIothubresourceGetendpointhealth
      summary: Microsoft Azure Get The Health For Routing Endpoints
      description: Get the health for routing endpoints.
      x-ms-examples:
        IotHubResource_GetEndpointHealth:
          $ref: ./examples/iothub_routingendpointhealth.json
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        type: string
      - name: iotHubName
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/EndpointHealthDataListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get The Number Of Iot Hubs In The Subscription
      description: Get the number of free and paid iot hubs in the subscription
      operationId: microsoftAzureResourceprovidercommonGetsubscriptionquota
      x-ms-examples:
        ResourceProviderCommon_GetSubscriptionQuota:
          $ref: ./examples/iothub_usages.json
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/UserSubscriptionQuotaListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources
  : get:
      tags:
      - GET
      summary: Microsoft Azure List Private Link Resources
      description: List private link resources for the given IotHub
      operationId: microsoftAzurePrivatelinkresourcesList
      x-ms-examples:
        PrivateLinkResources_List:
          $ref: ./examples/iothub_listprivatelinkresources.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: The body contains the list of private link resources
          schema:
            $ref: '#/definitions/PrivateLinkResources'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}
  : get:
      tags:
      - GET
      summary: Microsoft Azure Get The Specified Private Link Resource
      description: Get the specified private link resource for the given IotHub
      operationId: microsoftAzurePrivatelinkresourcesGet
      x-ms-examples:
        PrivateLinkResources_List:
          $ref: ./examples/iothub_getprivatelinkresources.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - $ref: '#/parameters/groupId'
      responses:
        '200':
          description: The body contains the specified of private link resource
          schema:
            $ref: '#/definitions/GroupIdInformation'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections
  : get:
      tags:
      - GET
      summary: Microsoft Azure List Private Endpoint Connections
      description: List private endpoint connection properties
      operationId: microsoftAzurePrivateendpointconnectionsList
      x-ms-examples:
        PrivateEndpointConnections_List:
          $ref: ./examples/iothub_listprivateendpointconnections.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      responses:
        '200':
          description: The body contains the list of private endpoint connection properties
          schema:
            $ref: '#/definitions/PrivateEndpointConnectionsList'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  : get:
      tags:
      - GET
      summary: Microsoft Azure Get Private Endpoint Connection
      description: Get private endpoint connection properties
      operationId: microsoftAzurePrivateendpointconnectionsGet
      x-ms-examples:
        PrivateEndpointConnection_Get:
          $ref: ./examples/iothub_getprivateendpointconnection.json
      parameters:
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/resourceName'
      - $ref: '#/parameters/privateEndpointConnectionName'
      responses:
        '200':
          description: The body contains the private endpoint connection properties
          schema:
            $ref: '#/definitions/PrivateEndpointConnection'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
  /enrollments/{id}:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get A Device Enrollment Record
      operationId: microsoftAzureIndividualenrollmentGet
      consumes: []
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: 'This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.'
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/IndividualEnrollment'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/ProvisioningServiceErrorDetails'
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      description: Needs a more full description created.
  /enrollmentGroups/{id}:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get A Device Enrollment Group
      operationId: microsoftAzureEnrollmentgroupGet
      consumes: []
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Enrollment group ID.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EnrollmentGroup'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/ProvisioningServiceErrorDetails'
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      description: Needs a more full description created.
  /registrations/{id}:
    get:
      tags:
      - GET
      summary: Microsoft Azure Gets The Device Registration State
      operationId: microsoftAzureDeviceregistrationstateGet
      consumes: []
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Registration ID.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceRegistrationState'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/ProvisioningServiceErrorDetails'
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      description: Needs a more full description created.
definitions:
  ArmIdentity:
    type: object
    properties:
      principalId:
        description: Principal Id
        type: string
        readOnly: true
      tenantId:
        description: Tenant Id
        type: string
        readOnly: true
      type:
        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.
        type: string
        enum:
        - SystemAssigned
        - UserAssigned
        - SystemAssigned, UserAssigned
        - None
        x-ms-enum:
          name: ResourceIdentityType
          modelAsString: false
      userAssignedIdentities:
        type: object
        additionalProperties:
          $ref: '#/definitions/ArmUserIdentity'
  InitialTwin:
    description: Initial device twin. Contains a subset of the properties of Twin.
    type: object
    properties:
      tags:
        $ref: '#/definitions/TwinCollection'
        description: Twin tags.
      properties:
        $ref: '#/definitions/InitialTwinProperties'
        description: Twin desired properties.
  ReprovisionPolicy:
    description: The behavior of the service when a device is re-provisioned to an IoT hub.
    required:
    - updateHubAssignment
    - migrateDeviceData
    type: object
    properties:
      updateHubAssignment:
        description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub.
        default: true
        type: boolean
      migrateDeviceData:
        description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list.
        default: true
        type: boolean
  EndpointHealthData:
    description: The health data for an endpoint
    type: object
    properties:
      endpointId:
        description: Id of the endpoint
        type: string
      healthStatus:
        description: Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint
        enum:
        - unknown
        - healthy
        - degraded
        - unhealthy
        - dead
        type: string
        x-ms-enum:
          name: EndpointHealthStatus
          modelAsString: true
      lastKnownError:
        description: Last error obtained when a message failed to be delivered to iot hub
        type: string
      lastKnownErrorTime:
        description: Time at which the last known error occurred
        type: string
        format: date-time-rfc1123
      lastSuccessfulSendAttemptTime:
        description: Last time iot hub successfully sent a message to the endpoint
        type: string
        format: date-time-rfc1123
      lastSendAttemptTime:
        description: Last time iot hub tried to send a message to the endpoint
        type: string
        format: date-time-rfc1123
  IotHubLocationDescription:
    description: Public representation of one of the locations where a resource is provisioned.
    type: object
    properties:
      location:
        description: The name of the Azure region
        type: string
      role:
        description: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.
        enum:
        - primary
        - secondary
        type: string
        x-ms-enum:
          name: IotHubReplicaRoleType
          modelAsString: true
  RoutingStorageContainerProperties:
    description: The properties related to a storage container endpoint.
    type: object
    properties:
      id:
        description: Id of the storage container endpoint
        type: string
      connectionString:
        description: The connection string of the storage account.
        type: string
      endpointUri:
        description: The url of the storage endpoint. It must include the protocol https://
        type: string
      authenticationType:
        description: Method used to authenticate against the storage endpoint
        enum:
        - keyBased
        - identityBased
        type: string
        x-ms-enum:
          name: authenticationType
          modelAsString: true
      identity:
        description: Managed identity properties of routing storage endpoint.
        $ref: '#/definitions/ManagedIdentity'
      name:
        description: 'The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved:  events, fileNotifications, $default. Endpoint names must be unique across endpoint types.'
        type: string
        pattern: ^[A-Za-z0-9-._]{1,64}$
      subscriptionId:
        description: The subscription identifier of the storage account.
        type: string
      resourceGroup:
        description: The name of the resource group of the storage account.
        type: string
      containerName:
        description: The name of storage container in the storage account.
        type: string
      fileNameFormat:
        description: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
        type: string
      batchFrequencyInSeconds:
        description: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
        format: int32
        type: integer
        maximum: 720
        minimum: 60
      maxChunkSizeInBytes:
        description: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
        format: int32
        type: integer
        maximum: 524288000
        minimum: 10485760
      encoding:
        description: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.
        type: string
        enum:
        - Avro
        - AvroDeflate
        - JSON
    required:
    - name
    - containerName
  PrivateEndpointConnection:
    description: The private endpoint connection of an IotHub
    x-ms-azure-resource: true
    type: object
    properties:
      id:
        readOnly: true
        type: string
        description: The resource identifier.
      name:
        readOnly: true
        type: string
        description: The resource name.
      type:
        readOnly: true
        type: string
        description: The resource type.
      properties:
        $ref: '#/definitions/PrivateEndpointConnectionProperties'
    required:
    - properties
  CustomAllocationDefinition:
    description: This tells DPS which webhook to call when using custom allocation.
    required:
    - webhookUrl
    - apiVersion
    type: object
    properties:
      webhookUrl:
        description: The webhook URL used for allocation requests.
        type: string
      apiVersion:
        description: 'The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview".'
        type: string
  PrivateLinkResources:
    description: The available private link resources for an IotHub
    type: object
    properties:
      value:
        description: The list of available private link resources for an IotHub
        type: array
        items:
          $ref: '#/definitions/GroupIdInformation'
  StorageEndpointProperties:
    description: The properties of the Azure Storage endpoint for file upload.
    type: object
    properties:
      sasTtlAsIso8601:
        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.'
        type: string
        format: duration
      connectionString:
        description: The connection string for the Azure Storage account to which files are uploaded.
        type: string
      containerName:
        description: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
        type: string
      authenticationType:
        description: Specifies authentication type being used for connecting to the storage account.
        enum:
        - keyBased
        - identityBased
        type: string
        x-ms-enum:
          name: AuthenticationType
          modelAsString: true
      identity:
        description: Managed identity properties of storage endpoint for file upload.
        $ref: '#/definitions/ManagedIdentity'
    required:
    - connectionString
    - containerName
  IpFilterRule:
    description: The IP filter rules for the IoT hub.
    type: object
    properties:
      filterName:
        description: The name of the IP filter rule.
        type: string
      action:
        description: The desired action for requests captured by this rule.
        enum:
        - Accept
        - Reject
        type: string
        x-ms-enum:
          name: IpFilterActionType
          modelAsString: false
      ipMask:
        description: A string that contains the IP address range in CIDR notation for the rule.
        type: string
    required:
    - filterName
    - action
    - ipMask
  InitialTwinProperties:
    description: Represents the initial properties that will be set on the device twin.
    type: object
    properties:
      desired:
        $ref: '#/definitions/TwinCollection'
        description: Gets and sets the InitialTwin desired properties.
  RouteProperties:
    description: The properties of a routing rule that your IoT hub uses to route messages to endpoints.
    type: object
    properties:
      name:
        description: The name of the route. The name can only include alphanumeric c

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-get-api-openapi.yml