az lab environment

  • Preview
  • Reference

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 environment in a lab.

 Core Preview
az lab environment delete

Delete an environment from a lab.

 Core Preview
az lab environment list

List environments in a lab.

 Core Preview
az lab environment show

Get the details for an environment of a lab.

 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 environment in a lab.

az lab environment create --arm-template
                          --lab-name
                          --name
                          --resource-group
                          [--artifact-source-name]
                          [--parameters]
                          [--tags]

Required Parameters

--arm-template

Name or ID of the ARM template in the lab.

--lab-name

Name of the lab.

--name -n

Name of the environment.

--resource-group -g

Name of the lab's resource group.

Optional Parameters

--artifact-source-name

Name of the artifact source in the lab.

value from: az lab artifact-source list
--parameters

JSON encoded list of parameters. Use '@{file}' to load from a file.

--tags

The tags for the resource.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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 an environment from a lab.

az lab environment delete --lab-name
                          --name
                          --resource-group

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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

az lab environment list --lab-name
                        --resource-group
                        [--expand]
                        [--filter]
                        [--orderby]
                        [--top]

Examples

List environments in a lab. (autogenerated)

az lab environment list --lab-name MyLab --resource-group MyResourceGroup

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

--expand

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

--filter

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

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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 the details for an environment of a lab.

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

--expand

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.