az lab custom-image

  • Preview
  • Reference

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage custom images of a DevTest Lab.

Commands

Name Description Type Status
az lab custom-image create

Create a custom image in a DevTest Lab.

 Core Preview
az lab custom-image delete

Delete custom image.

 Core Preview
az lab custom-image list

List custom images in a given lab.

 Core Preview
az lab custom-image show

Get custom image.

 Core Preview

az lab custom-image create

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a custom image in a DevTest Lab.

az lab custom-image create --lab-name
                           --name
                           --os-state
                           --os-type
                           --resource-group
                           --source-vm-id
                           [--author]
                           [--description]

Examples

Create a custom image in the lab from a running Windows virtual machine without applying sysprep.

az lab custom-image create --lab-name {LabName} -g {ResourceGroup} --name {VMName} \
    --os-type Windows --os-state NonSysprepped \
    --source-vm-id "/subscriptions/{SubID}/resourcegroups/{ResourceGroup}/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName}"

Required Parameters

--lab-name

Name of the Lab.

--name -n

Name of the image.

--os-state

The current state of the virtual machine.

For Windows virtual machines: NonSysprepped, SysprepRequested, SysprepApplied For Linux virtual machines: NonDeprovisioned, DeprovisionRequested, DeprovisionApplied.

--os-type

Type of the OS on which the custom image is based. Allowed values are: Windows, Linux.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source-vm-id

The resource ID of a virtual machine in the provided lab.

Optional Parameters

--author

The author of the custom image.

--description

A detailed description for the custom image.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab custom-image delete

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete custom image.

This operation can take a while to complete.

az lab custom-image delete --lab-name
                           --name
                           --resource-group

Required Parameters

--lab-name

The name of the lab.

--name

The name of the custom image.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab custom-image list

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List custom images in a given lab.

az lab custom-image list --lab-name
                         --resource-group
                         [--expand]
                         [--filter]
                         [--orderby]
                         [--top]

Required Parameters

--lab-name

The name of the lab.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--expand

Specify the $expand query. Example: 'properties($select=vm)'.

--filter

The filter to apply to the operation. Example: '$filter=contains(name,'myName').

--orderby

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.

--top

The maximum number of resources to return from the operation. Example: '$top=10'.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab custom-image show

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get custom image.

az lab custom-image show --lab-name
                         --name
                         --resource-group
                         [--expand]

Required Parameters

--lab-name

The name of the lab.

--name

The name of the custom image.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--expand

Specify the $expand query. Example: 'properties($select=vm)'.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.