openapi: 3.2.0
info:
  title: Microsoft Azure Device Groups API
  x-refined-note:
  - x-typespec-generated differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged deviceGroups across 2 of this provider''s published API definitions: azure-iot-central-openapi-original.yml, azuresphereproviderclient-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Device Groups
paths:
  /deviceGroups:
    get:
      operationId: microsoftAzureDevicegroupsList
      summary: Microsoft Azure Get The List Of Device Groups In An Application
      x-ms-examples:
        List device groups:
          $ref: ./examples/devicegroups_list.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/MaxPageSize'
      - $ref: '#/components/parameters/OrderBy'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroupCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Device Groups
    servers:
    - url: /api
  /deviceGroups/{deviceGroupId}:
    get:
      operationId: microsoftAzureDevicegroupsGet
      summary: Microsoft Azure Get The Device Group By Id
      x-ms-examples:
        Get device group by ID:
          $ref: ./examples/devicegroups_get.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceGroupId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Device Groups
    put:
      operationId: microsoftAzureDevicegroupsCreate
      summary: Microsoft Azure Create Or Update A Device Group
      description: Create or update a device group.
      x-ms-examples:
        Create device group:
          $ref: ./examples/devicegroups_create.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceGroupId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Device Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceGroup'
        description: Device group body.
        required: true
    patch:
      operationId: microsoftAzureDevicegroupsUpdate
      summary: Microsoft Azure Update A Device Group Via Patch
      description: Update an existing device group by ID.
      x-ms-examples:
        Update device device group:
          $ref: ./examples/devicegroups_update.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceGroupId'
      - $ref: '#/components/parameters/IfMatch'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Device Groups
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/merge-patch+json:
            schema:
              type: object
        description: Device group patch body.
        required: true
    delete:
      operationId: microsoftAzureDevicegroupsRemove
      summary: Microsoft Azure Delete A Device Group
      x-ms-examples:
        Delete device group:
          $ref: ./examples/devicegroups_delete.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceGroupId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - Device Groups
    servers:
    - url: /api
  /deviceGroups/{deviceGroupId}/devices:
    get:
      operationId: microsoftAzureDevicegroupsGetdevices
      summary: Microsoft Azure Get The Devices Of A Device Group
      description: Get the list of devices by device group ID.
      x-ms-examples:
        Get device group by ID:
          $ref: ./examples/devicegroups_getdevices.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/DeviceGroupId'
      - $ref: '#/components/parameters/MaxPageSize'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroupDeviceCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Device Groups
    servers:
    - url: /api
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups
  : get:
      operationId: microsoftAzureDevicegroupsListbyproduct
      tags:
      - Device Groups
      description: List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
      parameters:
      - $ref: '#/components/parameters/CustomFilterQueryParameter'
      - $ref: '#/components/parameters/CustomTopQueryParameter'
      - $ref: '#/components/parameters/CustomSkipQueryParameter'
      - $ref: '#/components/parameters/CustomMaxPageSizeQueryParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        schema:
          type: string
          pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroupListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeviceGroups_ListByProduct:
          $ref: ./examples/GetDeviceGroups.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
  : get:
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftAzureSphereCatalogsByCatalogNameProductsByProductNameDeviceGroupsByDeviceGroupName
      tags:
      - Device Groups
      description: Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        schema:
          type: string
          pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroup_2'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeviceGroups_Get:
          $ref: ./examples/GetDeviceGroup.json
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureDevicegroupsGet
    put:
      operationId: microsoftAzureDevicegroupsCreateorupdate
      tags:
      - Device Groups
      description: Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        schema:
          type: string
          pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Resource 'DeviceGroup' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroup_2'
        '201':
          description: Resource 'DeviceGroup' create operation succeeded
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroup_2'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeviceGroups_CreateOrUpdate:
          $ref: ./examples/PutDeviceGroup.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceGroup_2'
        description: Resource create parameters.
        required: true
    patch:
      operationId: patchSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftAzureSphereCatalogsByCatalogNameProductsByProductNameDeviceGroupsByDeviceGroupName
      tags:
      - Device Groups
      description: Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        schema:
          type: string
          pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceGroup_2'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeviceGroups_Update:
          $ref: ./examples/PatchDeviceGroup.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceGroupUpdate'
        description: The resource properties to be updated.
        required: true
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureDevicegroupsUpdate
    delete:
      operationId: microsoftAzureDevicegroupsDelete
      tags:
      - Device Groups
      description: Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        schema:
          type: string
          pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeviceGroups_Delete:
          $ref: ./examples/DeleteDeviceGroup.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/claimDevices
  : post:
      operationId: microsoftAzureDevicegroupsClaimdevices
      tags:
      - Device Groups
      description: Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        schema:
          type: string
          pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      responses:
        '202':
          description: Resource operation accepted.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeviceGroups_ClaimDevices:
          $ref: ./examples/PostClaimDevices.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimDevicesRequest'
        description: Bulk claim devices request body.
        required: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/countDevices
  : post:
      operationId: microsoftAzureDevicegroupsCountdevices
      tags:
      - Device Groups
      description: Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        schema:
          type: string
          pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountDeviceResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DeviceGroups_CountDevices:
          $ref: ./examples/PostCountDevicesDeviceGroup.json
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
    servers:
    - url: https://management.azure.com
components:
  schemas:
    DeviceGroupDeviceCollection:
      description: The paged results of devices belonging to the device group.
      type: object
      properties:
        value:
          description: The collection of devices belonging to the device group.
          type: array
          items:
            $ref: '#/components/schemas/Device'
        nextLink:
          description: URL to get the next page of devices in the group.
          type: string
      required:
      - value
    DeviceGroup:
      description: The device group definition.
      type: object
      properties:
        id:
          description: Unique ID of the device group.
          type: string
          readOnly: true
        displayName:
          description: Display name of the device group.
          type: string
        filter:
          description: Query defining which devices should be in this group, [Query Language Reference](https://aka.ms/iotcquery).
          type: string
        description:
          description: Short summary of device group.
          type: string
        etag:
          description: ETag used to prevent conflict in device group updates.
          type: string
        organizations:
          description: List of organization IDs of the device group, only one organization is supported today, multiple organizations will be supported soon.
          type: array
          items:
            type: string
      required:
      - displayName
      - filter
    Error:
      description: The response error definition.
      type: object
      properties:
        error:
          description: Error details for current request.
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - error
    ErrorDetails:
      description: The detail information of the error.
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message details.
        requestId:
          type: string
          description: Correlation Id for current request.
        time:
          type: string
          format: date-time-rfc1123
          description: The time that error request failed.
      required:
      - code
      - message
    DeviceGroupCollection:
      description: The paged results of device groups.
      type: object
      properties:
        value:
          description: The collection of device groups.
          type: array
          items:
            $ref: '#/components/schemas/DeviceGroup'
        nextLink:
          description: URL to get the next page of device groups.
          type: string
      required:
      - value
    DeploymentManifest:
      description: The deployment manifest used for edge devices.
      type: object
      properties:
        id:
          description: Unique ID of the deployment manifest.
          type: string
          readOnly: true
        displayName:
          description: Display name of the deployment manifest.
          type: string
          minLength: 1
        data:
          description: Content of the the deployment manifest.
          type: object
        etag:
          description: Etag to prevent conflict when updating the deployment manifest.
          type: string
        organizations:
          description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon.
          type: array
          items:
            type: string
          maxItems: 1
          minItems: 1
      required:
      - data
    Device:
      description: The device definition.
      type: object
      properties:
        id:
          description: Unique ID of the device.
          type: string
          readOnly: true
        etag:
          description: ETag used to prevent conflict in device updates.
          type: string
        displayName:
          description: Display name of the device.
          type: string
        template:
          description: The device template definition for the device.
          type: string
        enabled:
          description: Whether the device connection to IoT Central has been enabled.
          type: boolean
        provisioned:
          description: Whether resources have been allocated for the device.
          type: boolean
          readOnly: true
        simulated:
          description: Whether the device is simulated.
          type: boolean
        organizations:
          description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon.
          type: array
          items:
            type: string
        type:
          description: The type of the device.
          type: array
          items:
            type: string
            enum:
            - iotEdge
            x-ms-enum:
              name: DeviceType
              modelAsString: true
              values:
              - value: iotEdge
                name: IotEdge
                description: The edge device type
        deploymentManifest:
          description: The deployment manifest assigned to the device.
          $ref: '#/components/schemas/DeploymentManifest'
    RegionalDataBoundary:
      type: string
      description: Regional data boundary values.
      enum:
      - None
      - EU
      x-ms-enum:
        name: RegionalDataBoundary
        modelAsString: true
        values:
        - name: None
          value: None
          description: No data boundary
        - name: EU
          value: EU
          description: EU data boundary
    DeviceGroupUpdateProperties:
      type: object
      description: The updatable properties of the DeviceGroup.
      properties:
        description:
          type: string
          description: Description of the device group.
        osFeedType:
          $ref: '#/components/schemas/OSFeedType'
          description: Operating system feed type of the device group.
        updatePolicy:
          $ref: '#/components/schemas/UpdatePolicy'
          description: Update policy of the device group.
        allowCrashDumpsCollection:
          $ref: '#/components/schemas/AllowCrashDumpCollection'
          description: Flag to define if the user allows for crash dump collection.
        regionalDataBoundary:
          $ref: '#/components/schemas/RegionalDataBoundary'
          description: Regional data boundary for the device group.
    CountDeviceResponse:
      type: object
      description: Response to the action call for count devices in a catalog (preview API).
      allOf:
      - $ref: '#/components/schemas/CountElementsResponse'
    DeviceGroup_2:
      type: object
      description: An device group resource belonging to a product resource.
      properties:
        properties:
          $ref: '#/components/schemas/DeviceGroupProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
          x-ms-mutability:
          - read
          - create
      allOf:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
    DeviceGroupProperties:
      type: object
      description: The properties of deviceGroup
      properties:
        description:
          type: string
          description: Description of the device group.
        osFeedType:
          $ref: '#/components/schemas/OSFeedType'
          description: Operating system feed type of the device group.
        updatePolicy:
          $ref: '#/components/schemas/UpdatePolicy'
          description: Update policy of the device group.
        allowCrashDumpsCollection:
          $ref: '#/components/schemas/AllowCrashDumpCollection'
          description: Flag to define if the user allows for crash dump collection.
        regionalDataBoundary:
          $ref: '#/components/schemas/RegionalDataBoundary'
          description: Regional data boundary for the device group.
        hasDeployment:
          type: boolean
          description: Deployment status for the device group.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The status of the last operation.
          readOnly: true
    OSFeedType:
      type: string
      description: OS feed type values.
      enum:
      - Retail
      - RetailEval
      x-ms-enum:
        name: OSFeedType
        modelAsString: true
        values:
        - name: Retail
          value: Retail
          description: Retail OS feed type.
        - name: RetailEval
          value: RetailEval
          description: Retail evaluation OS feed type.
    ProvisioningState:
      type: string
      description: Provisioning state of resource.
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Provisioning
      - Updating
      - Deleting
      - Accepted
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Succeeded
          value: Succeeded
          description: Resource has been created.
        - name: Failed
          value: Failed
          description: Resource creation failed.
        - name: Canceled
          value: Canceled
          description: Resource creation was canceled.
        - name: Provisioning
          value: Provisioning
          description: The resource is being provisioned
        - name: Updating
          value: Updating
          description: The resource is being updated
        - name: Deleting
          value: Deleting
          description: The resource is being deleted
        - name: Accepted
          value: Accepted
          description: The resource create request has been accepted
    CountElementsResponse:
      type: object
      description: Response of the count for elements.
      properties:
        value:
          type: integer
          format: int32
          description: Number of children resources in parent resource.
      required:
      - value
    DeviceGroupUpdate:
      type: object
      description: The type used for update operations of the DeviceGroup.
      properties:
        properties:
          $ref: '#/components/schemas/DeviceGroupUpdateProperties'
          x-ms-client-flatten: true
    DeviceGroupListResult:
      type: object
      description: The response of a DeviceGroup list operation.
      properties:
        value:
          type: array
          description: The DeviceGroup items on this page
          items:
            $ref: '#/components/schemas/DeviceGroup_2'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
          readOnly: true
      required:
      - value
    UpdatePolicy:
      type: string
      description: Update policy values.
      enum:
      - UpdateAll
      - No3rdPartyAppUpdates
      x-ms-enum:
        name: UpdatePolicy
        modelAsString: true
        values:
        - name: UpdateAll
          value: UpdateAll
          description: Update all policy.
        - name: No3rdPartyAppUpdates
          value: No3rdPartyAppUpdates
          description: No update for 3rd party app policy.
    AllowCrashDumpCollection:
      type: string
      description: Allow crash dumps values.
      enum:
      - Enabled
      - Disabled
      x-ms-enum:
        name: AllowCrashDumpCollection
        modelAsString: true
        values:
        - name: Enabled
          value: Enabled
          description: Crash dump collection enabled
        - name: Disabled
          value: Disabled
          description: Crash dump collection disabled
    ClaimDevicesRequest:
      type: object
      description: Request to the action call to bulk claim devices.
      properties:
        deviceIdentifiers:
          type: array
          description: Device identifiers of the devices to be claimed.
          items:
            type: string
      required:
      - deviceIdentifiers
  parameters:
    MaxPageSize:
      in: query
      name: maxpagesize
      description: The maximum number of resources to return from one response.
      x-ms-parameter-location: method
      required: false
      schema:
        type: integer
        format: int32
        maximum: 100
        minimum: 1
    OrderBy:
      in: query
      name: orderby
      description: An expression that specify the order of the returned resources.
      x-ms-parameter-location: method
      required: false
      schema:
        type: string
    DeviceGroupId:
      in: path
      name: deviceGroupId
      description: Unique ID for the device group.
      x-ms-parameter-location: method
      required: true
      schema:
        type: string
        maxLength: 255
        pattern: ^[a-zA-Z0-9_-]*$
    IfMatch:
      in: header
      name: If-Match
      description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
      x-ms-parameter-location: method
      required: false
      schema:
        type: string
    Version:
      in: query
      name: api-version
      description: The version of the API being called.
      x-ms-parameter-location: client
      required: true
      schema:
        type: string
    Filter:
      in: query
      name: filter
      description: An expression on the resource type that selects the resources to be returned.
      x-ms-parameter-location: method
      required: false
      schema:
        type: string
    CustomTopQueryParameter:
      name: $top
      in: query
      description: The number of result items to return.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: top
      schema:
        type: integer
        format: int32
    CustomMaxPageSizeQueryParameter:
      name: $maxpagesize
      in: query
      description: The maximum number of result items per page.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: maxpagesize
      schema:
        type: integer
        format: int32
    CustomFilterQueryParameter:
      name: $filter
      in: query
      description: Filter the result list using the given expression
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: filter
      schema:
        type: string
    CustomSkipQueryParameter:
      name: $skip
      in: query
      description: The number of result items to skip.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: skip
      schema:
        type: integer
        format: int32
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-refined-from:
- azure-iot-central-openapi-original.yml
- azuresphereproviderclient-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'