swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AppAttachPackage API
schemes:
- https
tags:
- name: AppAttachPackage
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
  : get:
      tags:
      - AppAttachPackage
      operationId: microsoftAzureAppattachpackageGet
      description: Get an app attach package.
      x-ms-examples:
        AppAttachPackage_Get:
          $ref: ./examples/AppAttachPackage_Get.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AppAttachPackageNameParameter'
      responses:
        '200':
          description: Successfully retrieved App Attach Package.
          schema:
            $ref: '#/definitions/AppAttachPackage'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Appattachpackages Appattachpackagename
    put:
      tags:
      - AppAttachPackage
      operationId: microsoftAzureAppattachpackageCreateorupdate
      description: Create or update an App Attach package.
      x-ms-examples:
        AppAttachPackage_Create:
          $ref: ./examples/AppAttachPackage_Create.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AppAttachPackageNameParameter'
      - name: appAttachPackage
        description: Object containing App Attach Package definitions.
        in: body
        required: true
        schema:
          $ref: '#/definitions/AppAttachPackage'
      responses:
        '200':
          description: Successfully updated App Attach Package.
          schema:
            $ref: '#/definitions/AppAttachPackage'
        '201':
          description: Successfully created App Attach Package.
          schema:
            $ref: '#/definitions/AppAttachPackage'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Appattachpackages Appattachpackagename
    delete:
      tags:
      - AppAttachPackage
      operationId: microsoftAzureAppattachpackageDelete
      description: Remove an App Attach Package.
      x-ms-examples:
        AppAttachPackage_Delete:
          $ref: ./examples/AppAttachPackage_Delete.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AppAttachPackageNameParameter'
      - name: force
        in: query
        required: false
        type: boolean
        description: Force flag to delete App Attach package.
      responses:
        '200':
          description: Successfully deleted App Attach Package.
        '204':
          description: App Attach Package does not exist.
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Appattachpackages Appattachpackagename
    patch:
      tags:
      - AppAttachPackage
      operationId: microsoftAzureAppattachpackageUpdate
      description: Update an App Attach Package
      x-ms-examples:
        AppAttachPackage_Update:
          $ref: ./examples/AppAttachPackage_Update.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AppAttachPackageNameParameter'
      - name: appAttachPackagePatch
        description: Object containing App Attach Package definition.
        in: body
        required: false
        schema:
          $ref: '#/definitions/AppAttachPackagePatch'
      responses:
        '200':
          description: Successfully updated App Attach Package.
          schema:
            $ref: '#/definitions/AppAttachPackage'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Appattachpackages Appattachpackagename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages
  : get:
      tags:
      - AppAttachPackage
      operationId: microsoftAzureAppattachpackageListbyresourcegroup
      description: List App Attach packages in resource group.
      x-ms-examples:
        AppAttachPackage_ListByResourceGroup:
          $ref: ./examples/AppAttachPackage_ListByResourceGroup.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: $filter
        in: query
        required: false
        type: string
        description: OData filter expression. Valid properties for filtering are package name and host pool.
      responses:
        '200':
          description: Successfully retrieved App Attach Packages in resource group.
          schema:
            $ref: '#/definitions/AppAttachPackageList'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Appattachpackages
  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages:
    get:
      tags:
      - AppAttachPackage
      operationId: microsoftAzureAppattachpackageListbysubscription
      description: List App Attach packages in subscription.
      x-ms-examples:
        AppAttachPackage_ListBySubscription:
          $ref: ./examples/AppAttachPackage_ListBySubscription.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: $filter
        in: query
        required: false
        type: string
        description: OData filter expression. Valid properties for filtering are package name, host pool, and resource group.
      responses:
        '200':
          description: Successfully retrieved App Attach Packages in subscription.
          schema:
            $ref: '#/definitions/AppAttachPackageList'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Desktopvirtualization Appattachpackages
definitions:
  AppAttachPackageList:
    type: object
    title: AppAttachPackageList
    description: List of App Attach Package definitions.
    properties:
      value:
        type: array
        description: List of App Attach Package definitions.
        items:
          $ref: '#/definitions/AppAttachPackage'
      nextLink:
        type: string
        readOnly: true
        description: Link to the next page of results.
  AppAttachPackageProperties:
    description: Schema for App Attach Package properties.
    type: object
    properties:
      provisioningState:
        readOnly: true
        $ref: '#/definitions/ProvisioningState'
        description: The provisioning state of the App Attach Package.
      image:
        description: Detailed properties for App Attach Package
        $ref: '#/definitions/AppAttachPackageInfoProperties'
        x-nullable: false
      hostPoolReferences:
        type: array
        description: List of Hostpool resource Ids.
        items:
          type: string
      keyVaultURL:
        type: string
        description: URL of keyvault location to store certificate
      failHealthCheckOnStagingFailure:
        $ref: '#/definitions/FailHealthCheckOnStagingFailureEnum'
        description: Parameter indicating how the health check should behave if this package fails staging
  AppAttachPackagePatch:
    description: Schema for patchable App Attach Package properties.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: tags to be updated
      properties:
        description: Detailed properties for App Attach Package
        $ref: '#/definitions/AppAttachPackagePatchProperties'
        x-ms-client-flatten: false
        x-nullable: false
  FailHealthCheckOnStagingFailureEnum:
    enum:
    - Unhealthy
    - NeedsAssistance
    - DoNotFail
    x-ms-enum:
      name: failHealthCheckOnStagingFailure
      modelAsString: true
    type: string
    description: Parameter indicating how the health check should behave if this package fails staging
  AppAttachPackagePatchProperties:
    description: Schema for patchable fields on an App Attach Package.
    type: object
    properties:
      image:
        description: Detailed properties for App Attach Package
        $ref: '#/definitions/AppAttachPackageInfoProperties'
      hostPoolReferences:
        type: array
        description: List of Hostpool resource Ids.
        items:
          type: string
      keyVaultURL:
        type: string
        description: URL of keyvault location to store certificate
      failHealthCheckOnStagingFailure:
        $ref: '#/definitions/FailHealthCheckOnStagingFailureEnum'
        description: Parameter indicating how the health check should behave if this package fails staging
  ProvisioningState:
    type: string
    readOnly: true
    description: The current provisioning state.
    enum:
    - Succeeded
    - Provisioning
    - Failed
    - Canceled
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  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.
  AppAttachPackageInfoProperties:
    description: Schema for Import Package Information properties.
    type: object
    properties:
      packageAlias:
        type: string
        description: Alias of App Attach Package. Assigned at import time
      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-ms-identifiers: []
        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-ms-identifiers: []
        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
      isPackageTimestamped:
        enum:
        - Timestamped
        - NotTimestamped
        x-ms-enum:
          name: packageTimestamped
          modelAsString: true
        type: string
        description: Is package timestamped so it can ignore the certificate expiry date
        x-nullable: true
  AppAttachPackage:
    description: Schema for App Attach Package properties.
    type: object
    x-ms-client-flatten: false
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource
    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 App Attach Package
        $ref: '#/definitions/AppAttachPackageProperties'
        x-nullable: false
  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:
  AppAttachPackageNameParameter:
    name: appAttachPackageName
    in: path
    required: true
    type: string
    description: The name of the App Attach package arm object
    maxLength: 100
    minLength: 3
    pattern: ^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'