Share via

az networkcloud cluster metricsconfiguration

  • Reference

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.66.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]
                                                    [--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.

--extended-location

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

--resource-group -g

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

Optional Parameters

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

--location -l

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

--no-wait

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

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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az networkcloud cluster metricsconfiguration delete

Delete the metrics configuration of the provided cluster.

az networkcloud cluster metricsconfiguration delete [--cluster-name]
                                                    [--ids]
                                                    [--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

--cluster-name

The name of the cluster.

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

--no-wait

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

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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

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

--next-token

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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

--cluster-name

The name of the cluster.

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

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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

--cluster-name

The name of the cluster.

--collection-interval

The interval in minutes by which metrics will be collected.

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

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

--no-wait

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

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

--subscription

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

--tags

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--timeout]
                                                  [--updated]

Optional Parameters

--cluster-name

The name of the cluster.

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--metrics-configuration-name --name -n

The name of the metrics configuration for the cluster.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.