Gallery Image Versions - Get

Reference

Service:: Compute

API Version:: 2018-06-01

Retrieves information about a gallery Image Version.

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}?api-version=2018-06-01

With optional parameters:

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}?$expand=ReplicationStatus&api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
galleryImageName	path	True	string	The name of the gallery Image Definition in which the Image Version resides.
galleryImageVersionName	path	True	string	The name of the gallery Image Version to be retrieved.
galleryName	path	True	string	The name of the Shared Image Gallery in which the Image 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.
$expand	query		ReplicationStatusTypes	The expand expression to apply on the operation.

Responses

Name	Type	Description
200 OK	GalleryImageVersion	OK
Other Status Codes	CloudError	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

Get a gallery Image Version with replication status.

Get a gallery Image Version.

Get a gallery Image Version with replication status.

Sample request

HTTP

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions/1.0.0?$expand=ReplicationStatus&api-version=2018-06-01

Sample response

Status code:: 200

JSON

{
  "properties": {
    "publishingProfile": {
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1
        },
        {
          "name": "East US",
          "regionalReplicaCount": 2
        }
      ],
      "source": {
        "managedImage": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}"
        }
      },
      "replicaCount": 1,
      "publishedDate": "2018-01-01T00:00:00Z"
    },
    "storageProfile": {
      "osDiskImage": {
        "sizeInGB": 10,
        "hostCaching": "ReadOnly"
      },
      "dataDiskImages": [
        {
          "lun": 1,
          "sizeInGB": 10,
          "hostCaching": "None"
        }
      ]
    },
    "replicationStatus": {
      "aggregatedState": "Completed",
      "summary": [
        {
          "region": "West US",
          "state": "Completed",
          "details": "",
          "progress": 100
        },
        {
          "region": "East US",
          "state": "Completed",
          "details": "",
          "progress": 100
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "location": "West US",
  "name": "1.0.0"
}

Get a gallery Image Version.

Sample request

HTTP

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions/1.0.0?$expand=ReplicationStatus&api-version=2018-06-01

Sample response

Status code:: 200

JSON

{
  "properties": {
    "publishingProfile": {
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1
        },
        {
          "name": "East US",
          "regionalReplicaCount": 2
        }
      ],
      "source": {
        "managedImage": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}"
        }
      },
      "replicaCount": 1,
      "publishedDate": "2018-01-01T00:00:00Z"
    },
    "storageProfile": {
      "osDiskImage": {
        "sizeInGB": 10,
        "hostCaching": "ReadOnly"
      },
      "dataDiskImages": [
        {
          "lun": 1,
          "sizeInGB": 10,
          "hostCaching": "None"
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "location": "West US",
  "name": "1.0.0"
}

Definitions

Name	Description
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 Gallery service.
GalleryArtifactSource	The source image from which the Image Version is going to be created.
GalleryDataDiskImage	This is the data disk image.
GalleryImageVersion	Specifies information about the gallery Image Version that you want to create or update.
GalleryImageVersionPublishingProfile	The publishing profile of a gallery Image Version.
GalleryImageVersionStorageProfile	This is the storage profile of a gallery Image Version.
GalleryOSDiskImage	This is the OS disk image.
HostCaching	The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'
InnerError	Inner error details.
ManagedArtifact	The managed artifact.
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.
ReplicationStatusTypes	The expand expression to apply on the operation.
TargetRegion	Describes the target region information.

AggregatedReplicationState

Enumeration

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

Value	Description
Completed
Failed
InProgress
Unknown

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

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

Object

An error response from the Gallery service.

Name	Type	Description
error	ApiError	Api error.

GalleryArtifactSource

Object

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

Name	Type	Description
managedImage	ManagedArtifact	The managed artifact.

GalleryDataDiskImage

Object

This is the data disk image.

Name	Type	Description
hostCaching	HostCaching	The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'
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.
sizeInGB	integer	This property indicates the size of the VHD to be created.