tables

Creates, updates, deletes, gets or lists a tables resource.

Overview

Name	tables
Type	Resource
Id	azure.log_analytics.tables

Fields

The following fields are returned by SELECT queries:

get

OK response definition.

Name	Datatype	Description
properties	object	Table's properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_workspace

OK response definition.

Name	Datatype	Description
properties	object	Table's properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, tableName		Gets a Log Analytics workspace table.
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		Gets all the tables for the specified Log Analytics workspace.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, tableName		Update or Create a Log Analytics workspace table.
update	update	subscriptionId, resourceGroupName, workspaceName, tableName		Update a Log Analytics workspace table.
delete	delete	subscriptionId, resourceGroupName, workspaceName, tableName		Delete a Log Analytics workspace table.
migrate	exec	subscriptionId, resourceGroupName, workspaceName, tableName		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.
cancel_search	exec	subscriptionId, resourceGroupName, workspaceName, tableName		Cancel a log analytics workspace search results table query run.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
tableName	string	The name of the table.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a Log Analytics workspace table.

SELECT
properties,
systemData
FROM azure.log_analytics.tables
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND tableName = '{{ tableName }}' -- required
;

list_by_workspace

Gets all the tables for the specified Log Analytics workspace.

SELECT
properties,
systemData
FROM azure.log_analytics.tables
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

Update or Create a Log Analytics workspace table.

INSERT INTO azure.log_analytics.tables (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
tableName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ tableName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: tables
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the tables resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the tables resource.
    - name: workspaceName
      value: string
      description: Required parameter for the tables resource.
    - name: tableName
      value: string
      description: Required parameter for the tables resource.
    - name: properties
      value: object
      description: |
        Table's properties.

UPDATE examples

update

Update a Log Analytics workspace table.

UPDATE azure.log_analytics.tables
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND tableName = '{{ tableName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Delete a Log Analytics workspace table.

DELETE FROM azure.log_analytics.tables
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND tableName = '{{ tableName }}' --required
;

Lifecycle Methods

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.

EXEC azure.log_analytics.tables.migrate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@tableName='{{ tableName }}' --required
;

cancel_search

Cancel a log analytics workspace search results table query run.

EXEC azure.log_analytics.tables.cancel_search 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@tableName='{{ tableName }}' --required
;