data_exports

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

Overview

Name	data_exports
Type	Resource
Id	azure.log_analytics.data_exports

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createdDate	string	The latest data export rule modification time.
dataExportId	string	The data export rule ID.
destination	object	destination properties.
enable	boolean	Active when enabled.
lastModifiedDate	string	Date and time when the export was last modified.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tableNames	array	An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createdDate	string	The latest data export rule modification time.
dataExportId	string	The data export rule ID.
destination	object	destination properties.
enable	boolean	Active when enabled.
lastModifiedDate	string	Date and time when the export was last modified.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tableNames	array	An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, data_export_name, subscription_id		Gets a data export instance.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists the data export instances within a workspace.
create_or_update	insert	resource_group_name, workspace_name, data_export_name, subscription_id		Create or update a data export.
create_or_update	replace	resource_group_name, workspace_name, data_export_name, subscription_id		Create or update a data export.
delete	delete	resource_group_name, workspace_name, data_export_name, subscription_id		Deletes the specified data export in a given workspace..

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
data_export_name	string	The data export rule name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a data export instance.

SELECT
id,
name,
createdDate,
dataExportId,
destination,
enable,
lastModifiedDate,
systemData,
tableNames,
type
FROM azure.log_analytics.data_exports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND data_export_name = '{{ data_export_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Lists the data export instances within a workspace.

SELECT
id,
name,
createdDate,
dataExportId,
destination,
enable,
lastModifiedDate,
systemData,
tableNames,
type
FROM azure.log_analytics.data_exports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a data export.

INSERT INTO azure.log_analytics.data_exports (
properties,
resource_group_name,
workspace_name,
data_export_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ data_export_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_exports
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_exports resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the data_exports resource.
  - name: data_export_name
    value: "{{ data_export_name }}"
    description: Required parameter for the data_exports resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_exports resource.
  - name: properties
    description: |
      data export properties.
    value:
      dataExportId: "{{ dataExportId }}"
      tableNames:
        - "{{ tableNames }}"
      destination:
        resourceId: "{{ resourceId }}"
        type: "{{ type }}"
        metaData:
          eventHubName: "{{ eventHubName }}"
      enable: {{ enable }}
      createdDate: "{{ createdDate }}"
      lastModifiedDate: "{{ lastModifiedDate }}"

REPLACE examples

create_or_update

Create or update a data export.

REPLACE azure.log_analytics.data_exports
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND data_export_name = '{{ data_export_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified data export in a given workspace..

DELETE FROM azure.log_analytics.data_exports
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND data_export_name = '{{ data_export_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;