Microsoft Azure GalleryApplicationVersions API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Gallery Application Versions API
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: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition resides.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application Definition in which the Application Version is to be created.
        schema:
          type: string
      - name: galleryApplicationVersionName
        in: path
        required: true
        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>'
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplicationVersion'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplicationVersion'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplicationVersion'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GalleryApplicationVersion'
        description: Parameters supplied to the create or update gallery Application Version operation.
        required: true
    patch:
      tags:
      - GalleryApplicationVersions
      operationId: microsoftAzureGalleryapplicationversionsUpdate
      description: Update a gallery Application Version.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition resides.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application Definition in which the Application Version is to be updated.
        schema:
          type: string
      - name: galleryApplicationVersionName
        in: path
        required: true
        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>'
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplicationVersion'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GalleryApplicationVersionUpdate'
        description: Parameters supplied to the update gallery Application Version operation.
        required: true
    get:
      tags:
      - GalleryApplicationVersions
      operationId: microsoftAzureGalleryapplicationversionsGet
      description: Retrieves information about a gallery Application Version.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition resides.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application Definition in which the Application Version resides.
        schema:
          type: string
      - name: galleryApplicationVersionName
        in: path
        required: true
        description: The name of the gallery Application Version to be retrieved.
        schema:
          type: string
      - name: $expand
        in: query
        required: false
        description: The expand expression to apply on the operation.
        x-ms-enum:
          name: ReplicationStatusTypes
          modelAsString: true
        schema:
          type: string
          enum:
          - ReplicationStatus
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplicationVersion'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition resides.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the gallery Application Definition in which the Application Version resides.
        schema:
          type: string
      - name: galleryApplicationVersionName
        in: path
        required: true
        description: The name of the gallery Application Version to be deleted.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: galleryName
        in: path
        required: true
        description: The name of the Shared Application Gallery in which the Application Definition resides.
        schema:
          type: string
      - name: galleryApplicationName
        in: path
        required: true
        description: The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GalleryApplicationVersionList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
components:
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      x-ms-parameter-location: method
      description: The name of the resource group.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
  schemas:
    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.
    InnerError:
      properties:
        exceptiontype:
          type: string
          description: The exception type.
        errordetail:
          type: string
          description: The internal error message or exception dump.
      description: Inner error details.
    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
    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: '#/components/schemas/RegionalReplicationStatus'
          description: This is a summary of replication status for each region.
      description: This is the replication status of the gallery image version.
    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.
    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.
    GalleryArtifactPublishingProfileBase:
      properties:
        targetRegions:
          type: array
          items:
            $ref: '#/components/schemas/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.
    GalleryApplicationVersionList:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/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.
    GalleryApplicationVersionUpdate:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/GalleryApplicationVersionProperties'
      allOf:
      - $ref: '#/components/schemas/UpdateResourceDefinition'
      description: Specifies information about the gallery Application Version that you want to update.
    GalleryApplicationVersionProperties:
      properties:
        publishingProfile:
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/EncryptionImages'
      required:
      - name
      description: Describes the target region information.
    GalleryApplicationVersionPublishingProfile:
      properties:
        source:
          $ref: '#/components/schemas/UserArtifactSource'
        manageActions:
          $ref: '#/components/schemas/UserArtifactManage'
        enableHealthCheck:
          type: boolean
          description: Optional. Whether or not this application reports health.
      allOf:
      - $ref: '#/components/schemas/GalleryArtifactPublishingProfileBase'
      required:
      - source
      description: The publishing profile of a gallery image version.
    ApiError:
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorBase'
          description: The Api error details
        innererror:
          $ref: '#/components/schemas/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.
    GalleryApplicationVersion:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/GalleryApplicationVersionProperties'
      allOf:
      - $ref: '#/components/schemas/Resource'
      description: Specifies information about the gallery Application Version that you want to create or update.
    CloudError:
      x-ms-external: true
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
      description: An error response from the Compute service.
    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
    EncryptionImages:
      properties:
        osDiskImage:
          $ref: '#/components/schemas/OSDiskImageEncryption'
        dataDiskImages:
          type: array
          items:
            $ref: '#/components/schemas/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.
    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.
    OSDiskImageEncryption:
      allOf:
      - $ref: '#/components/schemas/DiskImageEncryption'
      description: Contains encryption settings for an OS disk image.
    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: '#/components/schemas/DiskImageEncryption'
      required:
      - lun
      description: Contains encryption settings for a data disk image.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'