swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector deviceGroups API
schemes:
- https
tags:
- name: deviceGroups
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: '#/parameters/Version'
      - $ref: '#/parameters/Filter'
      - $ref: '#/parameters/MaxPageSize'
      - $ref: '#/parameters/OrderBy'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceGroupCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - deviceGroups
  /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: '#/parameters/Version'
      - $ref: '#/parameters/DeviceGroupId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - deviceGroups
    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: '#/parameters/Version'
      - $ref: '#/parameters/DeviceGroupId'
      - in: body
        name: body
        description: Device group body.
        schema:
          $ref: '#/definitions/DeviceGroup'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - deviceGroups
    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
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceGroupId'
      - in: body
        name: body
        description: Device group patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - deviceGroups
    delete:
      operationId: microsoftAzureDevicegroupsRemove
      summary: Microsoft Azure Delete A Device Group
      x-ms-examples:
        Delete device group:
          $ref: ./examples/devicegroups_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceGroupId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - deviceGroups
  /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: '#/parameters/Version'
      - $ref: '#/parameters/DeviceGroupId'
      - $ref: '#/parameters/MaxPageSize'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceGroupDeviceCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - deviceGroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups
  : get:
      operationId: microsoftAzureDevicegroupsListbyproduct
      tags:
      - deviceGroups
      description: List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
      parameters:
      - $ref: '#/parameters/CustomFilterQueryParameter'
      - $ref: '#/parameters/CustomTopQueryParameter'
      - $ref: '#/parameters/CustomSkipQueryParameter'
      - $ref: '#/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
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DeviceGroupListResult'
        default:
          description: An unexpected error response.
          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 Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
  : get:
      operationId: microsoftAzureDevicegroupsGet
      tags:
      - deviceGroups
      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
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        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.
          schema:
            $ref: '#/definitions/DeviceGroup_2'
        default:
          description: An unexpected error response.
          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 Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname
    put:
      operationId: microsoftAzureDevicegroupsCreateorupdate
      tags:
      - deviceGroups
      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
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        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$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/DeviceGroup_2'
      responses:
        '200':
          description: Resource 'DeviceGroup' update operation succeeded
          schema:
            $ref: '#/definitions/DeviceGroup_2'
        '201':
          description: Resource 'DeviceGroup' create operation succeeded
          schema:
            $ref: '#/definitions/DeviceGroup_2'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          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 Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname
    patch:
      operationId: microsoftAzureDevicegroupsUpdate
      tags:
      - deviceGroups
      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
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        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$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/DeviceGroupUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DeviceGroup_2'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          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 Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname
    delete:
      operationId: microsoftAzureDevicegroupsDelete
      tags:
      - deviceGroups
      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
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        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:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          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 Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/claimDevices
  : post:
      operationId: microsoftAzureDevicegroupsClaimdevices
      tags:
      - deviceGroups
      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
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        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$
      - name: claimDevicesRequest
        in: body
        description: Bulk claim devices request body.
        required: true
        schema:
          $ref: '#/definitions/ClaimDevicesRequest'
      responses:
        '202':
          description: Resource operation accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          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 Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Claimdevices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/countDevices
  : post:
      operationId: microsoftAzureDevicegroupsCountdevices
      tags:
      - deviceGroups
      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
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        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.
          schema:
            $ref: '#/definitions/CountDeviceResponse'
        default:
          description: An unexpected error response.
          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 Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Countdevices
definitions:
  DeviceGroupProperties:
    type: object
    description: The properties of deviceGroup
    properties:
      description:
        type: string
        description: Description of the device group.
      osFeedType:
        $ref: '#/definitions/OSFeedType'
        description: Operating system feed type of the device group.
      updatePolicy:
        $ref: '#/definitions/UpdatePolicy'
        description: Update policy of the device group.
      allowCrashDumpsCollection:
        $ref: '#/definitions/AllowCrashDumpCollection'
        description: Flag to define if the user allows for crash dump collection.
      regionalDataBoundary:
        $ref: '#/definitions/RegionalDataBoundary'
        description: Regional data boundary for the device group.
      hasDeployment:
        type: boolean
        description: Deployment status for the device group.
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
  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
  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
  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
  DeviceGroupCollection:
    description: The paged results of device groups.
    type: object
    properties:
      value:
        description: The collection of device groups.
        type: array
        items:
          $ref: '#/definitions/DeviceGroup'
      nextLink:
        description: URL to get the next page of device groups.
        type: string
    required:
    - value
  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.
  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
  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: '#/definitions/DeploymentManifest'
  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
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
  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
  CountDeviceResponse:
    type: object
    description: Response to the action call for count devices in a catalog (preview API).
    allOf:
    - $ref: '#/definitions/CountElementsResponse'
  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
  DeviceGroupUpdateProperties:
    type: object
    description: The updatable properties of the DeviceGroup.
    properties:
      description:
        type: string
        description: Description of the device group.
      osFeedType:
        $ref: '#/definitions/OSFeedType'
        description: Operating system feed type of the device group.
      updatePolicy:
        $ref: '#/definitions/UpdatePolicy'
        description: Update policy of the device group.
      allowCrashDumpsCollection:
        $ref: '#/definitions/AllowCrashDumpCollection'
        description: Flag to define if the user allows for crash dump collection.
      regionalDataBoundary:
        $ref: '#/definitions/RegionalDataBoundary'
        description: Regional data boundary for the device group.
  DeviceGroupUpdate:
    type: object
    description: The type used for update operations of the DeviceGroup.
    properties:
      properties:
        $ref: '#/definitions/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: '#/definitions/DeviceGroup_2'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
        readOnly: true
    required:
    - value
  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
  DeviceGroup_2:
    type: object
    description: An device group resource belonging to a product resource.
    properties:
      properties:
        $ref: '#/definitions/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
  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: '#/definitions/Device'
      nextLink:
        description: URL to get the next page of devices in the group.
        type: string
    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.
parameters:
  CustomSkipQueryParameter:
    name: $skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
    x-ms-client-name: skip
  OrderBy:
    in: query
    name: orderby
    description: An expression that specify the order of the returned resources.
    x-ms-parameter-location: method
    type: string
    required: false
  Filter:
    in: query
    name: filter
    description: An expression on the resource type that selects the resources to be returned.
    x-ms-parameter-location: method
    type: string
    required: false
  MaxPageSize:
    in: query
    name: maxpagesize
    description: The maximum number of resources to return from one response.
    x-ms-parameter-location: method
    type: integer
    format: int32
    minimum: 1
    maximum: 100
    required: false
  CustomTopQueryParameter:
    name: $top
    in: query
    description: The number of result items to return.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
    x-ms-client-name: top
  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
    type: string
    required: false
  CustomMaxPageSizeQueryParameter:
    name: $maxpagesize
    in: query
    description: The maximum number of result items per page.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
    x-ms-client-name: maxpagesize
  DeviceGroupId:
    in: path
    name: deviceGroupId
    description: Unique ID for the device group.
    x-ms-parameter-location: method
    type: string
    maxLength: 255
    pattern: ^[a-zA-Z0-9_-]*$
    required: true
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
  CustomFilterQueryParameter:
    name: $filter
    in: query
    description: Filter the result list using the given expression
    required: false
    type: string
    x-ms-parameter-location: method
    x-ms-client-name: filter
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'