az monitor data-collection rule performance-counter
Note
This reference is part of the monitor-control-service extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az monitor data-collection rule performance-counter command. Learn more about extensions.
Manage Log performance counter data source.
Commands
Name | Description | Type | Status |
---|---|---|---|
az monitor data-collection rule performance-counter add |
Add a Log performance counter data source. |
Extension | GA |
az monitor data-collection rule performance-counter delete |
Delete a Log performance counter data source. |
Extension | GA |
az monitor data-collection rule performance-counter list |
List Log performance counter data sources. |
Extension | GA |
az monitor data-collection rule performance-counter show |
Show a Log performance counter data source. |
Extension | GA |
az monitor data-collection rule performance-counter update |
Update a Log performance counter data source. |
Extension | GA |
az monitor data-collection rule performance-counter add
Add a Log performance counter data source.
az monitor data-collection rule performance-counter add --data-collection-rule-name
--name
--resource-group
[--counter-specifiers]
[--sampling-frequency]
[--streams]
[--transform-kql]
Examples
Add a Log performance counter data source
az monitor data-collection rule performance-counter add --rule-name myCollectionRule --resource-group myResourceGroup --name team2ExtraCounters --streams Microsoft-Perf --counter-specifiers "\Process(_Total)\Thread Count" "\LogicalDisk(_Total)\FreeMegabytes" --sampling-frequency 30
Required Parameters
The name of the data collection rule. The name is case insensitive.
A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The number of seconds between consecutive counter measurements (samples).
List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The KQL query to transform the data source.
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 monitor data-collection rule performance-counter delete
Delete a Log performance counter data source.
az monitor data-collection rule performance-counter delete --data-collection-rule-name
--name
--resource-group
Examples
Delete a Log performance counter data source
az monitor data-collection rule performance-counter delete --rule-name myCollectionRule --resource-group myResourceGroup --name team2ExtraCounters
Required Parameters
The name of the data collection rule. The name is case insensitive.
A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 monitor data-collection rule performance-counter list
List Log performance counter data sources.
az monitor data-collection rule performance-counter list --data-collection-rule-name
--resource-group
Examples
List Log performance counter data sources
az monitor data-collection rule performance-counter list --rule-name myCollectionRule --resource-group myResourceGroup
Required Parameters
The name of the data collection rule. The name is case insensitive.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 monitor data-collection rule performance-counter show
Show a Log performance counter data source.
az monitor data-collection rule performance-counter show --data-collection-rule-name
--name
--resource-group
Examples
Show a Log performance counter data source
az monitor data-collection rule performance-counter show --rule-name myCollectionRule --resource-group myResourceGroup --name appTeamExtraCounters
Required Parameters
The name of the data collection rule. The name is case insensitive.
A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 monitor data-collection rule performance-counter update
Update a Log performance counter data source.
az monitor data-collection rule performance-counter update --data-collection-rule-name
--name
--resource-group
[--add]
[--counter-specifiers]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--sampling-frequency]
[--set]
[--streams]
[--transform-kql]
Examples
Update a Log performance counter data source
az monitor data-collection rule performance-counter update --rule-name myCollectionRule --resource-group myResourceGroup --name team2ExtraCounters
Required Parameters
The name of the data collection rule. The name is case insensitive.
A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
The number of seconds between consecutive counter measurements (samples).
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The KQL query to transform the data source.
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.