Share via

az monitor log-analytics workspace data-export

Manage data export ruls for log analytics workspace.

Commands

Name Description Type Status
az monitor log-analytics workspace data-export create

Create a data export rule for a given workspace.

 Core GA
az monitor log-analytics workspace data-export delete

Delete a data export rule for a given workspace.

 Core GA
az monitor log-analytics workspace data-export list

List all data export ruleses for a given workspace.

 Core GA
az monitor log-analytics workspace data-export show

Show a data export rule for a given workspace.

 Core GA
az monitor log-analytics workspace data-export update

Update a data export rule for a given workspace.

 Core GA

az monitor log-analytics workspace data-export create

Edit

Create a data export rule for a given workspace.

For more information, see https://learn.microsoft.com/azure/azure-monitor/platform/logs-data-export.

az monitor log-analytics workspace data-export create --data-export-name --name
                                                      --destination
                                                      --resource-group
                                                      --tables
                                                      --workspace-name
                                                      [--enable {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--event-hub-name]

Examples

Create a data export rule for a given workspace.

az monitor log-analytics workspace data-export create -g MyRG --workspace-name MyWS -n MyDataExport --destination <storage account id> --enable -t <table name>

Required Parameters

--data-export-name --name -n

The data export rule name.

--destination

The destination resource ID. It should be a storage account, an event hub namespace. If event hub namespace is provided without --event-hub-name, event hub would be created for each table automatically.

Property Value
Parameter group: Destination Arguments
--resource-group -g

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

--tables -t

An array of tables to export. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--workspace-name

The name of the workspace.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enable

Active when enabled.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--event-hub-name

Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account.

Property Value
Parameter group: Destination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az monitor log-analytics workspace data-export delete

Edit

Delete a data export rule for a given workspace.

az monitor log-analytics workspace data-export delete [--data-export-name --name]
                                                      [--ids]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--workspace-name]
                                                      [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--data-export-name --name -n

The data export rule name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az monitor log-analytics workspace data-export list

Edit

List all data export ruleses for a given workspace.

az monitor log-analytics workspace data-export list --resource-group
                                                    --workspace-name

Required Parameters

--resource-group -g

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

--workspace-name

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az monitor log-analytics workspace data-export show

Edit

Show a data export rule for a given workspace.

az monitor log-analytics workspace data-export show [--data-export-name --name]
                                                    [--ids]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--data-export-name --name -n

The data export rule name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az monitor log-analytics workspace data-export update

Edit

Update a data export rule for a given workspace.

For more information, see https://learn.microsoft.com/azure/azure-monitor/platform/logs-data-export.

az monitor log-analytics workspace data-export update [--add]
                                                      [--data-export-name --name]
                                                      [--destination]
                                                      [--enable {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--event-hub-name]
                                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--ids]
                                                      [--remove]
                                                      [--resource-group]
                                                      [--set]
                                                      [--subscription]
                                                      [--tables]
                                                      [--workspace-name]

Examples

Update a data export rule for a given workspace.

az monitor log-analytics workspace data-export update -g MyRG --workspace-name MyWS -n MyDataExport --destination <event hub namespace id> -t <table name> --enable false

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--data-export-name --name -n

The data export rule name.

Property Value
Parameter group: Resource Id Arguments
--destination

The destination resource ID. It should be a storage account, an event hub namespace. If event hub namespace is provided without --event-hub-name, event hub would be created for each table automatically.

Property Value
Parameter group: Destination Arguments
--enable

Active when enabled.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--event-hub-name

Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account.

Property Value
Parameter group: Destination Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tables -t

An array of tables to export. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--workspace-name

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False