Share via

az monitor data-collection rule data-flow

  • Reference

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 data-flow command. Learn more about extensions.

Manage data flows.

Commands

Name Description Type Status
az monitor data-collection rule data-flow add

Add a data flow.

 Extension GA
az monitor data-collection rule data-flow list

List data flows.

 Extension GA

az monitor data-collection rule data-flow add

Add a data flow.

az monitor data-collection rule data-flow add --data-collection-rule-name
                                              --resource-group
                                              [--built-in-transform]
                                              [--capture-overflow {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--data-flow-index]
                                              [--destinations]
                                              [--output-stream]
                                              [--streams]
                                              [--transform-kql]

Examples

Add a data flow

az monitor data-collection rule data-flow add --rule-name myCollectionRule --resource-group myResourceGroup --destinations XX3 XX4 --streams Microsoft-Perf Microsoft-WindowsEvent

Required Parameters

--data-collection-rule-name --rule-name

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

--built-in-transform

The builtIn transform to transform stream data.

--capture-overflow

Flag to enable overflow column in LA destinations.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--data-flow-index

Data flow ind.

--destinations

List of destinations for this data flow. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--output-stream

The output stream of the transform. Only required if the transform changes data to a different stream.

--streams

List of streams for this data flow. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--transform-kql

The KQL query to transform stream data.

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 data-flow list

List data flows.

az monitor data-collection rule data-flow list --data-collection-rule-name
                                               --resource-group

Examples

List data flows

az monitor data-collection rule data-flow list --rule-name myCollectionRule --resource-group myResourceGroup

Required Parameters

--data-collection-rule-name --rule-name

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.

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.