Share via

az monitor log-analytics workspace table

Manage tables for log analytics workspace.

Commands

Name Description Type Status
az monitor log-analytics workspace table create

Create a Log Analytics workspace microsoft/custom log table. The table name needs to end with '_CL'.

 Core GA
az monitor log-analytics workspace table delete

Delete a Log Analytics workspace table.

 Core GA
az monitor log-analytics workspace table list

List all the tables for the given Log Analytics workspace.

 Core GA
az monitor log-analytics workspace table migrate

Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.

 Core GA
az monitor log-analytics workspace table restore

Manage tables for log analytics workspace restore logs table.

 Core GA
az monitor log-analytics workspace table restore create

Create a Log Analytics workspace restore logs table. The table name needs to end with '_RST'.

 Core GA
az monitor log-analytics workspace table search-job

Manage tables for log analytics workspace search results table.

 Core GA
az monitor log-analytics workspace table search-job cancel

Cancel a log analytics workspace search results table query run.

 Core GA
az monitor log-analytics workspace table search-job create

Create a Log Analytics workspace search results table. The table name needs to end with '_SRCH'.

 Core GA
az monitor log-analytics workspace table show

Get a Log Analytics workspace table.

 Core GA
az monitor log-analytics workspace table update

Update the properties of a Log Analytics workspace table.

 Core GA
az monitor log-analytics workspace table wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az monitor log-analytics workspace table create

Edit

Create a Log Analytics workspace microsoft/custom log table. The table name needs to end with '_CL'.

az monitor log-analytics workspace table create --name
                                                --resource-group
                                                --workspace-name
                                                [--columns]
                                                [--description]
                                                [--no-wait]
                                                [--plan {Analytics, Basic}]
                                                [--retention-time]
                                                [--total-retention-time]

Examples

Create a Log Analytics workspace custom log table.

az monitor log-analytics workspace table create --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyTable_CL --retention-time 45 --columns MyColumn1=string TimeGenerated=datetime

Required Parameters

--name -n

Name of the table.

--resource-group -g

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

--workspace-name

Name of the Log Analytics 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.

--columns

A list of table custom columns.Extracts multiple space-separated columns in column_name=column_type format.

--description

Schema description.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--plan

The table plan. Possible values include: "Basic", "Analytics".

Property Value
Accepted values: Analytics, Basic
--retention-time

The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.

--total-retention-time

The table total retention in days, between 4 and 2556. Setting this property to -1 will default to table retention.

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 table delete

Edit

Delete a Log Analytics workspace table.

az monitor log-analytics workspace table delete [--ids]
                                                [--name --table-name]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--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.

--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
--name --table-name -n

The name of the table.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 table list

Edit

List all the tables for the given Log Analytics workspace.

az monitor log-analytics workspace table list --resource-group
                                              --workspace-name

Examples

List all the tables for the given Log Analytics workspace

az monitor log-analytics workspace table list --resource-group MyResourceGroup --workspace-name MyWorkspace

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 table migrate

Edit

Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.

az monitor log-analytics workspace table migrate [--ids]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--table-name]
                                                 [--workspace-name]

Examples

Migrate a Log Analytics workspace table.

az monitor log-analytics workspace table migrate --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyTable_CL

Optional Parameters

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

--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
--table-name

The name of the table.

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 table show

Edit

Get a Log Analytics workspace table.

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

Examples

Get a Log Analytics workspace table

az monitor log-analytics workspace table show --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyTable

Optional Parameters

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

--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
--name --table-name -n

The name of the table.

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 table update

Edit

Update the properties of a Log Analytics workspace table.

az monitor log-analytics workspace table update --name
                                                --resource-group
                                                --workspace-name
                                                [--columns]
                                                [--description]
                                                [--no-wait]
                                                [--plan {Analytics, Basic}]
                                                [--retention-time]
                                                [--total-retention-time]

Examples

Update the properties of a Log Analytics workspace table.

az monitor log-analytics workspace table update --resource-group MyResourceGroup --workspace-name MyWorkspace -n MyTable --retention-time 30

Required Parameters

--name -n

Name of the table.

--resource-group -g

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

--workspace-name

Name of the Log Analytics 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.

--columns

A list of table custom columns.Extracts multiple space-separated columns in column_name=column_type format.

--description

Table description.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--plan

The table plan. Possible values include: "Basic", "Analytics".

Property Value
Accepted values: Analytics, Basic
--retention-time

The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.

--total-retention-time

The table total retention in days, between 4 and 2556. Setting this property to -1 will default to table retention.

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 table wait

Edit

Place the CLI in a waiting state until a condition is met.

az monitor log-analytics workspace table wait [--created]
                                              [--custom]
                                              [--deleted]
                                              [--exists]
                                              [--ids]
                                              [--interval]
                                              [--name --table-name]
                                              [--resource-group]
                                              [--subscription]
                                              [--timeout]
                                              [--updated]
                                              [--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.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --table-name -n

The name of the table.

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

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--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