az lab custom-image
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
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
Name of the Lab.
Name of the image.
The current state of the virtual machine.
For Windows virtual machines: NonSysprepped, SysprepRequested, SysprepApplied For Linux virtual machines: NonDeprovisioned, DeprovisionRequested, DeprovisionApplied.
Type of the OS on which the custom image is based. Allowed values are: Windows, Linux.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The resource ID of a virtual machine in the provided lab.
Optional Parameters
The author of the custom image.
A detailed description for the custom image.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az lab custom-image delete
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
The name of the lab.
The name of the custom image.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az lab custom-image list
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
The name of the lab.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Specify the $expand query. Example: 'properties($select=vm)'.
The filter to apply to the operation. Example: '$filter=contains(name,'myName').
The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
The maximum number of resources to return from the operation. Example: '$top=10'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az lab custom-image show
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
The name of the lab.
The name of the custom image.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Specify the $expand query. Example: 'properties($select=vm)'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.