Microsoft Azure GalleryApplicationVersions API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GalleryApplicationVersions API
schemes:
- https
tags:
- name: GalleryApplicationVersions
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
  : put:
      tags:
      - GalleryApplicationVersions
      operationId: microsoftAzureGalleryapplicationversionsCreateorupdate
      description: Create or update a gallery Application Version.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: The name of the Shared Application Gallery in which the Application Definition resides.
      - name: galleryApplicationName
        in: path
        required: true
        type: string
        description: The name of the gallery Application Definition in which the Application Version is to be created.
      - name: galleryApplicationVersionName
        in: path
        required: true
        type: string
        description: 'The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch>'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: galleryApplicationVersion
        in: body
        required: true
        schema:
          $ref: '#/definitions/GalleryApplicationVersion'
        description: Parameters supplied to the create or update gallery Application Version operation.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GalleryApplicationVersion'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/GalleryApplicationVersion'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/GalleryApplicationVersion'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Create or update a simple gallery Application Version.:
          $ref: ./examples/CreateOrUpdateASimpleGalleryApplicationVersion.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Applications Galleryapplicationname Versions Galleryapplicationversionname
    patch:
      tags:
      - GalleryApplicationVersions
      operationId: microsoftAzureGalleryapplicationversionsUpdate
      description: Update a gallery Application Version.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: The name of the Shared Application Gallery in which the Application Definition resides.
      - name: galleryApplicationName
        in: path
        required: true
        type: string
        description: The name of the gallery Application Definition in which the Application Version is to be updated.
      - name: galleryApplicationVersionName
        in: path
        required: true
        type: string
        description: 'The name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch>'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: galleryApplicationVersion
        in: body
        required: true
        schema:
          $ref: '#/definitions/GalleryApplicationVersionUpdate'
        description: Parameters supplied to the update gallery Application Version operation.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GalleryApplicationVersion'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Update a simple gallery Application Version.:
          $ref: ./examples/UpdateASimpleGalleryApplicationVersion.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Applications Galleryapplicationname Versions Galleryapplicationversionname
    get:
      tags:
      - GalleryApplicationVersions
      operationId: microsoftAzureGalleryapplicationversionsGet
      description: Retrieves information about a gallery Application Version.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: The name of the Shared Application Gallery in which the Application Definition resides.
      - name: galleryApplicationName
        in: path
        required: true
        type: string
        description: The name of the gallery Application Definition in which the Application Version resides.
      - name: galleryApplicationVersionName
        in: path
        required: true
        type: string
        description: The name of the gallery Application Version to be retrieved.
      - name: $expand
        in: query
        required: false
        type: string
        description: The expand expression to apply on the operation.
        enum:
        - ReplicationStatus
        x-ms-enum:
          name: ReplicationStatusTypes
          modelAsString: true
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GalleryApplicationVersion'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get a gallery Application Version.:
          $ref: ./examples/GetAGalleryApplicationVersion.json
        Get a gallery Application Version with replication status.:
          $ref: ./examples/GetAGalleryApplicationVersionWithReplicationStatus.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Applications Galleryapplicationname Versions Galleryapplicationversionname
    delete:
      tags:
      - GalleryApplicationVersions
      operationId: microsoftAzureGalleryapplicationversionsDelete
      description: Delete a gallery Application Version.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: The name of the Shared Application Gallery in which the Application Definition resides.
      - name: galleryApplicationName
        in: path
        required: true
        type: string
        description: The name of the gallery Application Definition in which the Application Version resides.
      - name: galleryApplicationVersionName
        in: path
        required: true
        type: string
        description: The name of the gallery Application Version to be deleted.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete a gallery Application Version.:
          $ref: ./examples/DeleteAGalleryApplicationVersion.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Applications Galleryapplicationname Versions Galleryapplicationversionname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions
  : get:
      tags:
      - GalleryApplicationVersions
      operationId: microsoftAzureGalleryapplicationversionsListbygalleryapplication
      description: List gallery Application Versions in a gallery Application Definition.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        type: string
        description: The name of the Shared Application Gallery in which the Application Definition resides.
      - name: galleryApplicationName
        in: path
        required: true
        type: string
        description: The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GalleryApplicationVersionList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        List gallery Application Versions in a gallery Application Definition.:
          $ref: ./examples/ListGalleryApplicationVersionsInAGalleryApplication.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Applications Galleryapplicationname Versions
definitions:
  GalleryApplicationVersionPublishingProfile:
    properties:
      source:
        $ref: '#/definitions/UserArtifactSource'
      manageActions:
        $ref: '#/definitions/UserArtifactManage'
      enableHealthCheck:
        type: boolean
        description: Optional. Whether or not this application reports health.
    allOf:
    - $ref: '#/definitions/GalleryArtifactPublishingProfileBase'
    required:
    - source
    description: The publishing profile of a gallery image version.
  EncryptionImages:
    properties:
      osDiskImage:
        $ref: '#/definitions/OSDiskImageEncryption'
      dataDiskImages:
        type: array
        items:
          $ref: '#/definitions/DataDiskImageEncryption'
        description: A list of encryption specifications for data disk images.
    description: Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
  OSDiskImageEncryption:
    allOf:
    - $ref: '#/definitions/DiskImageEncryption'
    description: Contains encryption settings for an OS disk image.
  UserArtifactManage:
    properties:
      install:
        type: string
        description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters.
      remove:
        type: string
        description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters.
      update:
        type: string
        description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters.
    required:
    - install
    - remove
  UserArtifactSource:
    properties:
      mediaLink:
        type: string
        description: Required. The mediaLink of the artifact, must be a readable storage page blob.
      defaultConfigurationLink:
        type: string
        description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob.
    required:
    - mediaLink
    description: The source image from which the Image Version is going to be created.
  ApiErrorBase:
    properties:
      code:
        type: string
        description: The error code.
      target:
        type: string
        description: The target of the particular error.
      message:
        type: string
        description: The error message.
    description: Api error base.
  GalleryApplicationVersion:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/GalleryApplicationVersionProperties'
    allOf:
    - $ref: '#/definitions/Resource'
    description: Specifies information about the gallery Application Version that you want to create or update.
  Resource:
    description: The Resource model definition.
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      location:
        type: string
        description: Resource location
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
  DiskImageEncryption:
    properties:
      diskEncryptionSetId:
        type: string
        description: A relative URI containing the resource ID of the disk encryption set.
    description: This is the disk image encryption base class.
  UpdateResourceDefinition:
    description: The Update Resource model definition.
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    x-ms-azure-resource: true
  RegionalReplicationStatus:
    properties:
      region:
        readOnly: true
        type: string
        description: The region to which the gallery image version is being replicated to.
      state:
        readOnly: true
        type: string
        description: This is the regional replication state.
        enum:
        - Unknown
        - Replicating
        - Completed
        - Failed
        x-ms-enum:
          name: ReplicationState
          modelAsString: true
      details:
        readOnly: true
        type: string
        description: The details of the replication status.
      progress:
        readOnly: true
        type: integer
        format: int32
        description: It indicates progress of the replication job.
    description: This is the regional replication status.
  GalleryApplicationVersionUpdate:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/GalleryApplicationVersionProperties'
    allOf:
    - $ref: '#/definitions/UpdateResourceDefinition'
    description: Specifies information about the gallery Application Version that you want to update.
  GalleryApplicationVersionProperties:
    properties:
      publishingProfile:
        $ref: '#/definitions/GalleryApplicationVersionPublishingProfile'
      provisioningState:
        readOnly: true
        type: string
        title: The current state of the gallery Application Version.
        description: The provisioning state, which only appears in the response.
        enum:
        - Creating
        - Updating
        - Failed
        - Succeeded
        - Deleting
        - Migrating
      replicationStatus:
        readOnly: true
        $ref: '#/definitions/ReplicationStatus'
    required:
    - publishingProfile
    description: Describes the properties of a gallery image version.
  TargetRegion:
    properties:
      name:
        type: string
        description: The name of the region.
      regionalReplicaCount:
        type: integer
        format: int32
        description: The number of replicas of the Image Version to be created per region. This property is updatable.
      storageAccountType:
        type: string
        description: Specifies the storage account type to be used to store the image. This property is not updatable.
        enum:
        - Standard_LRS
        - Standard_ZRS
        - Premium_LRS
        x-ms-enum:
          name: StorageAccountType
          modelAsString: true
      encryption:
        $ref: '#/definitions/EncryptionImages'
    required:
    - name
    description: Describes the target region information.
  ReplicationStatus:
    properties:
      aggregatedState:
        readOnly: true
        type: string
        description: This is the aggregated replication status based on all the regional replication status flags.
        enum:
        - Unknown
        - InProgress
        - Completed
        - Failed
        x-ms-enum:
          name: AggregatedReplicationState
          modelAsString: true
      summary:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/RegionalReplicationStatus'
        description: This is a summary of replication status for each region.
    description: This is the replication status of the gallery image version.
  GalleryApplicationVersionList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/GalleryApplicationVersion'
        description: A list of gallery Application Versions.
      nextLink:
        type: string
        description: The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions.
    required:
    - value
    description: The List Gallery Application version operation response.
  DataDiskImageEncryption:
    properties:
      lun:
        type: integer
        format: int32
        description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine.
    allOf:
    - $ref: '#/definitions/DiskImageEncryption'
    required:
    - lun
    description: Contains encryption settings for a data disk image.
  CloudError:
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/ApiError'
    description: An error response from the Compute service.
  ApiError:
    properties:
      details:
        type: array
        items:
          $ref: '#/definitions/ApiErrorBase'
        description: The Api error details
      innererror:
        $ref: '#/definitions/InnerError'
        description: The Api inner error
      code:
        type: string
        description: The error code.
      target:
        type: string
        description: The target of the particular error.
      message:
        type: string
        description: The error message.
    description: Api error.
  InnerError:
    properties:
      exceptiontype:
        type: string
        description: The exception type.
      errordetail:
        type: string
        description: The internal error message or exception dump.
    description: Inner error details.
  GalleryArtifactPublishingProfileBase:
    properties:
      targetRegions:
        type: array
        items:
          $ref: '#/definitions/TargetRegion'
        description: The target regions where the Image Version is going to be replicated to. This property is updatable.
      replicaCount:
        type: integer
        format: int32
        description: The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
      excludeFromLatest:
        type: boolean
        description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
      publishedDate:
        readOnly: true
        type: string
        format: date-time
        description: The timestamp for when the gallery image version is published.
      endOfLifeDate:
        type: string
        format: date-time
        description: The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.
      storageAccountType:
        type: string
        description: Specifies the storage account type to be used to store the image. This property is not updatable.
        enum:
        - Standard_LRS
        - Standard_ZRS
        - Premium_LRS
        x-ms-enum:
          name: StorageAccountType
          modelAsString: true
    description: Describes the basic gallery artifact publishing profile.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The name of the resource group.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'