Share via

az lab formula

  • Preview

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

Manage formulas for an azure devtest lab.

Commands

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

Edit
Preview

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

Delete formula.

az lab formula delete --lab-name
                      --name
                      --resource-group
                      [--acquire-policy-token]
                      [--change-reference]
                      [--yes]

Required Parameters

--lab-name

The name of the lab.

--name -n

The name of the formula.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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 formula export-artifacts

Edit
Preview

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

Export artifacts from a formula.

az lab formula export-artifacts --lab-name
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--expand]

Required Parameters

--lab-name

The name of the lab.

--name -n

The name of the formula.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--expand

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

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

Edit
Preview

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

List formulas in a given lab.

az lab formula 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=description)'.

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

Edit
Preview

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

Show formula.

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

Required Parameters

--lab-name

The name of the lab.

--name -n

The name of the formula.

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

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