az footprint profile

Commands to manage Footprint profiles.

Commands

az footprint profile create

Creates or updates a Footprint profile with the specified properties.

az footprint profile delete

Deletes an existing Footprint profile.

az footprint profile list

Retrieves the information about all Footprint profiles under a subscription.

az footprint profile show

Retrieves the information about a single Footprint profile.

az footprint profile update

Updates an existing Footprint profile resource.

az footprint profile create

Creates or updates a Footprint profile with the specified properties.

az footprint profile create --measurement-count
                            --name
                            --resource-group
                            --start-delay-ms
                            [--description]
                            [--location]
                            [--reporting-endpoints]
                            [--sample-rate-cold]
                            [--tags]

Examples

Create or update a Footprint profile.

az footprint profile create --location "westus2" --measurement-count 3 --start-delay-ms 5000 --tags key1="value1" key2="value2" --name "fpProfile1" --resource-group "rgName"

Required Parameters

--measurement-count

The number of measurements to perform.

--name --profile-name -n

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

--start-delay-ms

The delay in milliseconds that the clients should wait for until they start performing measurements.

Optional Parameters

--description

The description of the Footprint profile.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--reporting-endpoints

The endpoints which to upload measurements to.

--sample-rate-cold

The default sampling percentage for cold path measurement storage.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az footprint profile delete

Deletes an existing Footprint profile.

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

Examples

Delete a Footprint profile.

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

Required Parameters

--name --profile-name -n

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

Retrieves the information about all Footprint profiles under a subscription.

az footprint profile list [--resource-group]

Examples

List all Footprint profiles under a Resource Group.

az footprint profile list --resource-group "rgName"

Optional Parameters

--resource-group -g

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

az footprint profile show

Retrieves the information about a single Footprint profile.

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

Examples

Get the details of a Footprint profile.

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

Required Parameters

--name --profile-name -n

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 profile update

Updates an existing Footprint profile resource.

az footprint profile update --name
                            --resource-group
                            [--tags]

Examples

Update a Footprint profile.

az footprint profile update --tags key1="value1" key2="value2" --name "fpProfile1" --resource-group "rgName"

Required Parameters

--name --profile-name -n

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.