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 an existing custom image. This operation can take a while to complete. |
Core | Preview |
| az lab custom-image delete |
Delete custom image. This operation can take a while to complete. |
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 wait |
Place the CLI in a waiting state until a condition is met. |
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 an existing custom image. This operation can take a while to complete.
az lab custom-image create --lab-name
--name
--os-state
--os-type {Linux, Windows}
--resource-group
--source-vm-id
[--author]
[--description]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]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}/providers/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName}"Required Parameters
The name of the lab.
The name of the custom 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.
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.
The description of the custom image.
Do not wait for the long-running operation to finish.
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
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--yes]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
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
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]
[--max-items]
[--next-token]
[--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').
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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.
az lab custom-image wait
Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az lab custom-image wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--ids]
[--interval]
[--lab-name]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Specify the $expand query. Example: 'properties($select=vm)'.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
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>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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.
