Share via

az footprint profile

  • Experimental

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 profile 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 Footprint profiles.

Commands

Name Description Type Status
az footprint profile create

Creates or updates a Footprint profile with the specified properties.

 Extension Experimental
az footprint profile delete

Deletes an existing Footprint profile.

 Extension Experimental
az footprint profile list

Retrieves the information about all Footprint profiles under a subscription.

 Extension Experimental
az footprint profile show

Retrieves the information about a single Footprint profile.

 Extension Experimental
az footprint profile update

Updates an existing Footprint profile resource.

 Extension Experimental

az footprint profile create

Experimental

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

Creates or updates a Footprint profile with the specified properties.

az footprint profile create --measurement-count
                            --name --profile-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

Experimental

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

Deletes an existing Footprint profile.

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

Examples

Delete a Footprint profile.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --profile-name -n

Name of the Footprint profile resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az footprint profile list

Experimental

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

Experimental

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

Retrieves the information about a single Footprint profile.

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

Examples

Get the details of a Footprint profile.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --profile-name -n

Name of the Footprint profile resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az footprint profile update

Experimental

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

Updates an existing Footprint profile resource.

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

Examples

Update a Footprint profile.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --profile-name -n

Name of the Footprint profile resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tags

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

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False