Share via

az footprint experiment

  • Experimental
  • Reference

Note

This reference is part of the footprint extension for the Azure CLI (version 2.11.0 or higher). The extension will automatically install the first time you run an az footprint experiment command. Learn more about extensions.

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

Commands to manage experiments under a profile.

Commands

Name Description Type Status
az footprint experiment create

Creates or updates a Footprint experiment with the specified properties.

 Extension Experimental
az footprint experiment delete

Deletes an existing Footprint experiment.

 Extension Experimental
az footprint experiment list

Retrieves the information about all experiments under a Footprint profile.

 Extension Experimental
az footprint experiment show

Retrieves the information about a single Footprint experiment.

 Extension Experimental
az footprint experiment update

Creates or updates a Footprint experiment with the specified properties.

 Extension Experimental

az footprint experiment create

Experimental

Command group 'footprint experiment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates or updates a Footprint experiment with the specified properties.

az footprint experiment create --experiment-name
                               --profile-name
                               --resource-group
                               [--description]

Examples

Create or update an experiment.

az footprint experiment create --name "fpExp1" --description "An experiment description." --profile-name "fpProfile1" --resource-group "rgName"

Required Parameters

--experiment-name --name -n

Name of the Footprint experiment resource.

--profile-name

Name of the Footprint profile resource.

--resource-group -g

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

Optional Parameters

--description

The description of a Footprint experiment.

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 footprint experiment delete

Experimental

Command group 'footprint experiment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes an existing Footprint experiment.

az footprint experiment delete [--experiment-name]
                               [--ids]
                               [--profile-name]
                               [--resource-group]
                               [--subscription]
                               [--yes]

Examples

Delete an experiment.

az footprint experiment delete --name "fpExp1" --profile-name "fpProfile1" --resource-group "rgName"

Optional Parameters

--experiment-name --name -n

Name of the Footprint experiment resource.

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

--profile-name

Name of the Footprint profile resource.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
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 footprint experiment list

Experimental

Command group 'footprint experiment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Retrieves the information about all experiments under a Footprint profile.

az footprint experiment list --profile-name
                             --resource-group

Examples

List all experiments under a Footprint profile.

az footprint experiment list --profile-name "fpProfile1" --resource-group "rgName"

Required Parameters

--profile-name

Name of the Footprint profile resource.

--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 footprint experiment show

Experimental

Command group 'footprint experiment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Retrieves the information about a single Footprint experiment.

az footprint experiment show [--experiment-name]
                             [--ids]
                             [--profile-name]
                             [--resource-group]
                             [--subscription]

Examples

Get the details of an experiment.

az footprint experiment show --name "fpExp1" --profile-name "fpProfile1" --resource-group "rgName"

Optional Parameters

--experiment-name --name -n

Name of the Footprint experiment resource.

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

--profile-name

Name of the Footprint profile resource.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 footprint experiment update

Experimental

Command group 'footprint experiment' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates or updates a Footprint experiment with the specified properties.

az footprint experiment update [--description]
                               [--experiment-name]
                               [--ids]
                               [--profile-name]
                               [--resource-group]
                               [--subscription]

Optional Parameters

--description

The description of a Footprint experiment.

--experiment-name --name -n

Name of the Footprint experiment resource.

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

--profile-name

Name of the Footprint profile resource.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.