az networkcloud cluster metricsconfiguration
Note
This reference is part of the networkcloud extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az networkcloud cluster metricsconfiguration command. Learn more about extensions.
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage cluster's metrics configuration.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az networkcloud cluster metricsconfiguration create |
Create the metrics configuration of the provided cluster. |
Extension | Preview |
| az networkcloud cluster metricsconfiguration delete |
Delete the metrics configuration of the provided cluster. |
Extension | Preview |
| az networkcloud cluster metricsconfiguration list |
List metrics configurations of the cluster. |
Extension | Preview |
| az networkcloud cluster metricsconfiguration show |
Get metrics configuration of the provided cluster. |
Extension | Preview |
| 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 | Preview |
| az networkcloud cluster metricsconfiguration wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az networkcloud cluster metricsconfiguration create
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
The name of the cluster.
The interval in minutes by which metrics will be collected.
The extended location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster metricsconfiguration delete
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
The name of the cluster.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster metricsconfiguration list
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
The name of the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster metricsconfiguration show
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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 name of the cluster.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster metricsconfiguration update
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
The name of the cluster.
The interval in minutes by which metrics will be collected.
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.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster metricsconfiguration wait
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
The name of the cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the metrics configuration for the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for