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
Create a data export rule for a given workspace.
For more information, see https://docs.microsoft.com/azure/azure-monitor/platform/logs-data-export.
az monitor log-analytics workspace data-export create --data-export-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
The data export rule name.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
An array of tables to export. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the workspace.
Optional Parameters
Active when enabled.
Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor log-analytics workspace data-export delete
Delete a data export rule for a given workspace.
az monitor log-analytics workspace data-export delete [--data-export-name]
[--ids]
[--resource-group]
[--subscription]
[--workspace-name]
[--yes]Optional Parameters
The data export rule name.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the workspace.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor log-analytics workspace data-export list
List all data export ruleses for a given workspace.
az monitor log-analytics workspace data-export list --resource-group
--workspace-nameRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the workspace.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor log-analytics workspace data-export show
Show a data export rule for a given workspace.
az monitor log-analytics workspace data-export show [--data-export-name]
[--ids]
[--resource-group]
[--subscription]
[--workspace-name]Optional Parameters
The data export rule name.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the workspace.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az monitor log-analytics workspace data-export update
Update a data export rule for a given workspace.
For more information, see https://docs.microsoft.com/azure/azure-monitor/platform/logs-data-export.
az monitor log-analytics workspace data-export update [--add]
[--data-export-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 falseOptional Parameters
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>.
The data export rule name.
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.
Active when enabled.
Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
An array of tables to export. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the workspace.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for