az footprint experiment

Commands to manage experiments under a profile.

Commands

az footprint experiment create

Creates or updates a Footprint experiment with the specified properties.

az footprint experiment delete

Deletes an existing Footprint experiment.

az footprint experiment list

Retrieves the information about all experiments under a Footprint profile.

az footprint experiment show

Retrieves the information about a single Footprint experiment.

az footprint experiment update

Creates or updates a Footprint experiment with the specified properties.

az footprint experiment create

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.

az footprint experiment delete

Deletes an existing Footprint experiment.

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

Examples

Delete an experiment.

az footprint experiment delete --name "fpExp1" --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

--yes -y

Do not prompt for confirmation.

az footprint experiment list

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

az footprint experiment show

Retrieves the information about a single Footprint experiment.

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

Examples

Get the details of an experiment.

az footprint experiment show --name "fpExp1" --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>.

az footprint experiment update

Creates or updates a Footprint experiment with the specified properties.

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

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.