Gallery Application Versions - List By Gallery Application

List gallery Application Versions in a gallery Application Definition.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions?api-version=2019-12-01

URI Parameters

Name In Required Type Description
galleryApplicationName
path True
  • string

The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed.

galleryName
path True
  • string

The name of the Shared Application Gallery in which the Application Definition resides.

resourceGroupName
path True
  • string

The name of the resource group.

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions?api-version=2019-12-01

Sample Response

{
  "value": [
    {
      "location": "West US",
      "name": "1.0.0",
      "type": "Microsoft.Compute/galleries/applications/versions",
      "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0",
      "properties": {
        "publishingProfile": {
          "source": {
            "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
          },
          "manageActions": {
            "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"",
            "remove": "del C:\\package "
          },
          "enableHealthCheck": false,
          "targetRegions": [
            {
              "name": "West US",
              "regionalReplicaCount": 1,
              "storageAccountType": "Standard_LRS"
            }
          ],
          "replicaCount": 1,
          "excludeFromLatest": false,
          "publishedDate": "2019-06-21T17:13:57.5972568+00:00",
          "endOfLifeDate": "2019-07-01T07:00:00+00:00",
          "storageAccountType": "Standard_LRS"
        },
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/applications/myGalleryApplicationName/versions/myGalleryApplicationVersionName"
}

Definitions

AggregatedReplicationState

This is the aggregated replication status based on all the regional replication status flags.

ApiError

Api error.

ApiErrorBase

Api error base.

CloudError

An error response from the Compute service.

DataDiskImageEncryption

Contains encryption settings for a data disk image.

EncryptionImages

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

GalleryApplicationVersion

Specifies information about the gallery Application Version that you want to create or update.

GalleryApplicationVersionList

The List Gallery Application version operation response.

GalleryApplicationVersionPublishingProfile

The publishing profile of a gallery image version.

InnerError

Inner error details.

OSDiskImageEncryption

Contains encryption settings for an OS disk image.

RegionalReplicationStatus

This is the regional replication status.

ReplicationState

This is the regional replication state.

ReplicationStatus

This is the replication status of the gallery Image Version.

StorageAccountType

Specifies the storage account type to be used to store the image. This property is not updatable.

TargetRegion

Describes the target region information.

UserArtifactManage
UserArtifactSource

The source image from which the Image Version is going to be created.

AggregatedReplicationState

This is the aggregated replication status based on all the regional replication status flags.

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string
Unknown
  • string

ApiError

Api error.

Name Type Description
code
  • string

The error code.

details

The Api error details

innererror

The Api inner error

message
  • string

The error message.

target
  • string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the particular error.

CloudError

An error response from the Compute service.

Name Type Description
error

Api error.

DataDiskImageEncryption

Contains encryption settings for a data disk image.

Name Type Description
diskEncryptionSetId
  • string

A relative URI containing the resource ID of the disk encryption set.

lun
  • integer

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.

EncryptionImages

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

Name Type Description
dataDiskImages

A list of encryption specifications for data disk images.

osDiskImage

Contains encryption settings for an OS disk image.

GalleryApplicationVersion

Specifies information about the gallery Application Version that you want to create or update.

Name Type Description
id
  • string

Resource Id

location
  • string

Resource location

name
  • string

Resource name

properties.provisioningState enum:
  • Creating
  • Deleting
  • Failed
  • Migrating
  • Succeeded
  • Updating

The current state of the gallery Application Version.
The provisioning state, which only appears in the response.

properties.publishingProfile

The publishing profile of a gallery image version.

properties.replicationStatus

This is the replication status of the gallery Image Version.

tags
  • object

Resource tags

type
  • string

Resource type

GalleryApplicationVersionList

The List Gallery Application version operation response.

Name Type Description
nextLink
  • string

The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions.

value

A list of gallery Application Versions.

GalleryApplicationVersionPublishingProfile

The publishing profile of a gallery image version.

Name Type Description
enableHealthCheck
  • boolean

Optional. Whether or not this application reports health.

endOfLifeDate
  • string

The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.

excludeFromLatest
  • boolean

If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.

manageActions
publishedDate
  • string

The timestamp for when the gallery Image Version is published.

replicaCount
  • integer

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.

source

The source image from which the Image Version is going to be created.

storageAccountType

Specifies the storage account type to be used to store the image. This property is not updatable.

targetRegions

The target regions where the Image Version is going to be replicated to. This property is updatable.

InnerError

Inner error details.

Name Type Description
errordetail
  • string

The internal error message or exception dump.

exceptiontype
  • string

The exception type.

OSDiskImageEncryption

Contains encryption settings for an OS disk image.

Name Type Description
diskEncryptionSetId
  • string

A relative URI containing the resource ID of the disk encryption set.

RegionalReplicationStatus

This is the regional replication status.

Name Type Description
details
  • string

The details of the replication status.

progress
  • integer

It indicates progress of the replication job.

region
  • string

The region to which the gallery Image Version is being replicated to.

state

This is the regional replication state.

ReplicationState

This is the regional replication state.

Name Type Description
Completed
  • string
Failed
  • string
Replicating
  • string
Unknown
  • string

ReplicationStatus

This is the replication status of the gallery Image Version.

Name Type Description
aggregatedState

This is the aggregated replication status based on all the regional replication status flags.

summary

This is a summary of replication status for each region.

StorageAccountType

Specifies the storage account type to be used to store the image. This property is not updatable.

Name Type Description
Premium_LRS
  • string
Standard_LRS
  • string
Standard_ZRS
  • string

TargetRegion

Describes the target region information.

Name Type Description
encryption

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

name
  • string

The name of the region.

regionalReplicaCount
  • integer

The number of replicas of the Image Version to be created per region. This property is updatable.

storageAccountType

Specifies the storage account type to be used to store the image. This property is not updatable.

UserArtifactManage

Name Type Description
install
  • string

Required. The path and arguments to install the gallery application. This is limited to 4096 characters.

remove
  • string

Required. The path and arguments to remove the gallery application. This is limited to 4096 characters.

update
  • string

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.

UserArtifactSource

The source image from which the Image Version is going to be created.

Name Type Description
defaultConfigurationLink
  • string

Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob.

mediaLink
  • string

Required. The mediaLink of the artifact, must be a readable storage page blob.