Share via


az lab

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage azure devtest labs.

Commands

Name Description Type Status
az lab arm-template

Manage azure resource manager (ARM) templates in an azure devtest lab.

Core Preview
az lab arm-template list

List azure resource manager templates in a given artifact source.

Core Preview
az lab arm-template show

Show the details of an ARM template in a lab.

Core Preview
az lab artifact

Manage devtest labs artifacts.

Core Preview
az lab artifact-source

Manage devtest lab artifact sources.

Core Preview
az lab artifact-source list

List artifact sources in a given lab.

Core Preview
az lab artifact-source show

Show artifact source.

Core Preview
az lab artifact list

List artifacts in a given artifact source.

Core Preview
az lab custom-image

Manage custom images of a devtest lab.

Core Preview
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 delete

Delete lab. This operation can take a while to complete.

Core Preview
az lab environment

Manage environments for an azure devtest lab.

Core Preview
az lab environment create

Create an existing environment. This operation can take a while to complete.

Core Preview
az lab environment delete

Delete environment. This operation can take a while to complete.

Core Preview
az lab environment list

List environments in a given user profile.

Core Preview
az lab environment show

Get environment.

Core Preview
az lab environment wait

Place the CLI in a waiting state until a condition is met.

Core Preview
az lab formula

Manage formulas for an azure devtest lab.

Core Preview
az lab formula delete

Delete formula.

Core Preview
az lab formula export-artifacts

Export artifacts from a formula.

Core Preview
az lab formula list

List formulas in a given lab.

Core Preview
az lab formula show

Show formula.

Core Preview
az lab gallery-image

Manage lab gallery image.

Core Preview
az lab gallery-image list

List gallery images in a given lab.

Core Preview
az lab get

Get lab.

Core Preview
az lab secret

Manage secrets of an azure devtest lab.

Core Preview
az lab secret delete

Delete secret.

Core Preview
az lab secret list

List secrets in a given user profile.

Core Preview
az lab secret set

Set a secret for a lab.

Core Preview
az lab secret show

Get secret.

Core Preview
az lab secret wait

Place the CLI in a waiting state until a condition is met.

Core Preview
az lab vm

Manage VMs in an azure devtest lab.

Core Preview
az lab vm apply-artifacts

Apply artifacts to virtual machine. This operation can take a while to complete.

Core Preview
az lab vm claim

Command to claim a VM in the Azure DevTest Lab.

Core Preview
az lab vm create

Create a VM in a lab.

Core Preview
az lab vm delete

Delete virtual machine. This operation can take a while to complete.

Core Preview
az lab vm hibernate

Hibernate a virtual machine This operation can take a while to complete.

Core Preview
az lab vm list

List virtual machines in a given lab.

Core Preview
az lab vm show

Show virtual machine.

Core Preview
az lab vm start

Start a virtual machine. This operation can take a while to complete.

Core Preview
az lab vm stop

Stop a virtual machine This operation can take a while to complete.

Core Preview
az lab vm wait

Place the CLI in a waiting state until a condition is met.

Core Preview
az lab vnet

Manage virtual networks of an azure devtest lab.

Core Preview
az lab vnet get

Get virtual network.

Core Preview
az lab vnet list

List virtual networks in a given lab.

Core Preview
az lab wait

Place the CLI in a waiting state until a condition is met.

Core Preview

az lab delete

Preview

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

Delete lab. This operation can take a while to complete.

az lab delete --name
              --resource-group
              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
              [--yes]

Required Parameters

--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.

--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 get

Preview

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

Get lab.

az lab get --name
           --resource-group
           [--expand]

Required Parameters

--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=defaultStorageAccount)'.

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 wait

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 wait [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--expand]
            [--ids]
            [--interval]
            [--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=defaultStorageAccount)'.

--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
--name

The name of the lab.

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