Microsoft.OperationalInsights workspaces/dataExports

  • Article

Bicep resource definition

The workspaces/dataExports resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OperationalInsights/workspaces/dataExports resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.OperationalInsights/workspaces/dataExports@2020-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    createdDate: 'string'
    dataExportId: 'string'
    destination: {
      metaData: {
        eventHubName: 'string'
      }
      resourceId: 'string'
    }
    enable: bool
    lastModifiedDate: 'string'
    tableNames: [
      'string'
    ]
  }
}

Property values

workspaces/dataExports

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: workspaces
properties data export properties. DataExportProperties

DataExportProperties

Name Description Value
createdDate The latest data export rule modification time. string
dataExportId The data export rule ID. string
destination destination properties. Destination
enable Active when enabled. bool
lastModifiedDate Date and time when the export was last modified. string
tableNames An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. string[] (required)

Destination

Name Description Value
metaData destination meta data. DestinationMetaData
resourceId The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. string (required)

DestinationMetaData

Name Description Value
eventHubName Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. string

ARM template resource definition

The workspaces/dataExports resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OperationalInsights/workspaces/dataExports resource, add the following JSON to your template.

{
  "type": "Microsoft.OperationalInsights/workspaces/dataExports",
  "apiVersion": "2020-08-01",
  "name": "string",
  "properties": {
    "createdDate": "string",
    "dataExportId": "string",
    "destination": {
      "metaData": {
        "eventHubName": "string"
      },
      "resourceId": "string"
    },
    "enable": "bool",
    "lastModifiedDate": "string",
    "tableNames": [ "string" ]
  }
}

Property values

workspaces/dataExports

Name Description Value
type The resource type 'Microsoft.OperationalInsights/workspaces/dataExports'
apiVersion The resource api version '2020-08-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties data export properties. DataExportProperties

DataExportProperties

Name Description Value
createdDate The latest data export rule modification time. string
dataExportId The data export rule ID. string
destination destination properties. Destination
enable Active when enabled. bool
lastModifiedDate Date and time when the export was last modified. string
tableNames An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. string[] (required)

Destination

Name Description Value
metaData destination meta data. DestinationMetaData
resourceId The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. string (required)

DestinationMetaData

Name Description Value
eventHubName Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. string

Terraform (AzAPI provider) resource definition

The workspaces/dataExports resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.OperationalInsights/workspaces/dataExports resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.OperationalInsights/workspaces/dataExports@2020-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      createdDate = "string"
      dataExportId = "string"
      destination = {
        metaData = {
          eventHubName = "string"
        }
        resourceId = "string"
      }
      enable = bool
      lastModifiedDate = "string"
      tableNames = [
        "string"
      ]
    }
  })
}

Property values

workspaces/dataExports

Name Description Value
type The resource type "Microsoft.OperationalInsights/workspaces/dataExports@2020-08-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties data export properties. DataExportProperties

DataExportProperties

Name Description Value
createdDate The latest data export rule modification time. string
dataExportId The data export rule ID. string
destination destination properties. Destination
enable Active when enabled. bool
lastModifiedDate Date and time when the export was last modified. string
tableNames An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. string[] (required)

Destination

Name Description Value
metaData destination meta data. DestinationMetaData
resourceId The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. string (required)

DestinationMetaData

Name Description Value
eventHubName Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. string