swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Catalogs API
schemes:
- https
tags:
- name: Catalogs
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.AzureSphere/catalogs:
    get:
      operationId: microsoftAzureCatalogsListbysubscription
      tags:
      - Catalogs
      description: List Catalog resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/CatalogListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Catalogs_ListBySubscription:
          $ref: ./examples/GetCatalogsSub.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Get Subscriptions Subscriptionid Providers Microsoft Azuresphere Catalogs
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs:
    get:
      operationId: microsoftAzureCatalogsListbyresourcegroup
      tags:
      - Catalogs
      description: List Catalog resources by resource group
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/CatalogListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Catalogs_ListByResourceGroup:
          $ref: ./examples/GetCatalogsRG.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}:
    get:
      operationId: microsoftAzureCatalogsGet
      tags:
      - Catalogs
      description: Get a Catalog
      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}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Catalog'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Catalogs_Get:
          $ref: ./examples/GetCatalog.json
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname
    put:
      operationId: microsoftAzureCatalogsCreateorupdate
      tags:
      - Catalogs
      description: Create a Catalog
      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: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/Catalog'
      responses:
        '200':
          description: Resource 'Catalog' update operation succeeded
          schema:
            $ref: '#/definitions/Catalog'
        '201':
          description: Resource 'Catalog' create operation succeeded
          schema:
            $ref: '#/definitions/Catalog'
          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:
        Catalogs_CreateOrUpdate:
          $ref: ./examples/PutCatalog.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
    patch:
      operationId: microsoftAzureCatalogsUpdate
      tags:
      - Catalogs
      description: Update a Catalog
      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: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/CatalogUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Catalog'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Catalogs_Update:
          $ref: ./examples/PatchCatalog.json
      summary: Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname
    delete:
      operationId: microsoftAzureCatalogsDelete
      tags:
      - Catalogs
      description: Delete a Catalog
      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}$
      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:
        Catalogs_Delete:
          $ref: ./examples/DeleteCatalog.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
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/countDevices
  : post:
      operationId: microsoftAzureCatalogsCountdevices
      tags:
      - Catalogs
      description: Counts devices in catalog.
      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}$
      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:
        Catalogs_CountDevices:
          $ref: ./examples/PostCountDevicesCatalog.json
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Countdevices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeployments
  : post:
      operationId: microsoftAzureCatalogsListdeployments
      tags:
      - Catalogs
      description: Lists deployments for catalog.
      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}$
      - $ref: '#/parameters/CustomFilterQueryParameter'
      - $ref: '#/parameters/CustomTopQueryParameter'
      - $ref: '#/parameters/CustomSkipQueryParameter'
      - $ref: '#/parameters/CustomMaxPageSizeQueryParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DeploymentListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Catalogs_ListDeployments:
          $ref: ./examples/PostListDeploymentsByCatalog.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Listdeployments
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups
  : post:
      operationId: microsoftAzureCatalogsListdevicegroups
      tags:
      - Catalogs
      description: List the device groups for the catalog.
      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}$
      - $ref: '#/parameters/CustomFilterQueryParameter'
      - $ref: '#/parameters/CustomTopQueryParameter'
      - $ref: '#/parameters/CustomSkipQueryParameter'
      - $ref: '#/parameters/CustomMaxPageSizeQueryParameter'
      - name: listDeviceGroupsRequest
        in: body
        description: List device groups for catalog.
        required: true
        schema:
          $ref: '#/definitions/ListDeviceGroupsRequest'
      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:
        Catalogs_ListDeviceGroups:
          $ref: ./examples/PostListDeviceGroupsCatalog.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Listdevicegroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceInsights
  : post:
      operationId: microsoftAzureCatalogsListdeviceinsights
      tags:
      - Catalogs
      description: Lists device insights for catalog.
      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}$
      - $ref: '#/parameters/CustomFilterQueryParameter'
      - $ref: '#/parameters/CustomTopQueryParameter'
      - $ref: '#/parameters/CustomSkipQueryParameter'
      - $ref: '#/parameters/CustomMaxPageSizeQueryParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/PagedDeviceInsight'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Catalogs_ListDeviceInsights:
          $ref: ./examples/PostListDeviceInsightsCatalog.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Listdeviceinsights
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices
  : post:
      operationId: microsoftAzureCatalogsListdevices
      tags:
      - Catalogs
      description: Lists devices for catalog.
      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}$
      - $ref: '#/parameters/CustomFilterQueryParameter'
      - $ref: '#/parameters/CustomTopQueryParameter'
      - $ref: '#/parameters/CustomSkipQueryParameter'
      - $ref: '#/parameters/CustomMaxPageSizeQueryParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DeviceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Catalogs_ListDevices:
          $ref: ./examples/PostListDevicesByCatalog.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Listdevices
  /projects/{projectName}/catalogs:
    get:
      tags:
      - Catalogs
      description: Lists all of the catalogs available for a project.
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/TopParameter
      operationId: microsoftAzureEnvironmentsListcatalogsbyproject
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/CatalogListResult_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        Environments_ListCatalogsByProject:
          $ref: ./examples/Catalogs_ListByProject.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Projects Projectname Catalogs
  /projects/{projectName}/catalogs/{catalogName}:
    get:
      tags:
      - Catalogs
      description: Gets the specified catalog within the project
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: '#/parameters/CatalogNameParameter'
      operationId: microsoftAzureEnvironmentsGetcatalog
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/Catalog_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        Environments_GetCatalog:
          $ref: ./examples/Catalogs_Get.json
      summary: Microsoft Azure Get Projects Projectname Catalogs Catalogname
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
  Catalog_2:
    description: A catalog.
    type: object
    properties:
      uri:
        description: The unique URI of the catalog
        type: string
      name:
        description: Name of the catalog.
        type: string
    required:
    - uri
    - name
  Catalog:
    type: object
    description: An Azure Sphere catalog
    properties:
      properties:
        $ref: '#/definitions/CatalogProperties'
        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/TrackedResource
  ListDeviceGroupsRequest:
    type: object
    description: Request of the action to list device groups for a catalog.
    properties:
      deviceGroupName:
        type: string
        description: Device Group name.
  CatalogListResult_2:
    description: Results of the catalog list operation.
    type: object
    properties:
      value:
        description: Current page of results.
        type: array
        items:
          $ref: '#/definitions/Catalog_2'
      nextLink:
        description: URL to get the next set of results if there are any.
        type: string
    required:
    - value
  DeviceGroup:
    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
  ImageType:
    type: string
    description: Image type values.
    enum:
    - InvalidImageType
    - OneBl
    - PlutonRuntime
    - WifiFirmware
    - SecurityMonitor
    - NormalWorldLoader
    - NormalWorldDtb
    - NormalWorldKernel
    - RootFs
    - Services
    - Applications
    - FwConfig
    - BootManifest
    - Nwfs
    - TrustedKeystore
    - Policy
    - CustomerBoardConfig
    - UpdateCertStore
    - BaseSystemUpdateManifest
    - FirmwareUpdateManifest
    - CustomerUpdateManifest
    - RecoveryManifest
    - ManifestSet
    - Other
    x-ms-enum:
      name: ImageType
      modelAsString: true
      values:
      - name: InvalidImageType
        value: InvalidImageType
        description: Invalid image.
      - name: OneBl
        value: OneBl
        description: One Bl image type
      - name: PlutonRuntime
        value: PlutonRuntime
        description: Pluton image type
      - name: WifiFirmware
        value: WifiFirmware
        description: Wifi firmware image type
      - name: SecurityMonitor
        value: SecurityMonitor
        description: Security monitor image type
      - name: NormalWorldLoader
        value: NormalWorldLoader
        description: Normal world loader image type
      - name: NormalWorldDtb
        value: NormalWorldDtb
        description: Normal world dtb image type
      - name: NormalWorldKernel
        value: NormalWorldKernel
        description: Normal world kernel image type
      - name: RootFs
        value: RootFs
        description: Root FS image type
      - name: Services
        value: Services
        description: Services image type
      - name: Applications
        value: Applications
        description: Applications image type
      - name: FwConfig
        value: FwConfig
        description: FW config image type
      - name: BootManifest
        value: BootManifest
        description: Boot manifest image type
      - name: Nwfs
        value: Nwfs
        description: Nwfs image type
      - name: TrustedKeystore
        value: TrustedKeystore
        description: Trusted key store image type
      - name: Policy
        value: Policy
        description: Policy image type
      - name: CustomerBoardConfig
        value: CustomerBoardConfig
        description: Customer board config image type
      - name: UpdateCertStore
        value: UpdateCertStore
        description: Update certificate store image type
      - name: BaseSystemUpdateManifest
        value: BaseSystemUpdateManifest
        description: Base system update manifest image type
      - name: FirmwareUpdateManifest
        value: FirmwareUpdateManifest
        description: Firmware update manifest image type
      - name: CustomerUpdateManifest
        value: CustomerUpdateManifest
        description: Customer update manifest image type
      - name: RecoveryManifest
        value: RecoveryManifest
        description: Recovery manifest image type
      - name: ManifestSet
        value: ManifestSet
        description: manifest set image type
      - name: Other
        value: Other
        description: Other image type
  Image:
    type: object
    description: An image resource belonging to a catalog resource.
    properties:
      properties:
        $ref: '#/definitions/ImageProperties'
        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
  CatalogProperties:
    type: object
    description: Catalog properties
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
  DeviceProperties:
    type: object
    description: The properties of device
    properties:
      deviceId:
        type: string
        description: Device ID
        x-ms-mutability:
        - read
        - create
      chipSku:
        type: string
        description: SKU of the chip
        readOnly: true
      lastAvailableOsVersion:
        type: string
        description: OS version available for installation when update requested
        readOnly: true
      lastInstalledOsVersion:
        type: string
        description: OS version running on device when update requested
        readOnly: true
      lastOsUpdateUtc:
        type: string
        format: date-time
        description: Time when update requested and new OS version available
        readOnly: true
      lastUpdateRequestUtc:
        type: string
        format: date-time
        description: Time when update was last requested
        readOnly: true
      provisioningState:
        $ref: '#/definitions/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.
  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
  CatalogListResult:
    type: object
    description: The response of a Catalog list operation.
    properties:
      value:
        type: array
        description: The Catalog items on this page
        items:
          $ref: '#/definitions/Catalog'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
        readOnly: true
    required:
    - value
  ImageProperties:
    type: object
    description: The properties of image
    properties:
      image:
        type: string
        description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
        x-ms-mutability:
        - read
        - create
      imageId:
        type: string
        description: Image ID
        x-ms-mutability:
        - read
        - create
      imageName:
        type: string
        description: Image name
        readOnly: true
      regionalDataBoundary:
        $ref: '#/definitions/RegionalDataBoundary'
        description: Regional data boundary for an image
        x-ms-mutability:
        - read
        - create
      uri:
        type: string
        description: Location the image
        readOnly: true
      description:
        type: string
        description: The image description.
        readOnly: true
      componentId:
        type: string
        description: The image component id.
        readOnly: true
      imageType:
        $ref: '#/definitions/ImageType'
        description: The image type.
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
  Device:
    type: object
    description: An device resource belonging to a device group resource.
    properties:
      properties:
        $ref: '#/definitions/DeviceProperties'
        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
  DeploymentProperties:
    type: object
    description: The properties of deployment
    properties:
      deploymentId:
        type: string
        description: Deployment ID
        x-ms-mutability:
        - read
        - create
      deployedImages:
        type: array
        description: Images deployed
        items:
          $ref: '#/definitions/Image'
        x-ms-mutability:
        - read
        - create
      deploymentDateUtc:
        type: string
        format: date-time
        description: Deployment date UTC
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
  DeploymentListResult:
    type: object
    description: The response of a Deployment list operation.
    properties:
      value:
        type: array
        description: The Deployment items on this page
        items:
          $ref: '#/definitions/Deployment'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
        readOnly: true
    required:
    - value
  CatalogUpdate:
    type: object
    description: The type used for update operations of the Catalog.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
  PagedDeviceInsight:
    type: object
    description: Paged collection of DeviceInsight items
    properties:
      value:
        type: array
        description: The DeviceInsight items on this page
        items:
          $ref: '#/definitions/DeviceInsight'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
        readOnly: true
    required:
    - value
  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
  Deployment:
    type: object
    description: An deployment resource belonging to a device group resource.
    properties:
      properties:
        $ref: '#/definitions/DeploymentProperties'
        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
  DeviceListResult:
    type: object
    description: The response of a Device list operation.
    properties:
      value:
        type: array
        description: The Device items on this page
        items:
          $ref: '#/definitions/Device'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
        readOnly: true
    required:
    - value
  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'
      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
  DeviceInsight:
    type: object
    description: Device insight report.
    properties:
      deviceId:
        type: string
        description: Device ID
      description:
        type: string
        description: Event description
      startTimestampUtc:
        type: string
        format: date-time
        description: Event start timestamp
      endTimestampUtc:
        type: string
        format: date-time
        description: Event end timestamp
      eventCategory:
        type: string
        description: Event category
      eventClass:
        type: string
        description: Event class
      eventType:
        type: string
        description: Event type
      eventCount:
        type: integer
        format: int32
        description: Event count
    required:
    - deviceId
    - description
    - startTimestampUtc
    - endTimestampUtc
    - eventCategory
    - eventClass
    - eventType
    - eventCount
  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:
  CatalogNameParameter:
    name: catalogName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
    minLength: 3
    maxLength: 63
    description: The name of the catalog
    x-ms-parameter-location: method
  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
  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
  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
  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'