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
- list_by_workspace
OK response definition.
Name | Datatype | Description |
---|---|---|
properties | object | data export properties. |
OK response definition.
Name | Datatype | Description |
---|---|---|
properties | object | data export properties. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , workspaceName , dataExportName | Gets a data export instance. | |
list_by_workspace | select | subscriptionId , resourceGroupName , workspaceName | Lists the data export instances within a workspace. | |
create_or_update | insert | subscriptionId , resourceGroupName , workspaceName , dataExportName | Create or update a data export. | |
delete | delete | subscriptionId , resourceGroupName , workspaceName , dataExportName | 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 |
---|---|---|
dataExportName | string | The data export rule name. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
workspaceName | string | The name of the workspace. |
SELECT
examples
- get
- list_by_workspace
Gets a data export instance.
SELECT
properties
FROM azure.log_analytics.data_exports
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND dataExportName = '{{ dataExportName }}' -- required
;
Lists the data export instances within a workspace.
SELECT
properties
FROM azure.log_analytics.data_exports
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
Create or update a data export.
INSERT INTO azure.log_analytics.data_exports (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
dataExportName
)
SELECT
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ dataExportName }}'
RETURNING
properties
;
# Description fields are for documentation purposes
- name: data_exports
props:
- name: subscriptionId
value: string
description: Required parameter for the data_exports resource.
- name: resourceGroupName
value: string
description: Required parameter for the data_exports resource.
- name: workspaceName
value: string
description: Required parameter for the data_exports resource.
- name: dataExportName
value: string
description: Required parameter for the data_exports resource.
- name: properties
value: object
description: |
data export properties.
DELETE
examples
- delete
Deletes the specified data export in a given workspace..
DELETE FROM azure.log_analytics.data_exports
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND dataExportName = '{{ dataExportName }}' --required
;