Microsoft Azure IotDpsResource API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Iot Dps Resource API
tags:
- name: IotDpsResource
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}
  : get:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Get The Non Security Related Metadata Of The Provisioning Service
      description: Get the metadata of the provisioning service without SAS keys.
      operationId: microsoftAzureIotdpsresourceGet
      x-ms-examples:
        DPSGet:
          $ref: ./examples/DPSGet.json
      parameters:
      - name: provisioningServiceName
        in: path
        required: true
        description: Name of the provisioning service to retrieve.
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: Resource group name.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Provisioning service description with no keys is included in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceDescription'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
    put:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Create Or Update The Metadata Of The Provisioning Service
      description: Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.
      x-ms-long-running-operation: true
      operationId: microsoftAzureIotdpsresourceCreateorupdate
      x-ms-examples:
        DPSCreate:
          $ref: ./examples/DPSCreate.json
        DPSUpdate:
          $ref: ./examples/DPSUpdate.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: Resource group identifier.
        schema:
          type: string
      - name: provisioningServiceName
        in: path
        required: true
        description: Name of provisioning service to create or update.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: The body contains all the non-security properties of the provisioning service. Security-related properties are set to null.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceDescription'
        '201':
          description: This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceDescription'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisioningServiceDescription'
        description: Description of the provisioning service to create or update.
        required: true
    patch:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Update An Existing Provisioning Service S Tags
      description: Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
      x-ms-long-running-operation: true
      operationId: microsoftAzureIotdpsresourceUpdate
      x-ms-examples:
        DPSPatch:
          $ref: ./examples/DPSPatch.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: Resource group identifier.
        schema:
          type: string
      - name: provisioningServiceName
        in: path
        required: true
        description: Name of provisioning service to create or update.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Provisioning Service was successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceDescription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsResource'
        description: Updated tag information to set into the provisioning service instance.
        required: true
    delete:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Delete The Provisioning Service
      description: Deletes the Provisioning Service.
      x-ms-long-running-operation: true
      operationId: microsoftAzureIotdpsresourceDelete
      x-ms-examples:
        DPSDelete:
          $ref: ./examples/DPSDelete.json
      parameters:
      - name: provisioningServiceName
        in: path
        required: true
        description: Name of provisioning service to delete.
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: Resource group identifier.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.
        '202':
          description: The provisioning service resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the provisioning service status directly, or query the operation resource.
        '204':
          description: Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the provisioning service metadata in the service and the status of the delete operation is set to a completed state.
        '404':
          description: After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the provisioning service metadata in the service.
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices:
    get:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Get All The Provisioning Services In A Subscription
      description: List all the provisioning services for a given subscription id.
      operationId: microsoftAzureIotdpsresourceListbysubscription
      x-ms-examples:
        DPSListBySubscription:
          $ref: ./examples/DPSListBySubscription.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the provisioning services in the subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceDescriptionListResult'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices:
    get:
      tags:
      - IotDpsResource
      operationId: microsoftAzureIotdpsresourceListbyresourcegroup
      description: Get a list of all provisioning services in the given resource group.
      x-ms-examples:
        DPSListByResourceGroup:
          $ref: ./examples/DPSListByResourceGroup.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: Resource group identifier.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: List of provisioning services in the resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceDescriptionListResult'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devices Provisioningservices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}
  : get:
      tags:
      - IotDpsResource
      operationId: microsoftAzureIotdpsresourceGetoperationresult
      description: Gets the status of a long running operation, such as create, update or delete a provisioning service.
      x-ms-examples:
        DPSGetOperationResult:
          $ref: ./examples/DPSGetOperationResult.json
      parameters:
      - name: operationId
        in: path
        required: true
        description: Operation id corresponding to long running operation. Use this to poll for the status.
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: Resource group identifier.
        schema:
          type: string
      - name: provisioningServiceName
        in: path
        required: true
        description: Name of provisioning service that the operation is running on.
        schema:
          type: string
      - name: asyncinfo
        in: query
        description: Async header used to poll on the status of the operation, obtained while creating the long running operation.
        required: true
        schema:
          type: string
          default: 'true'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: The status of the long running operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResult'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devices Provisioningservices Provisioningservicename Operationresults Operationid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus
  : get:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Get The List Of Valid Skus For A Provisioning Service
      description: Gets the list of valid SKUs and tiers for a provisioning service.
      operationId: microsoftAzureIotdpsresourceListvalidskus
      x-ms-examples:
        DPSGetValidSku:
          $ref: ./examples/DPSGetValidSku.json
      parameters:
      - name: provisioningServiceName
        in: path
        required: true
        description: Name of provisioning service.
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: Name of resource group.
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this provisioning service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IotDpsSkuDefinitionListResult'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability:
    post:
      tags:
      - IotDpsResource
      operationId: microsoftAzureIotdpsresourceCheckprovisioningservicenameavailability
      x-ms-examples:
        DPSCheckName:
          $ref: ./examples/DPSCheckNameAvailability.json
      summary: Microsoft Azure Check If A Provisioning Service Name Is Available
      description: Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the provisioning service name is available. If the name is not available, the body contains the reason.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NameAvailabilityInfo'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationInputs'
        description: Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys
  : post:
      tags:
      - IotDpsResource
      operationId: microsoftAzureIotdpsresourceListkeys
      x-ms-examples:
        DPSListKeys:
          $ref: ./examples/DPSListKeys.json
      summary: Microsoft Azure Get The Security Metadata For A Provisioning Service
      description: List the primary and secondary keys for a provisioning service.
      parameters:
      - name: provisioningServiceName
        in: path
        required: true
        description: The provisioning service name to get the shared access keys for.
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        in: path
        required: true
        description: resource group name
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the provisioning service endpoints.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedAccessSignatureAuthorizationRuleListResult'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys
  : post:
      tags:
      - IotDpsResource
      operationId: microsoftAzureIotdpsresourceListkeysforkeyname
      x-ms-examples:
        DPSGetKey:
          $ref: ./examples/DPSGetKey.json
      summary: Microsoft Azure Get A Shared Access Policy By Name From A Provisioning Service
      description: List primary and secondary keys for a specific key name
      parameters:
      - name: provisioningServiceName
        in: path
        required: true
        description: Name of the provisioning service.
        schema:
          type: string
      - name: keyName
        in: path
        required: true
        description: Logical key name to get key-values for.
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The name of the resource group that contains the provisioning service.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more provisioning service endpoints.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedAccessSignatureAuthorizationRule_AccessRightsDescription'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources
  : get:
      tags:
      - IotDpsResource
      summary: Microsoft Azure List Private Link Resources
      description: List private link resources for the given provisioning service
      operationId: microsoftAzureIotdpsresourceListprivatelinkresources
      x-ms-examples:
        PrivateLinkResources_List:
          $ref: ./examples/DPSListPrivateLinkResources.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/provisioningServices/{resourceName}/privateLinkResources/{groupId}
  : get:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Get The Specified Private Link Resource
      description: Get the specified private link resource for the given provisioning service
      operationId: microsoftAzureIotdpsresourceGetprivatelinkresources
      x-ms-examples:
        PrivateLinkResources_List:
          $ref: ./examples/DPSGetPrivateLinkResources.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/provisioningServices/{resourceName}/privateEndpointConnections
  : get:
      tags:
      - IotDpsResource
      summary: Microsoft Azure List Private Endpoint Connections
      description: List private endpoint connection properties
      operationId: microsoftAzureIotdpsresourceListprivateendpointconnections
      x-ms-examples:
        PrivateEndpointConnections_List:
          $ref: ./examples/DPSListPrivateEndpointConnections.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/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  : get:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Get Private Endpoint Connection
      description: Get private endpoint connection properties
      operationId: microsoftAzureIotdpsresourceGetprivateendpointconnection
      x-ms-examples:
        PrivateEndpointConnection_Get:
          $ref: ./examples/DPSGetPrivateEndpointConnection.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
    put:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Create Or Update Private Endpoint Connection
      description: Create or update the status of a private endpoint connection with the specified name
      operationId: microsoftAzureIotdpsresourceCreateorupdateprivateendpointconnection
      x-ms-examples:
        PrivateEndpointConnection_CreateOrUpdate:
          $ref: ./examples/DPSCreateOrUpdatePrivateEndpointConnection.json
      x-ms-long-running-operation: true
      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: This is returned as a response to the status polling request for the update operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        '201':
          description: This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrivateEndpointConnection'
        description: The private endpoint connection with updated properties
        required: true
    delete:
      tags:
      - IotDpsResource
      summary: Microsoft Azure Delete Private Endpoint Connection
      description: Delete private endpoint connection with the specified name
      operationId: microsoftAzureIotdpsresourceDeleteprivateendpointconnection
      x-ms-examples:
        PrivateEndpointConnection_Delete:
          $ref: ./examples/DPSDeletePrivateEndpointConnection.json
      x-ms-long-running-operation: true
      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: This is returned as a response to the status polling request for the delete operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        '202':
          description: This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.
          headers:
            Azure-AsyncOperation:
              description: Operation Status Location URI
              schema:
                type: string
            Location:
              description: Operation Status Location URI
              schema:
                type: string
            Retry-After:
              description: Retry After
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointConnection'
        '204':
          description: PrivateEndpoint does not exist.
        default:
          description: DefaultErrorResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      deprecated: false
components:
  schemas:
    PrivateEndpointConnectionProperties:
      description: The properties of a private endpoint connection
      type: object
      properties:
        privateEndpoint:
          description: The private endpoint property of a private endpoint connection
          $ref: '#/components/schemas/PrivateEndpoint'
        privateLinkServiceConnectionState:
          description: The current state of a private endpoint connection
          $ref: '#/components/schemas/PrivateLinkServiceConnectionState'
      required:
      - privateLinkServiceConnectionState
    PrivateEndpoint:
      description: The private endpoint property of a private endpoint connection
      type: object
      properties:
        id:
          readOnly: true
          type: string
          description: The resource identifier.
    SharedAccessSignatureAuthorizationRule_AccessRightsDescription:
      type: object
      description: Description of the shared access key.
      properties:
        keyName:
          type: string
          description: Name of the key.
        primaryKey:
          type: string
          description: Primary SAS key value.
        secondaryKey:
          type: string
          description: Secondary SAS key value.
        rights:
          description: Rights that this key has.
          enum:
          - ServiceConfig
          - EnrollmentRead
          - EnrollmentWrite
          - DeviceConnect
          - RegistrationStatusRead
          - RegistrationStatusWrite
          type: string
          x-ms-enum:
            name: AccessRightsDescription
            modelAsString: true
      required:
      - keyName
      - rights
    ErrorMessage:
      description: Error response containing message and code.
      type: object
      properties:
        code:
          description: standard error code
          type: string
        message:
          description: standard error description
          type: string
        details:
          description: detailed summary of error
          type: string
    SharedAccessSignatureAuthorizationRuleListResult:
      type: object
      description: List of shared access keys.
      properties:
        value:
          description: The list of shared access policies.
          type: array
          items:
            $ref: '#/components/schemas/SharedAccessSignatureAuthorizationRule_AccessRightsDescription'
        nextLink:
          description: The next link.
          type: string
          readOnly: true
    TagsResource:
      properties:
        tags:
          additionalProperties:
            type: string
          description: Resource tags
      description: A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance.
    PrivateLinkResources:
      description: The available private link resources for a provisioning service
      type: object
      properties:
        value:
          description: The list of available private link resources for a provisioning service
          type: array
          items:
            $ref: '#/components/schemas/GroupIdInformation'
    IotDpsPropertiesDescription:
      description: the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope
      type: object
      properties:
        state:
          description: Current state of the provisioning service.
          enum:
          - Activating
          - Active
          - Deleting
          - Deleted
          - ActivationFailed
          - DeletionFailed
          - Transitioning
          - Suspending
          - Suspended
          - Resuming
          - FailingOver
          - FailoverFailed
          type: string
          x-ms-enum:
            name: state
            modelAsString: true
        publicNetworkAccess:
          type: string
          description: Whether requests from Public Network are allowed
          enum:
          - Enabled
          - Disabled
          x-ms-enum:
            modelAsString: true
            name: PublicNetworkAccess
        ipFilterRules:
          description: The IP filter rules.
          type: array
          items:
            $ref: '#/components/schemas/IpFilterRule'
        privateEndpointConnections:
          de

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