az monitor data-collection rule log-analytics

Note

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

Manage Log Analytics destinations.

Commands

Name	Description	Type	Status
az monitor data-collection rule log-analytics add	Add Log Analytics destinations of a data collection rule.	Extension	GA
az monitor data-collection rule log-analytics delete	Delete a Log Analytics destinations of a data collection rule.	Extension	GA
az monitor data-collection rule log-analytics list	List Log Analytics destinations of a data collection rule.	Extension	GA
az monitor data-collection rule log-analytics show	Show a Log Analytics destination of a data collection rule.	Extension	GA
az monitor data-collection rule log-analytics update	Update a Log Analytics destination of a data collection rule.	Extension	GA

az monitor data-collection rule log-analytics add

Add Log Analytics destinations of a data collection rule.

az monitor data-collection rule log-analytics add --name
                                                  --resource-group
                                                  --resource-id
                                                  --rule-name

Examples

Add Log Analytics destinations of a data collection rule

az monitor data-collection rule log-analytics add --rule-name "myCollectionRule" --resource-group "myResourceGroup" --name "workspace2" --resource-id "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/workspace2"

Required Parameters

--name -n

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

--resource-group -g

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

--resource-id

The resource ID of the Log Analytics workspace.

--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 log-analytics delete

Delete a Log Analytics destinations of a data collection rule.

az monitor data-collection rule log-analytics delete --name
                                                     --resource-group
                                                     --rule-name

Examples

Delete a Log Analytics destinations of a data collection rule

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

Required Parameters

--name -n

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

--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 log-analytics list

List Log Analytics destinations of a data collection rule.

az monitor data-collection rule log-analytics list --resource-group
                                                   --rule-name

Examples

List Log Analytics destinations of a data collection rule

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

Show a Log Analytics destination of a data collection rule.

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

Examples

Show a Log Analytics destination of a data collection rule

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

Required Parameters

--name -n

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

--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 log-analytics update

Update a Log Analytics destination of a data collection rule.

az monitor data-collection rule log-analytics update --name
                                                     --resource-group
                                                     --rule-name
                                                     [--resource-id]

Examples

Update a Log Analytics destination of a data collection rule

az monitor data-collection rule log-analytics update --rule-name "myCollectionRule" --resource-group "myResourceGroup" --name "workspace2" --resource-id "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/anotherWorkspace"

Required Parameters

--name -n

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

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

Optional Parameters

--resource-id

The resource ID of the Log Analytics workspace.

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.