az lab environment

  • Preview

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

Manage environments for an azure devtest lab.

Commands

Name Description Type Status
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 create

Edit
Preview

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

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

az lab environment create --arm-template
                          --lab-name
                          --name
                          --resource-group
                          [--artifact-source-name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--parameters]
                          [--tags]

Required Parameters

--arm-template

Name or ID of the ARM template in the lab.

--lab-name

The name of the lab.

--name -n

The name of the environment.

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

--artifact-source-name

Name of the artifact source in the lab. Values from: az lab artifact-source list.

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

Path to the parameters of the azure resource manager template. JSON encoded list of parameters.

--tags

The tags of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 environment delete

Edit
Preview

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

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

az lab environment 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 -n

The name of the environment.

--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 environment list

Edit
Preview

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

List environments in a given user profile.

az lab environment list --lab-name
                        --resource-group
                        [--expand]
                        [--filter]
                        [--max-items]
                        [--next-token]
                        [--orderby]
                        [--top]

Examples

List environments in a lab.

az lab environment list --lab-name Lab --resource-group rg

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

--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 environment show

Edit
Preview

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

Get environment.

az lab environment show --lab-name
                        --name
                        --resource-group
                        [--expand]

Required Parameters

--lab-name

The name of the lab.

--name -n

The name of the environment.

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

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