swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MSIXPackage API
schemes:
- https
tags:
- name: MSIXPackage
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
  : get:
      tags:
      - MSIXPackage
      operationId: microsoftAzureMsixpackagesGet
      description: Get a msixpackage.
      x-ms-examples:
        MSIXPackage_Get:
          $ref: ./examples/MsixPackage_Get.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - $ref: '#/parameters/MSIXPackageFullNameParameter'
      responses:
        '200':
          description: Successfully retrieved MSIX Package.
          schema:
            $ref: '#/definitions/MSIXPackage'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Msixpackages Msixpackagefullname
    put:
      tags:
      - MSIXPackage
      operationId: microsoftAzureMsixpackagesCreateorupdate
      description: Create or update a MSIX package.
      x-ms-examples:
        MSIXPackage_Create:
          $ref: ./examples/MsixPackage_Create.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - $ref: '#/parameters/MSIXPackageFullNameParameter'
      - name: msixPackage
        description: Object containing  MSIX Package definitions.
        in: body
        required: true
        schema:
          $ref: '#/definitions/MSIXPackage'
      responses:
        '200':
          description: Successfully updated  MSIX Package.
          schema:
            $ref: '#/definitions/MSIXPackage'
        '201':
          description: Successfully created  MSIX Package.
          schema:
            $ref: '#/definitions/MSIXPackage'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Msixpackages Msixpackagefullname
    delete:
      tags:
      - MSIXPackage
      operationId: microsoftAzureMsixpackagesDelete
      description: Remove an MSIX Package.
      x-ms-examples:
        MSIXPackage_Delete:
          $ref: ./examples/MsixPackage_Delete.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - $ref: '#/parameters/MSIXPackageFullNameParameter'
      responses:
        '200':
          description: Successfully removed MSIX Package.
        '204':
          description: MSIX Package does not exist.
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Msixpackages Msixpackagefullname
    patch:
      tags:
      - MSIXPackage
      operationId: microsoftAzureMsixpackagesUpdate
      description: Update an  MSIX Package.
      x-ms-examples:
        MSIXPackage_Update:
          $ref: ./examples/MsixPackage_Update.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - $ref: '#/parameters/MSIXPackageFullNameParameter'
      - name: msixPackage
        description: Object containing MSIX Package definitions.
        in: body
        required: false
        schema:
          $ref: '#/definitions/MSIXPackagePatch'
      responses:
        '200':
          description: Successfully updated MSIX Package.
          schema:
            $ref: '#/definitions/MSIXPackage'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Msixpackages Msixpackagefullname
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages
  : get:
      tags:
      - MSIXPackage
      operationId: microsoftAzureMsixpackagesList
      description: List MSIX packages in hostpool.
      x-ms-examples:
        MSIXPackage_List:
          $ref: ./examples/MsixPackage_List.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/HostPoolNameParameter'
      - name: pageSize
        in: query
        required: false
        type: integer
        format: int32
        description: Number of items per page.
      - name: isDescending
        in: query
        required: false
        type: boolean
        description: Indicates whether the collection is descending.
      - name: initialSkip
        in: query
        required: false
        type: integer
        format: int32
        description: Initial number of items to skip.
      responses:
        '200':
          description: Successfully retrieved MSIX Packages in hostpool.
          schema:
            $ref: '#/definitions/MSIXPackageList'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Msixpackages
definitions:
  MSIXPackageProperties:
    description: Schema for MSIX Package properties.
    type: object
    properties:
      imagePath:
        type: string
        description: VHD/CIM image path on Network Share.
        x-nullable: false
      packageName:
        type: string
        description: 'Package Name from appxmanifest.xml. '
        x-nullable: false
      packageFamilyName:
        type: string
        description: 'Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. '
        x-nullable: false
      displayName:
        type: string
        description: 'User friendly Name to be displayed in the portal. '
        x-nullable: true
      packageRelativePath:
        type: string
        description: 'Relative Path to the package inside the image. '
        x-nullable: false
      isRegularRegistration:
        type: boolean
        description: Specifies how to register Package in feed.
        x-nullable: false
      isActive:
        type: boolean
        description: 'Make this version of the package the active one across the hostpool. '
        x-nullable: false
      packageDependencies:
        type: array
        description: 'List of package dependencies. '
        items:
          $ref: '#/definitions/MsixPackageDependencies'
      version:
        type: string
        description: 'Package Version found in the appxmanifest.xml. '
        x-nullable: false
      lastUpdated:
        format: date-time
        type: string
        description: 'Date Package was last updated, found in the appxmanifest.xml. '
        x-nullable: false
      packageApplications:
        type: array
        description: 'List of package applications. '
        items:
          $ref: '#/definitions/MsixPackageApplications'
        x-nullable: false
  MSIXPackagePatchProperties:
    description: MSIX Package properties that can be patched.
    type: object
    properties:
      isActive:
        type: boolean
        description: 'Set a version of the package to be active across hostpool. '
      isRegularRegistration:
        type: boolean
        description: Set Registration mode. Regular or Delayed.
      displayName:
        type: string
        description: Display name for MSIX Package.
  CloudError:
    description: Cloud error object.
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorProperties'
  MSIXPackagePatch:
    type: object
    description: MSIX Package properties that can be patched.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
    properties:
      properties:
        description: Detailed properties for MSIX Package
        x-ms-client-flatten: true
        $ref: '#/definitions/MSIXPackagePatchProperties'
  MSIXPackageList:
    type: object
    title: MsixPackageList
    description: List of MSIX Package definitions.
    properties:
      value:
        type: array
        description: List of MSIX Package definitions.
        items:
          $ref: '#/definitions/MSIXPackage'
      nextLink:
        type: string
        readOnly: true
        description: Link to the next page of results.
  MsixPackageApplications:
    description: Schema for MSIX Package Application properties.
    type: object
    properties:
      appId:
        type: string
        description: Package Application Id, found in appxmanifest.xml.
        x-nullable: false
      description:
        type: string
        description: Description of Package Application.
        x-nullable: false
      appUserModelID:
        type: string
        description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml.
        x-nullable: false
      friendlyName:
        type: string
        description: User friendly name.
        x-nullable: false
      iconImageName:
        type: string
        description: User friendly name.
        x-nullable: false
      rawIcon:
        type: string
        format: byte
        description: the icon a 64 bit string as a byte array.
      rawPng:
        type: string
        format: byte
        description: the icon a 64 bit string as a byte array.
  MsixPackageDependencies:
    description: Schema for MSIX Package Dependencies properties.
    type: object
    properties:
      dependencyName:
        type: string
        description: Name of package dependency.
        x-nullable: false
      publisher:
        type: string
        description: Name of dependency publisher.
        x-nullable: false
      minVersion:
        type: string
        description: Dependency version required.
        x-nullable: false
  CloudErrorProperties:
    description: Cloud error object properties.
    type: object
    properties:
      code:
        description: Error code
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  MSIXPackage:
    description: Schema for MSIX Package properties.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
    required:
    - properties
    properties:
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of the resource.
      properties:
        description: Detailed properties for MSIX Package
        x-ms-client-flatten: true
        $ref: '#/definitions/MSIXPackageProperties'
        x-nullable: false
parameters:
  HostPoolNameParameter:
    name: hostPoolName
    in: path
    required: true
    type: string
    description: The name of the host pool within the specified resource group
    maxLength: 64
    minLength: 3
    x-ms-parameter-location: method
  MSIXPackageFullNameParameter:
    name: msixPackageFullName
    in: path
    required: true
    type: string
    description: The version specific package full name of the MSIX package within specified hostpool
    maxLength: 100
    minLength: 3
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'