az monitor data-collection rule windows-event-log

  • Reference

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 windows-event-log command. Learn more about extensions.

Manage Windows Event Log data source.

Commands

Name Description Type Status
az monitor data-collection rule windows-event-log add

Add a Windows Event Log data source.

 Extension GA
az monitor data-collection rule windows-event-log delete

Delete a Windows Event Log data source.

 Extension GA
az monitor data-collection rule windows-event-log list

List Windows Event Log data sources.

 Extension GA
az monitor data-collection rule windows-event-log show

Show a Windows Event Log data source.

 Extension GA
az monitor data-collection rule windows-event-log update

Update a Windows Event Log data source.

 Extension GA

az monitor data-collection rule windows-event-log add

Add a Windows Event Log data source.

az monitor data-collection rule windows-event-log add --name
                                                      --streams {Microsoft-Event, Microsoft-WindowsEvent}
                                                      --x-path-queries
                                                      [--ids]
                                                      [--resource-group]
                                                      [--rule-name]
                                                      [--subscription]

Examples

Add a Windows Event Log data source

az monitor data-collection rule windows-event-log add --rule-name "myCollectionRule" --resource-group "myResourceGroup" --name "appTeam1AppEvents" --streams "Microsoft-WindowsEvent" --x-path-queries "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]" "System![System[(Level = 1 or Level = 2 or Level = 3)]]"

Required Parameters

--name -n

A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.

--streams

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.

accepted values: Microsoft-Event, Microsoft-WindowsEvent
--x-path-queries

A list of Windows Event Log queries in XPATH format.

Optional Parameters

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

--rule-name

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

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

Delete a Windows Event Log data source.

az monitor data-collection rule windows-event-log delete --name
                                                         [--ids]
                                                         [--resource-group]
                                                         [--rule-name]
                                                         [--subscription]

Examples

Delete a Windows Event Log data source

az monitor data-collection rule windows-event-log delete --rule-name "myCollectionRule" --resource-group "myResourceGroup" --name "appTeam1AppEvents"

Required Parameters

--name -n

A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.

Optional Parameters

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

--rule-name

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

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

List Windows Event Log data sources.

az monitor data-collection rule windows-event-log list --resource-group
                                                       --rule-name

Examples

List Windows Event Log data sources

az monitor data-collection rule windows-event-log list --rule-name "myCollectionRule" --resource-group "myResourceGroup"

Required Parameters

--resource-group -g

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

--rule-name

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

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

Show a Windows Event Log data source.

az monitor data-collection rule windows-event-log show --name
                                                       [--ids]
                                                       [--resource-group]
                                                       [--rule-name]
                                                       [--subscription]

Examples

Show a Windows Event Log data source

az monitor data-collection rule windows-event-log show --rule-name "myCollectionRule" --resource-group "myResourceGroup" --name "appTeam1AppEvents"

Required Parameters

--name -n

A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.

Optional Parameters

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

--rule-name

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

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

Update a Windows Event Log data source.

az monitor data-collection rule windows-event-log update --name
                                                         [--ids]
                                                         [--resource-group]
                                                         [--rule-name]
                                                         [--streams {Microsoft-Event, Microsoft-WindowsEvent}]
                                                         [--subscription]
                                                         [--x-path-queries]

Examples

Update a Windows Event Log data source

az monitor data-collection rule windows-event-log update --rule-name "myCollectionRule" --resource-group "myResourceGroup" --name "appTeam1AppEvents" --x-path-queries "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"

Required Parameters

--name -n

A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.

Optional Parameters

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

--rule-name

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

--streams

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.

accepted values: Microsoft-Event, Microsoft-WindowsEvent
--subscription

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

--x-path-queries

A list of Windows Event Log queries in XPATH format.

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.