swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MsixImage API
schemes:
- https
tags:
- name: MsixImage
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage
  : post:
      tags:
      - MsixImage
      operationId: microsoftAzureMsiximagesExpand
      description: Expands and Lists MSIX packages in an Image, given the Image Path.
      x-ms-examples:
        MsixImage_Expand:
          $ref: ./examples/MsixImage_Expand_Post.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: msixImageURI
        description: Object containing URI to MSIX Image
        in: body
        required: true
        schema:
          $ref: '#/definitions/MSIXImageURI'
      responses:
        '200':
          description: Successfully retrieved MSIX packages in specified Image Path.
          schema:
            $ref: '#/definitions/ExpandMsixImageList'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Expandmsiximage
definitions:
  ExpandMsixImage:
    type: object
    description: 'Represents the definition of contents retrieved after expanding the MSIX Image. '
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
    properties:
      properties:
        description: Detailed properties for ExpandMsixImage
        x-ms-client-flatten: true
        $ref: '#/definitions/ExpandMsixImageProperties'
  ExpandMsixImageList:
    type: object
    title: ExpandMsixImageList
    description: List of MSIX package properties retrieved from MSIX Image expansion.
    properties:
      value:
        type: array
        description: List of MSIX package properties from give MSIX Image.
        items:
          $ref: '#/definitions/ExpandMsixImage'
      nextLink:
        type: string
        readOnly: true
        description: Link to the next page of results.
  CloudError:
    description: Cloud error object.
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorProperties'
  MSIXImageURI:
    description: Represents URI referring to MSIX Image
    type: object
    properties:
      uri:
        type: string
        description: URI to Image
  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.
  ExpandMsixImageProperties:
    description: Schema for Expand MSIX Image properties.
    type: object
    properties:
      packageAlias:
        type: string
        description: Alias of MSIX Package.
      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
      packageFullName:
        type: string
        description: 'Package Full Name from appxmanifest.xml. '
        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'
        x-nullable: true
      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
      certificateName:
        type: string
        description: 'Certificate name found in the appxmanifest.xml. '
        x-nullable: true
      certificateExpiry:
        format: date-time
        type: string
        description: 'Date certificate expires, found in the appxmanifest.xml. '
        x-nullable: true
  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
  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
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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'