az monitor data-collection rule

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Note

This reference is part of the monitor-control-service extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az monitor data-collection rule command. Learn more about extensions.

Manage data collection rule for monitor control service.

Commands

az monitor data-collection rule association	Manage data collection rule association for monitor control service.
az monitor data-collection rule association create	Create an association.
az monitor data-collection rule association delete	Delete an association.
az monitor data-collection rule association list	List associations for the specified data collection rule. And Lists associations for the specified resource.
az monitor data-collection rule association show	Return the specified association.
az monitor data-collection rule association update	Update an association.
az monitor data-collection rule create	Create a data collection rule.
az monitor data-collection rule data-flow	Manage data flows.
az monitor data-collection rule data-flow add	Add a data flow.
az monitor data-collection rule data-flow list	List data flows.
az monitor data-collection rule delete	Deletes a data collection rule.
az monitor data-collection rule list	List all data collection rules in the specified resource group. And Lists all data collection rules in the specified subscription.
az monitor data-collection rule log-analytics	Manage Log Analytics destinations.
az monitor data-collection rule log-analytics add	Add Log Analytics destinations of a data collection rule.
az monitor data-collection rule log-analytics delete	Delete a Log Analytics destinations of a data collection rule.
az monitor data-collection rule log-analytics list	List Log Analytics destinations of a data collection rule.
az monitor data-collection rule log-analytics show	Show a Log Analytics destination of a data collection rule.
az monitor data-collection rule log-analytics update	Update a Log Analytics destination of a data collection rule.
az monitor data-collection rule performance-counter	Manage Log performance counter data source.
az monitor data-collection rule performance-counter add	Add a Log performance counter data source.
az monitor data-collection rule performance-counter delete	Delete a Log performance counter data source.
az monitor data-collection rule performance-counter list	List Log performance counter data sources.
az monitor data-collection rule performance-counter show	Show a Log performance counter data source.
az monitor data-collection rule performance-counter update	Update a Log performance counter data source.
az monitor data-collection rule show	Return the specified data collection rule.
az monitor data-collection rule syslog	Manage Syslog data source.
az monitor data-collection rule syslog add	Add a Syslog data source.
az monitor data-collection rule syslog delete	Delete a Syslog data source.
az monitor data-collection rule syslog list	List Syslog data sources.
az monitor data-collection rule syslog show	Show a Syslog data source.
az monitor data-collection rule syslog update	Update a Syslog data source.
az monitor data-collection rule update	Update a data collection rule.
az monitor data-collection rule windows-event-log	Manage Windows Event Log data source.
az monitor data-collection rule windows-event-log add	Add a Windows Event Log data source.
az monitor data-collection rule windows-event-log delete	Delete a Windows Event Log data source.
az monitor data-collection rule windows-event-log list	List Windows Event Log data sources.
az monitor data-collection rule windows-event-log show	Show a Windows Event Log data source.
az monitor data-collection rule windows-event-log update	Update a Windows Event Log data source.

az monitor data-collection rule create

Create a data collection rule.

az monitor data-collection rule create --name
                                       --resource-group
                                       --rule-file
                                       [--description]
                                       [--location]
                                       [--tags]

Examples

Create data collection rule

az monitor data-collection rule create --resource-group "myResourceGroup" --location "eastus" --name "myCollectionRule" --rule-file "C:\samples\dcrEx1.json"

Required Parameters

--name -n

The name of the data collection rule. The name is case insensitive.

--resource-group -g

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

--rule-file

The json file for rule parameters.

Optional Parameters

--description

Description of the data collection rule.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

--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 monitor data-collection rule delete

Deletes a data collection rule.

az monitor data-collection rule delete --name
                                       --resource-group
                                       [--yes]

Examples

Delete data collection rule

az monitor data-collection rule delete --name "myCollectionRule" --resource-group "myResourceGroup"

Required Parameters

--name -n

The name of the data collection rule. The name is case insensitive.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

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.

--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 monitor data-collection rule list

List all data collection rules in the specified resource group. And Lists all data collection rules in the specified subscription.

az monitor data-collection rule list [--resource-group]

Examples

List data collection rules by resource group

az monitor data-collection rule list --resource-group "myResourceGroup"

List data collection rules by subscription

az monitor data-collection rule list

Optional Parameters

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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 monitor data-collection rule show

Return the specified data collection rule.

az monitor data-collection rule show --name
                                     --resource-group

Examples

Get data collection rule

az monitor data-collection rule show --name "myCollectionRule" --resource-group "myResourceGroup"

Required Parameters

--name -n

The name of the data collection rule. The name is case insensitive.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--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 monitor data-collection rule update

Update a data collection rule.

az monitor data-collection rule update --name
                                       --resource-group
                                       [--data-flows]
                                       [--description]
                                       [--extensions]
                                       [--log-analytics]
                                       [--monitor-metrics]
                                       [--performance-counters]
                                       [--syslog]
                                       [--tags]
                                       [--windows-event-logs]

Examples

Update data collection rule

az monitor data-collection rule update --resource-group "myResourceGroup" --name "myCollectionRule" --data-flows destinations="centralWorkspace" streams="Microsoft-Perf" streams="Microsoft-Syslog" streams="Microsoft-WindowsEvent" --log-analytics name="centralWorkspace" resource-id="/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace" --performance-counters name="appTeamExtraCounters" counter-specifiers="\\Process(_Total)\\Thread Count" sampling-frequency=30 streams="Microsoft-Perf" --syslog name="cronSyslog" facility-names="cron" log-levels="Debug" log-levels="Critical" log-levels="Emergency" streams="Microsoft-Syslog" --windows-event-logs name="cloudSecurityTeamEvents" streams="Microsoft-WindowsEvent" x-path-queries="Security!"

Required Parameters

--name -n

The name of the data collection rule. The name is case insensitive.

--resource-group -g

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

Optional Parameters

--data-flows

The specification of data flows.

--description

Description of the data collection rule.

--extensions

The list of Azure VM extension data source configurations. Expected value: json-string/@json-file.

--log-analytics

List of Log Analytics destinations.

--monitor-metrics

Azure Monitor Metrics destination.

--performance-counters

The list of performance counter data source configurations.

--syslog

The list of Syslog data source configurations.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--windows-event-logs

The list of Windows Event Log data source configurations.

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.

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