Share via

az lab custom-image

  • Preview

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

Edit
Preview

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

--lab-name

The name of the lab.

--name -n

The name of the custom 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.

Property Value
Accepted values: Linux, Windows
--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--author

The author of the custom image.

--description

The description of the custom image.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--yes]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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]
                         [--max-items]
                         [--next-token]
                         [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--expand

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

--filter

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

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--expand

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az lab custom-image wait

Edit
Preview

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--expand

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

--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--lab-name

The name of the lab.

Property Value
Parameter group: Resource Id Arguments
--name

The name of the custom image.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False