Data Exports - Get

Reference

Service:: Log Analytics

API Version:: 2023-09-01

Gets a data export instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
dataExportName	path	True	string	The data export rule name.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	DataExport	OK response definition.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DataExportGet

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/RgTest1/providers/Microsoft.OperationalInsights/workspaces/DeWnTest1234/dataExports/export1?api-version=2023-09-01

Sample response

Status code:: 200

{
  "properties": {
    "dataExportId": "d5233afc-7829-4b89-c594-08d7975e19a5",
    "destination": {
      "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test",
      "type": "EventHub"
    },
    "tableNames": [
      "Heartbeat"
    ],
    "enable": true,
    "createdDate": "Sun, 12 Jan 2020 12:51:10 GMT",
    "lastModifiedDate": "Sun, 12 Jan 2020 12:51:10 GMT"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/RgTest1/providers/microsoft.operationalinsights/workspaces/DeWnTest1234/export/export1",
  "name": "export1",
  "type": "Microsoft.OperationalInsights/workspaces/export"
}

Definitions

Name	Description
DataExport	The top level data export resource container.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
type	The type of the destination resource

DataExport

The top level data export resource container.

Name	Type	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
properties.createdDate	string	The latest data export rule modification time.
properties.dataExportId	string	The data export rule ID.
properties.destination.metaData.eventHubName	string	Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account.
properties.destination.resourceId	string	The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure.
properties.destination.type	type	The type of the destination resource
properties.enable	boolean	Active when enabled.
properties.lastModifiedDate	string	Date and time when the export was last modified.
properties.tableNames	string[]	An array of tables to export, for example: [“Heartbeat, SecurityEvent”].
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

type

The type of the destination resource

Name	Type	Description
EventHub	string
StorageAccount	string

Share via