az networkcloud cluster metricsconfiguration

Note

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

Manage cluster's metrics configuration.

Commands

Name	Description	Type	Status
az networkcloud cluster metricsconfiguration create	Create the metrics configuration of the provided cluster.	Extension	GA
az networkcloud cluster metricsconfiguration delete	Delete the metrics configuration of the provided cluster.	Extension	GA
az networkcloud cluster metricsconfiguration list	List metrics configurations of the cluster.	Extension	GA
az networkcloud cluster metricsconfiguration show	Get metrics configuration of the provided cluster.	Extension	GA
az networkcloud cluster metricsconfiguration update	Update properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.	Extension	GA
az networkcloud cluster metricsconfiguration wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az networkcloud cluster metricsconfiguration create

Create the metrics configuration of the provided cluster.

az networkcloud cluster metricsconfiguration create --cluster-name
                                                    --collection-interval
                                                    --extended-location
                                                    --resource-group
                                                    [--enabled-metrics]
                                                    [--if-match]
                                                    [--if-none-match]
                                                    [--location]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--tags]

Examples

Create or update metrics configuration of cluster

az networkcloud cluster metricsconfiguration create --cluster-name "clusterName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --location "location" --collection-interval 15 --enabled-metrics "metric1" "metric2" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

Required Parameters

--cluster-name

The name of the cluster.

--collection-interval

The interval in minutes by which metrics will be collected.

Property	Value
Parameter group:	Properties Arguments

--extended-location

The extended location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	MetricsConfigurationParameters Arguments

--resource-group -g

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

Optional Parameters

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

--enabled-metrics

The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	MetricsConfigurationParameters Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--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 networkcloud cluster metricsconfiguration delete

Delete the metrics configuration of the provided cluster.

az networkcloud cluster metricsconfiguration delete [--cluster-name]
                                                    [--ids]
                                                    [--if-match]
                                                    [--if-none-match]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--yes]

Examples

Delete metrics configuration of cluster

az networkcloud cluster metricsconfiguration delete --cluster-name "clusterName" --resource-group "resourceGroupName"

Optional Parameters

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

--cluster-name

The name of the cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--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 networkcloud cluster metricsconfiguration list

List metrics configurations of the cluster.

az networkcloud cluster metricsconfiguration list --cluster-name
                                                  --resource-group
                                                  [--max-items]
                                                  [--next-token]

Examples

List metrics configurations of the cluster

az networkcloud cluster metricsconfiguration list --cluster-name "clusterName" --resource-group "resourceGroupName"

Required Parameters

--cluster-name

The name of the cluster.

--resource-group -g

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

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

--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 networkcloud cluster metricsconfiguration show

Get metrics configuration of the provided cluster.

az networkcloud cluster metricsconfiguration show [--cluster-name]
                                                  [--ids]
                                                  [--resource-group]
                                                  [--subscription]

Examples

Get metrics configuration of cluster

az networkcloud cluster metricsconfiguration show --cluster-name "clusterName" --resource-group "resourceGroupName"

Optional Parameters

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

--cluster-name

The name of the cluster.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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 networkcloud cluster metricsconfiguration update

Update properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.

az networkcloud cluster metricsconfiguration update [--cluster-name]
                                                    [--collection-interval]
                                                    [--enabled-metrics]
                                                    [--ids]
                                                    [--if-match]
                                                    [--if-none-match]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--tags]

Examples

Patch metrics configuration of cluster

az networkcloud cluster metricsconfiguration update --cluster-name "clusterName" --collection-interval 15 --enabled-metrics "metric1" "metric2" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

Optional Parameters

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

--cluster-name

The name of the cluster.

Property	Value
Parameter group:	Resource Id Arguments

--collection-interval

The interval in minutes by which metrics will be collected.

Property	Value
Parameter group:	Properties Arguments

--enabled-metrics

The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	MetricsConfigurationUpdateParameters 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 networkcloud cluster metricsconfiguration wait

Place the CLI in a waiting state until a condition is met.

az networkcloud cluster metricsconfiguration wait [--cluster-name]
                                                  [--created]
                                                  [--custom]
                                                  [--deleted]
                                                  [--exists]
                                                  [--ids]
                                                  [--interval]
                                                  [--metrics-configuration-name --name]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--timeout]
                                                  [--updated]

Optional Parameters

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

--cluster-name

The name of the cluster.

Property	Value
Parameter group:	Resource Id Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--metrics-configuration-name --name -n

The name of the metrics configuration for the cluster.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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

Share via

az networkcloud cluster metricsconfiguration

Commands

az networkcloud cluster metricsconfiguration create

Examples

Required Parameters

Optional Parameters

az networkcloud cluster metricsconfiguration delete

Examples

Optional Parameters

az networkcloud cluster metricsconfiguration list

Examples

Required Parameters

Optional Parameters

az networkcloud cluster metricsconfiguration show

Examples

Optional Parameters

az networkcloud cluster metricsconfiguration update

Examples

Optional Parameters

az networkcloud cluster metricsconfiguration wait

Optional Parameters

Feedback