Share via

az logz rule

  • Experimental
  • Reference

Note

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

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage tag rule with logz.

Commands

Name Description Type Status
az logz rule create

Create a tag rule set for a given monitor resource.

 Extension Experimental
az logz rule delete

Delete a tag rule set for a given monitor resource.

 Extension Experimental
az logz rule list

List the tag rules for a given monitor resource.

 Extension Experimental
az logz rule show

Get a tag rule set for a given monitor resource.

 Extension Experimental
az logz rule update

Update a tag rule set for a given monitor resource.

 Extension Experimental

az logz rule create

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a tag rule set for a given monitor resource.

az logz rule create --monitor-name
                    --resource-group
                    --rule-set-name
                    [--filtering-tags]
                    [--send-aad-logs {false, true}]
                    [--send-activity-logs {false, true}]
                    [--send-subscription-logs {false, true}]

Examples

TagRules_CreateOrUpdate

az logz rule create --monitor-name "myMonitor" --filtering-tags name="Environment" action="Include" value="Prod" --filtering-tags name="Environment" action="Exclude" value="Dev" --send-aad-logs false --send-activity-logs true --send-subscription-logs true --resource-group "myResourceGroup" --rule-set-name "default"

Required Parameters

--monitor-name

Monitor resource name.

--resource-group -g

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

--rule-set-name

Rule set name of monitor.

Optional Parameters

--filtering-tags

List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.

Usage: --filtering-tags name=XX value=XX action=XX

name: The name (also known as the key) of the tag. value: The value of the tag. action: Valid actions for a filtering tag. Exclusion takes priority over inclusion.

Multiple actions can be specified by using more than one --filtering-tags argument.

--send-aad-logs

Flag specifying if AAD logs should be sent for the Monitor resource.

Accepted values: false, true
--send-activity-logs

Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.

Accepted values: false, true
--send-subscription-logs

Flag specifying if subscription logs should be sent for the Monitor resource.

Accepted values: false, true
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 logz rule delete

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a tag rule set for a given monitor resource.

az logz rule delete [--ids]
                    [--monitor-name]
                    [--resource-group]
                    [--rule-set-name]
                    [--subscription]
                    [--yes]

Examples

TagRules_Delete

az logz rule delete --monitor-name "myMonitor" --resource-group "myResourceGroup" --rule-set-name "default"

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.

--monitor-name

Monitor resource name.

--resource-group -g

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

--rule-set-name

Rule set name of monitor.

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 logz rule list

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the tag rules for a given monitor resource.

az logz rule list --monitor-name
                  --resource-group

Examples

TagRules_List

az logz rule list --monitor-name "myMonitor" --resource-group "myResourceGroup"

Required Parameters

--monitor-name

Monitor resource name.

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

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 logz rule show

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a tag rule set for a given monitor resource.

az logz rule show [--ids]
                  [--monitor-name]
                  [--resource-group]
                  [--rule-set-name]
                  [--subscription]

Examples

TagRules_Get

az logz rule show --monitor-name "myMonitor" --resource-group "myResourceGroup" --rule-set-name "default"

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.

--monitor-name

Monitor resource name.

--resource-group -g

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

--rule-set-name

Rule set name of monitor.

--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 logz rule update

Experimental

Command group 'logz' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a tag rule set for a given monitor resource.

az logz rule update [--add]
                    [--filtering-tags]
                    [--force-string]
                    [--ids]
                    [--monitor-name]
                    [--remove]
                    [--resource-group]
                    [--rule-set-name]
                    [--send-aad-logs {false, true}]
                    [--send-activity-logs {false, true}]
                    [--send-subscription-logs {false, true}]
                    [--set]
                    [--subscription]

Optional Parameters

--add

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

Default value: []
--filtering-tags

List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.

Usage: --filtering-tags name=XX value=XX action=XX

name: The name (also known as the key) of the tag. value: The value of the tag. action: Valid actions for a filtering tag. Exclusion takes priority over inclusion.

Multiple actions can be specified by using more than one --filtering-tags argument.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--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.

--monitor-name

Monitor resource name.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--resource-group -g

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

--rule-set-name

Rule set name of monitor.

--send-aad-logs

Flag specifying if AAD logs should be sent for the Monitor resource.

Accepted values: false, true
--send-activity-logs

Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.

Accepted values: false, true
--send-subscription-logs

Flag specifying if subscription logs should be sent for the Monitor resource.

Accepted values: false, true
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
--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.