Share via


az lab arm-template

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

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

Commands

Name Description Type Status
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 arm-template list

Preview

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

List azure resource manager templates in a given artifact source.

az lab arm-template list --artifact-source-name
                         --lab-name
                         --resource-group
                         [--expand]
                         [--filter]
                         [--max-items]
                         [--next-token]
                         [--orderby]
                         [--top]

Required Parameters

--artifact-source-name

The name of the artifact source.

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

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

--next-token

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

--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 arm-template show

Preview

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

Show the details of an ARM template in a lab.

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

Required Parameters

--artifact-source-name

The name of the artifact source.

--lab-name

The name of the lab.

--name -n

The name of the azure resource manager template.

--resource-group -g

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

Optional Parameters

--export-parameters

Whether or not to export parameters template.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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.