Microsoft Azure GET API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GET API
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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      responses:
        '200':
          description: The body contains all the non-security properties of the IoT hub. Security-related properties are set to null.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IotHubDescription'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IotHubDescriptionListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IotHubDescriptionListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      responses:
        '200':
          description: This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryStatistics'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IotHubSkuDescriptionListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - name: eventHubEndpointName
        in: path
        description: The name of the Event Hub-compatible endpoint.
        required: true
        schema:
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConsumerGroupsListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - name: eventHubEndpointName
        in: path
        description: The name of the Event Hub-compatible endpoint in the IoT hub.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the consumer group to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized consumer group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventHubConsumerGroupInfo'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponseListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - name: jobId
        in: path
        description: The job identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IotHubQuotaMetricInfoListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        schema:
          type: string
      - name: iotHubName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointHealthDataListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSubscriptionQuotaListResult'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      responses:
        '200':
          description: The body contains the list of private link resources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateLinkResources'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - $ref: '#/components/parameters/groupId'
      responses:
        '200':
          description: The body contains the specified of private link resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupIdInformation'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      responses:
        '200':
          description: The body contains the list of private endpoint connection properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnectionsList'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/api-version'
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/resourceName'
      - $ref: '#/components/parameters/privateEndpointConnectionName'
      responses:
        '200':
          description: The body contains the private endpoint connection properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      deprecated: false
  /enrollments/{id}:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get A Device Enrollment Record
      operationId: microsoftAzureIndividualenrollmentGet
      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
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndividualEnrollment'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
  /enrollmentGroups/{id}:
    get:
      tags:
      - GET
      summary: Microsoft Azure Get A Device Enrollment Group
      operationId: microsoftAzureEnrollmentgroupGet
      parameters:
      - name: id
        in: path
        description: Enrollment group ID.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentGroup'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
  /registrations/{id}:
    get:
      tags:
      - GET
      summary: Microsoft Azure Gets The Device Registration State
      operationId: microsoftAzureDeviceregistrationstateGet
      parameters:
      - name: id
        in: path
        description: Registration ID.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceRegistrationState'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
components:
  schemas:
    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: '#/components/schemas/GroupIdInformation'
    EndpointHealthDataListResult:
      description: The JSON-serialized array of EndpointHealthData objects with a next link.
      type: object
      properties:
        value:
          description: JSON-serialized array of Endpoint health data
          type: array
          items:
            $ref: '#/components/schemas/EndpointHealthData'
        nextLink:
          description: Link to more results
          type: string
          readOnly: true
    GroupIdInformation:
      description: The group information for creating a private endpoint on an IotHub
      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: '#/components/schemas/GroupIdInformationProperties'
      required:
      - properties
    DeviceRegistrationState:
      description: Device registration state.
      type: object
      properties:
        registrationId:
          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.'
          type: string
          readOnly: true
        createdDateTimeUtc:
          format: date-time
          description: Registration create date time (in UTC).
          type: string
          readOnly: true
        assignedHub:
          description: Assigned Azure IoT Hub.
          type: string
          readOnly: true
        deviceId:
          description: Device ID.
          type: string
          readOnly: true
        status:
          description: Enrollment status.
          enum:
          - unassigned
          - assigning
          - assigned
          - failed
          - disabled
          type: string
          readOnly: true
        substatus:
          description: 'Substatus for ''Assigned'' devices. Possible values include - ''initialAssignment'': Device has been assigned to an IoT hub for the first time, ''deviceDataMigrated'': Device has been assigned to a different IoT hub and its device data was migrated from the previously assigned IoT hub. Device data was removed from the previously assigned IoT hub, ''deviceDataReset'':  Device has been assigned to a different IoT hub and its device data was populated from the initial state stored in the enrollment. Device data was removed from the previously assigned IoT hub, ''reprovisionedToInitialAssignment'': Device has been re-provisioned to a previously assigned IoT hub.'
          enum:
          - initialAssignment
          - deviceDataMigrated
          - deviceDataReset
          - reprovisionedToInitialAssignment
          type: string
          readOnly: true
        errorCode:
          format: int32
          description: Error code.
          type: integer
          readOnly: true
        errorMessage:
          description: Error message.
          type: string
          readOnly: true
        lastUpdatedDateTimeUtc:
          format: date-time
          description: Last updated date time (in UTC).
          type: string
          readOnly: true
        etag:
          description: The entity tag associated with the resource.
          type: string
          readOnly: true
        payload:
          description: Custom allocation payload returned from the webhook to the device.
          type: object
          readOnly: true
    RoutingServiceBusQueueEndpointProperties:
      description: The properties related to service bus queue endpoint types.
      type: object
      properties:
        id:
          description: Id of the service bus queue endpoint
          type: string
        connectionString:
          description: The connection string of the service bus queue endpoint.
          type: string
        endpointUri:
          description: The url of the service bus queue endpoint. It must include the protocol sb://
          type: string
        entityPath:
          description: Queue name on the service bus namespace
          type: string
        authenticationType:
          description: Method used to authenticate against the service bus queue endpoint
          enum:
          - keyBased
          - identityBased
          type: string
          x-ms-enum:
            name: authenticationType
            modelAsString: true
        identity:
          description: Managed identity properties of routing service bus queue endpoint.
          $ref: '#/components/schemas/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. The name need not be the same as the actual queue name.'
          type: string
          pattern: ^[A-Za-z0-9-._]{1,64}$
        subscriptionId:
          description: The subscription identifier of the service bus queue endpoint.
          type: string
        resourceGroup:
          description: The name of the resource group of the service bus queue endpoint.
          type: string
      required:
      - name
    PrivateLinkServiceConnectionState:
      description: The current state of a private endpoint connection
      type: object
      properties:
        status:
          description: The status of a private endpoint connection
          enum:
          - Pending
          - Approved
          - Rejected
          - Disconnected
          type: string
          x-ms-enum:
            name: PrivateLinkServiceConnectionStatus
            modelAsString: true
        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
    GroupIdInformationProperties:
      description: The properties for a group information object
      type: object
      properties:
        groupId:
          type: string
          description: The group id
        requiredMembers:
          description: The required members for a specific group id
          type: array
          items:
            type: string
        requiredZoneNames:
          description: The required DNS zones for a specific group id
          type: array
          items:
            type: string
    ErrorDetails:
      description: Error details.
      type: object
      properties:
        code:
          description: The error code.
          type: string
          readOnly: true
        httpStatusCode:
          description: The HTTP status code.
          type: string
          readOnly: true
        message:
          description: The error message.
          type: string
          readOnly: true
        details:
          description: The error details.
          type: string
          readOnly: true
    IotHubDescriptionListResult:
      description: The JSON-serialized array of IotHubDescription objects with a next link.
      type: object
      properties:
        value:
          description: The array of IotHubDescription objects.
          type: array
          items:
            $ref: '#/components/schemas/IotHubDescription'
        nextLink:
          description: The next link.
          type: string
          readOnly: true
    UserSubscriptionQuota:
      description: User subscription quot

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