Custom Images - Get

Service:

Dev Test Labs

API Version:

2018-09-15

Get custom image.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}?api-version=2018-09-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}?$expand={$expand}&api-version=2018-09-15

URI Parameters

Name	In	Required	Type	Description
labName	path	True	string	The name of the lab.
name	path	True	string	The name of the custom image.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	Client API version.
$expand	query		string	Specify the $expand query. Example: 'properties($select=vm)'

Responses

Name	Type	Description
200 OK	CustomImage	OK
Other Status Codes	CloudError	BadRequest

Security

azure_auth

OAuth2 Implicit Grant

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

Scopes

Name	Description
user_impersonation	Access Microsoft Azure

Examples

CustomImages_Get

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{customImageName}?api-version=2018-09-15

Java

/** Samples for CustomImages Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/CustomImages_Get.json
     */
    /**
     * Sample code: CustomImages_Get.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void customImagesGet(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .customImages()
            .getWithResponse(
                "resourceGroupName", "{labName}", "{customImageName}", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python custom_images_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.custom_images.get(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{customImageName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/CustomImages_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/CustomImages_Get.json
func ExampleCustomImagesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCustomImagesClient().Get(ctx, "resourceGroupName", "{labName}", "{customImageName}", &armdevtestlabs.CustomImagesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomImage = armdevtestlabs.CustomImage{
	// 	Name: to.Ptr("{customImageName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs/customImages"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/customimages/{customImageName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Tags: map[string]*string{
	// 		"tagName1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armdevtestlabs.CustomImageProperties{
	// 		Description: to.Ptr("My Custom Image"),
	// 		Author: to.Ptr("{authorName}"),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-10T09:59:28.798Z"); return t}()),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 		VM: &armdevtestlabs.CustomImagePropertiesFromVM{
	// 			LinuxOsInfo: &armdevtestlabs.LinuxOsInfo{
	// 				LinuxOsState: to.Ptr(armdevtestlabs.LinuxOsStateNonDeprovisioned),
	// 			},
	// 			SourceVMID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get custom image.
 *
 * @summary Get custom image.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/CustomImages_Get.json
 */
async function customImagesGet() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{customImageName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.customImages.get(resourceGroupName, labName, name);
  console.log(result);
}

customImagesGet().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/CustomImages_Get.json
// this example is just showing the usage of "CustomImages_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DevTestLabCustomImageResource created on azure
// for more information of creating DevTestLabCustomImageResource, please refer to the document of DevTestLabCustomImageResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string name = "{customImageName}";
ResourceIdentifier devTestLabCustomImageResourceId = DevTestLabCustomImageResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, name);
DevTestLabCustomImageResource devTestLabCustomImage = client.GetDevTestLabCustomImageResource(devTestLabCustomImageResourceId);

// invoke the operation
DevTestLabCustomImageResource result = await devTestLabCustomImage.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DevTestLabCustomImageData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/customimages/{customImageName}",
  "name": "{customImageName}",
  "type": "Microsoft.DevTestLab/labs/customImages",
  "location": "{location}",
  "properties": {
    "description": "My Custom Image",
    "author": "{authorName}",
    "creationDate": "2021-10-10T09:59:28.7985144+00:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}",
    "vm": {
      "sourceVmId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
      "linuxOsInfo": {
        "linuxOsState": "NonDeprovisioned"
      }
    }
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitions

Name	Description
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
CustomImage	A custom image.
CustomImageOsType	The OS type of the custom image (i.e. Windows, Linux)
CustomImagePropertiesCustom	Properties for creating a custom image from a VHD.
CustomImagePropertiesFromPlan	Properties for plan on a custom image.
CustomImagePropertiesFromVm	Properties for creating a custom image from a virtual machine.
DataDiskStorageTypeInfo	Storage information about the data disks present in the custom image
LinuxOsInfo	Information about a Linux OS.
LinuxOsState	The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).
StorageType	The storage type for the disk (i.e. Standard, Premium).
WindowsOsInfo	Information about a Windows OS.
WindowsOsState	The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).

CloudError

Error from a REST request.

Name	Type	Description
error	CloudErrorBody	The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name	Type	Description
code	string	The error code.
details	CloudErrorBody[]	Inner errors.
message	string	The error message.
target	string	The error target.

CustomImage

A custom image.

Name	Type	Description
id	string	The identifier of the resource.
location	string	The location of the resource.
name	string	The name of the resource.
properties.author	string	The author of the custom image.
properties.creationDate	string	The creation date of the custom image.
properties.customImagePlan	CustomImagePropertiesFromPlan	Storage information about the plan related to this custom image
properties.dataDiskStorageInfo	DataDiskStorageTypeInfo[]	Storage information about the data disks present in the custom image
properties.description	string	The description of the custom image.
properties.isPlanAuthorized	boolean	Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
properties.managedImageId	string	The Managed Image Id backing the custom image.
properties.managedSnapshotId	string	The Managed Snapshot Id backing the custom image.
properties.provisioningState	string	The provisioning status of the resource.
properties.uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
properties.vhd	CustomImagePropertiesCustom	The VHD from which the image is to be created.
properties.vm	CustomImagePropertiesFromVm	The virtual machine from which the image is to be created.
tags	object	The tags of the resource.
type	string	The type of the resource.

CustomImageOsType

The OS type of the custom image (i.e. Windows, Linux)

Name	Type	Description
Linux	string
None	string
Windows	string

CustomImagePropertiesCustom

Properties for creating a custom image from a VHD.

Name	Type	Description
imageName	string	The image name.
osType	CustomImageOsType	The OS type of the custom image (i.e. Windows, Linux)
sysPrep	boolean	Indicates whether sysprep has been run on the VHD.

CustomImagePropertiesFromPlan

Properties for plan on a custom image.

Name	Type	Description
id	string	The id of the plan, equivalent to name of the plan
offer	string	The offer for the plan from the marketplace image the custom image is derived from
publisher	string	The publisher for the plan from the marketplace image the custom image is derived from

CustomImagePropertiesFromVm

Properties for creating a custom image from a virtual machine.

Name	Type	Description
linuxOsInfo	LinuxOsInfo	The Linux OS information of the VM.
sourceVmId	string	The source vm identifier.
windowsOsInfo	WindowsOsInfo	The Windows OS information of the VM.

DataDiskStorageTypeInfo

Storage information about the data disks present in the custom image

Name	Type	Description
lun	string	Disk Lun
storageType	StorageType	Disk Storage Type

LinuxOsInfo

Information about a Linux OS.

Name	Type	Description
linuxOsState	LinuxOsState	The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).

LinuxOsState

The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).

Name	Type	Description
DeprovisionApplied	string
DeprovisionRequested	string
NonDeprovisioned	string

StorageType

The storage type for the disk (i.e. Standard, Premium).

Name	Type	Description
Premium	string
Standard	string
StandardSSD	string

WindowsOsInfo

Information about a Windows OS.

Name	Type	Description
windowsOsState	WindowsOsState	The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).

WindowsOsState

The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).

Name	Type	Description
NonSysprepped	string
SysprepApplied	string
SysprepRequested	string