This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Virtual Machines Snapshots

This section explains how to get a list with Microsoft Azure snapshots.

Request

GET https://<hostname>/api/v1/virtualMachineSnapshots

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
offset	integer	Shows the offset value.
limit	integer	Shows the offset limit.
results	Results Object	Contains the Results object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Results Object

Property	Type	Description
vmId	string	Shows the identification number of the Azure virtual machine.
vmAzureResourceId	string	Shows the identification number of the Azure resource.
name	string	Shows the name of the Azure virtual machine.
subscription	AzureSubscription Object	Contains the subscription object.
resourceGroup	ResourceGroup Object	Contains the resource object.
region	Region Object	Contains the region object.
size	string	Shows the size of the Azure virtual machine.
osDisk	VmDiskSnapshot Object	Contains the disk snapshot object.
dataDisks	string	Shows the data disks.
virtualNetwork	VirtualNetwork Object	Contains the virtual network object.
subnet	VirtualNetworkSubnetBase Object	Contains the subnet object.
networkSecurityGroup	NetworkSecurityGroup Object	Contains the network security group object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

AzureSubscription Object

Property	Type	Description
id	string	Shows the identification number of the Azure subscription.
environment	string	Shows the Azure environment.
tenantId	string	Shows the identification number of the tenant.
name	string	Shows the name of the Azure subscription.
status	string	Shows the status of the Azure subscription.

ResourceGroup Object

Property	Type	Description
id	string	Shows the identification number of the Azure resource group.
resourceId	string	Shows the identification number of the resource.
name	string	Shows the name if the resource group.
azureEnvironment	string	Shows the Azure environment.
subscriptionId	string	Shows the identification number of the subscription.
regionId	string	Shows the identification number of the region.

Region Object

Property	Type	Description
id	string	Shows the identification number of the region.
name	string	Shows the name of the region.

VmDiskSnapshot Object

Property	Type	Description
diskId	string	Shows the identification number of the disk snapshot.
name	string	Shows the name of the snapshot.

VirtualNetwork Object

Property	Type	Description
id	string	Shows the identification number of the virtual network.
name	string	Shows the name if the virtual network.
regionName	string	Shows the name of the region to which the virtual network belongs.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

VirtualNetworkSubnetBase Object

Property	Type	Description
name	string	Shows the name of the virtual subnetwork.

NetworkSecurityGroup Object

Property	Type	Description
id	string	Shows the identification number of the security group.
name	string	Shows the name of the security group.
regionId	string	Shows the identification number of the region to which the network security group belongs.
resourceGroupName	string	Shows the name of the resource group to which the network security group belongs.

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/virtualMachineSnapshots

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [

{

"vmId": "bp6tt895tumar59kbez87wsa1pqup6zy8kjo9n77tx819197o8dy",

"vmAzureResourceId": "/subscriptions/d55989e4-f37f-429a-98f3-14787540673f/resourcegroups/test-resource-group/providers/microsoft.compute/virtualmachines/test-linux",

"name": "test-linux",

"subscription": {

"id": "d55989e4-f37f-429a-98f3-14787540673f",

"environment": "Global",

"tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

"name": "Enterprise - R&D - Azure Lighthouse",

"status": "Active"

"resourceGroup": {

"id": "f8461y3mrgug15ttwz89oie7acca4geo9qrkp68fgwwnnp96yduo",

"resourceId": "/subscriptions/d55989e4-f37f-429a-98f3-14787540673f/resourcegroups/test-resource-group",

"name": "test-resource-group",

"azureEnvironment": "Global",

"subscriptionId": "d55989e4-f37f-429a-98f3-14787540673f",

"regionId": "northeurope"

"region": {

"id": "northeurope",

"name": "North Europe"

"size": "Standard_B1ls",

"osDisk": {

"diskId": "tgdq8pjtnby58akmphhgq5m8to99ap39uzzgd4azkcowt7xuzz1o",

"name": "test-linux_disk1_8dfe9807186543d68d50175d7ad98f0a"

"dataDisks": [],

"virtualNetwork": {

"id": "/subscriptions/d55989e4-f37f-429a-98f3-14787540673f/resourceGroups/Test-Resource-Group/providers/Microsoft.Network/virtualNetworks/Test-Resource-Group-vnet",

"name": "Test-Resource-Group-vnet",

"regionName": "northeurope",

"_links": {}

"subnet": {"name": "default"},

"networkSecurityGroup": {

"id": "/subscriptions/d55989e4-f37f-429a-98f3-14787540673f/resourcegroups/test-resource-group/providers/microsoft.network/networksecuritygroups/test-linux-nsg",

"name": "test-linux-nsg",

"regionId": "northeurope",

"resourceGroupName": "test-resource-group"

"_links": {

"disks": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/diskSnapshots?restorePointId=a3687ba6-6f6b-44bd-8475-0979b1bce276&virtualMachineId=bp6tt895tumar59kbez87wsa1pqup6zy8kjo9n77tx819197o8dy"},

"restorepoint": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/restorePoints/a3687ba6-6f6b-44bd-8475-0979b1bce276"}

}

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/virtualMachineSnapshots?offset=0&limit=30"}}

}