az footprint measurement-endpoint

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 measurement-endpoint 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 measurement endpoints under a profile.

Commands

Name	Description	Type	Status
az footprint measurement-endpoint create	Creates or updates a single measurement endpoint under a Footprint profile with the specified properties.	Extension	Experimental
az footprint measurement-endpoint delete	Deletes an existing measurement endpoint under a Footprint profile.	Extension	Experimental
az footprint measurement-endpoint list	Retrieves the information about all measurement endpoints under a Footprint profile.	Extension	Experimental
az footprint measurement-endpoint show	Retrieves the information about a single measurement endpoint under a Footprint profile.	Extension	Experimental
az footprint measurement-endpoint update	Creates or updates a single measurement endpoint under a Footprint profile with the specified properties.	Extension	Experimental

az footprint measurement-endpoint create

Experimental

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

Creates or updates a single measurement endpoint under a Footprint profile with the specified properties.

az footprint measurement-endpoint create --endpoint
                                         --measurement-endpoint-name --name
                                         --measurement-type
                                         --profile-name
                                         --resource-group
                                         --weight
                                         [--description]
                                         [--end-time-utc]
                                         [--experiment-id]
                                         [--metadata]
                                         [--object-path]
                                         [--sample-rate-cold]
                                         [--sample-rate-hot]
                                         [--sample-rate-warm]
                                         [--start-time-utc]

Examples

Create or update a measurement endpoint.

az footprint measurement-endpoint create --name "endpoint1" --endpoint "www.contoso.com" --experiment-id "664cdec4f07d4e1083c9b3969ee2c49b" --measurement-type 2 --object-path "/trans.gif" --weight 10 --profile-name "fpProfile1" --resource-group "rgName"

Required Parameters

--endpoint

The value of a measurement endpoint.

--measurement-endpoint-name --name -n

Name of the Footprint measurement endpoint resource.

--measurement-type

The type of a measurement endpoint.

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

--weight

The weight of a measurement endpoint, higher weight means higher priority.

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 a measurement endpoint.

--end-time-utc

The end time that a measurement endpoint should be served.

--experiment-id

The id of an experiment that a measurement endpoint is part of.

--metadata

The metadata of a measurement endpoint.

--object-path

The path of the object that a measurement endpoint points to.

--sample-rate-cold

The percentual sampling rate for the cold path logging of a measurement endpoint.

--sample-rate-hot

The percentual sampling rate for the hot path logging of a measurement endpoint.

--sample-rate-warm

The percentual sampling rate for the warm path logging of a measurement endpoint.

--start-time-utc

The start time that a measurement endpoint should be served.

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 measurement-endpoint delete

Experimental

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

Deletes an existing measurement endpoint under a Footprint profile.

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

Examples

Delete a measurement endpoint.

az footprint measurement-endpoint delete --name "endpoint1" --profile-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

--measurement-endpoint-name --name -n

Name of the Footprint measurement endpoint resource.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

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 measurement-endpoint list

Experimental

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

Retrieves the information about all measurement endpoints under a Footprint profile.

az footprint measurement-endpoint list --profile-name
                                       --resource-group

Examples

List all the measurement endpoints under a Footprint profile.

az footprint measurement-endpoint 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.

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 measurement-endpoint show

Experimental

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

Retrieves the information about a single measurement endpoint under a Footprint profile.

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

Examples

Get the details of a measurement endpoint.

az footprint measurement-endpoint show --name "endpoint1" --profile-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

--measurement-endpoint-name --name -n

Name of the Footprint measurement endpoint resource.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

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 measurement-endpoint update

Experimental

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

Creates or updates a single measurement endpoint under a Footprint profile with the specified properties.

az footprint measurement-endpoint update --endpoint
                                         --measurement-type
                                         --weight
                                         [--description]
                                         [--end-time-utc]
                                         [--experiment-id]
                                         [--ids]
                                         [--measurement-endpoint-name --name]
                                         [--metadata]
                                         [--object-path]
                                         [--profile-name]
                                         [--resource-group]
                                         [--sample-rate-cold]
                                         [--sample-rate-hot]
                                         [--sample-rate-warm]
                                         [--start-time-utc]
                                         [--subscription]

Required Parameters

--endpoint

The value of a measurement endpoint.

--measurement-type

The type of a measurement endpoint.

--weight

The weight of a measurement endpoint, higher weight means higher priority.

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 a measurement endpoint.

--end-time-utc

The end time that a measurement endpoint should be served.

--experiment-id

The id of an experiment that a measurement endpoint is part of.

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

--measurement-endpoint-name --name -n

Name of the Footprint measurement endpoint resource.

Property	Value
Parameter group:	Resource Id Arguments

--metadata

The metadata of a measurement endpoint.

--object-path

The path of the object that a measurement endpoint points to.

--profile-name

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

--sample-rate-cold

The percentual sampling rate for the cold path logging of a measurement endpoint.

--sample-rate-hot

The percentual sampling rate for the hot path logging of a measurement endpoint.

--sample-rate-warm

The percentual sampling rate for the warm path logging of a measurement endpoint.

--start-time-utc

The start time that a measurement endpoint should be served.

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