1. Packages
  2. Azure Classic
  3. API Docs
  4. loganalytics
  5. DataExportRule

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.loganalytics.DataExportRule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a Log Analytics Data Export Rule.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
        name: "exampleworkspace",
        location: example.location,
        resourceGroupName: example.name,
        sku: "PerGB2018",
        retentionInDays: 30,
    });
    const exampleAccount = new azure.storage.Account("example", {
        name: "examplestoracc",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const exampleDataExportRule = new azure.loganalytics.DataExportRule("example", {
        name: "dataExport1",
        resourceGroupName: example.name,
        workspaceResourceId: exampleAnalyticsWorkspace.id,
        destinationResourceId: exampleAccount.id,
        tableNames: ["Heartbeat"],
        enabled: true,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
        name="exampleworkspace",
        location=example.location,
        resource_group_name=example.name,
        sku="PerGB2018",
        retention_in_days=30)
    example_account = azure.storage.Account("example",
        name="examplestoracc",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS")
    example_data_export_rule = azure.loganalytics.DataExportRule("example",
        name="dataExport1",
        resource_group_name=example.name,
        workspace_resource_id=example_analytics_workspace.id,
        destination_resource_id=example_account.id,
        table_names=["Heartbeat"],
        enabled=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/loganalytics"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/operationalinsights"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
    			Name:              pulumi.String("exampleworkspace"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Sku:               pulumi.String("PerGB2018"),
    			RetentionInDays:   pulumi.Int(30),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("examplestoracc"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = loganalytics.NewDataExportRule(ctx, "example", &loganalytics.DataExportRuleArgs{
    			Name:                  pulumi.String("dataExport1"),
    			ResourceGroupName:     example.Name,
    			WorkspaceResourceId:   exampleAnalyticsWorkspace.ID(),
    			DestinationResourceId: exampleAccount.ID(),
    			TableNames: pulumi.StringArray{
    				pulumi.String("Heartbeat"),
    			},
    			Enabled: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
        {
            Name = "exampleworkspace",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Sku = "PerGB2018",
            RetentionInDays = 30,
        });
    
        var exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "examplestoracc",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
    
        var exampleDataExportRule = new Azure.LogAnalytics.DataExportRule("example", new()
        {
            Name = "dataExport1",
            ResourceGroupName = example.Name,
            WorkspaceResourceId = exampleAnalyticsWorkspace.Id,
            DestinationResourceId = exampleAccount.Id,
            TableNames = new[]
            {
                "Heartbeat",
            },
            Enabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
    import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.loganalytics.DataExportRule;
    import com.pulumi.azure.loganalytics.DataExportRuleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()        
                .name("exampleworkspace")
                .location(example.location())
                .resourceGroupName(example.name())
                .sku("PerGB2018")
                .retentionInDays(30)
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .name("examplestoracc")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .build());
    
            var exampleDataExportRule = new DataExportRule("exampleDataExportRule", DataExportRuleArgs.builder()        
                .name("dataExport1")
                .resourceGroupName(example.name())
                .workspaceResourceId(exampleAnalyticsWorkspace.id())
                .destinationResourceId(exampleAccount.id())
                .tableNames("Heartbeat")
                .enabled(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAnalyticsWorkspace:
        type: azure:operationalinsights:AnalyticsWorkspace
        name: example
        properties:
          name: exampleworkspace
          location: ${example.location}
          resourceGroupName: ${example.name}
          sku: PerGB2018
          retentionInDays: 30
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: examplestoracc
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountTier: Standard
          accountReplicationType: LRS
      exampleDataExportRule:
        type: azure:loganalytics:DataExportRule
        name: example
        properties:
          name: dataExport1
          resourceGroupName: ${example.name}
          workspaceResourceId: ${exampleAnalyticsWorkspace.id}
          destinationResourceId: ${exampleAccount.id}
          tableNames:
            - Heartbeat
          enabled: true
    

    Create DataExportRule Resource

    new DataExportRule(name: string, args: DataExportRuleArgs, opts?: CustomResourceOptions);
    @overload
    def DataExportRule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       destination_resource_id: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       table_names: Optional[Sequence[str]] = None,
                       workspace_resource_id: Optional[str] = None)
    @overload
    def DataExportRule(resource_name: str,
                       args: DataExportRuleArgs,
                       opts: Optional[ResourceOptions] = None)
    func NewDataExportRule(ctx *Context, name string, args DataExportRuleArgs, opts ...ResourceOption) (*DataExportRule, error)
    public DataExportRule(string name, DataExportRuleArgs args, CustomResourceOptions? opts = null)
    public DataExportRule(String name, DataExportRuleArgs args)
    public DataExportRule(String name, DataExportRuleArgs args, CustomResourceOptions options)
    
    type: azure:loganalytics:DataExportRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DataExportRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataExportRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataExportRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataExportRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataExportRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DataExportRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DataExportRule resource accepts the following input properties:

    DestinationResourceId string
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    TableNames List<string>
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    WorkspaceResourceId string
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    Enabled bool
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    Name string
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    DestinationResourceId string
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    TableNames []string
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    WorkspaceResourceId string
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    Enabled bool
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    Name string
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    destinationResourceId String
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    tableNames List<String>
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspaceResourceId String
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    enabled Boolean
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    name String
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    destinationResourceId string
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    resourceGroupName string
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    tableNames string[]
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspaceResourceId string
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    enabled boolean
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    name string
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    destination_resource_id str
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    resource_group_name str
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    table_names Sequence[str]
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspace_resource_id str
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    enabled bool
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    name str
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    destinationResourceId String
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    tableNames List<String>
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspaceResourceId String
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    enabled Boolean
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    name String
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataExportRule resource produces the following output properties:

    ExportRuleId string
    The ID of the created Data Export Rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    ExportRuleId string
    The ID of the created Data Export Rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    exportRuleId String
    The ID of the created Data Export Rule.
    id String
    The provider-assigned unique ID for this managed resource.
    exportRuleId string
    The ID of the created Data Export Rule.
    id string
    The provider-assigned unique ID for this managed resource.
    export_rule_id str
    The ID of the created Data Export Rule.
    id str
    The provider-assigned unique ID for this managed resource.
    exportRuleId String
    The ID of the created Data Export Rule.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DataExportRule Resource

    Get an existing DataExportRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataExportRuleState, opts?: CustomResourceOptions): DataExportRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            destination_resource_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            export_rule_id: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            table_names: Optional[Sequence[str]] = None,
            workspace_resource_id: Optional[str] = None) -> DataExportRule
    func GetDataExportRule(ctx *Context, name string, id IDInput, state *DataExportRuleState, opts ...ResourceOption) (*DataExportRule, error)
    public static DataExportRule Get(string name, Input<string> id, DataExportRuleState? state, CustomResourceOptions? opts = null)
    public static DataExportRule get(String name, Output<String> id, DataExportRuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DestinationResourceId string
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    Enabled bool
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    ExportRuleId string
    The ID of the created Data Export Rule.
    Name string
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    TableNames List<string>
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    WorkspaceResourceId string
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    DestinationResourceId string
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    Enabled bool
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    ExportRuleId string
    The ID of the created Data Export Rule.
    Name string
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    ResourceGroupName string
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    TableNames []string
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    WorkspaceResourceId string
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    destinationResourceId String
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    enabled Boolean
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    exportRuleId String
    The ID of the created Data Export Rule.
    name String
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    tableNames List<String>
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspaceResourceId String
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    destinationResourceId string
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    enabled boolean
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    exportRuleId string
    The ID of the created Data Export Rule.
    name string
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    resourceGroupName string
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    tableNames string[]
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspaceResourceId string
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    destination_resource_id str
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    enabled bool
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    export_rule_id str
    The ID of the created Data Export Rule.
    name str
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    resource_group_name str
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    table_names Sequence[str]
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspace_resource_id str
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.
    destinationResourceId String
    The destination resource ID. It should be a storage account, an event hub namespace or an event hub. If the destination is an event hub namespace, an event hub would be created for each table automatically.
    enabled Boolean
    Is this Log Analytics Data Export Rule enabled? Possible values include true or false. Defaults to false.
    exportRuleId String
    The ID of the created Data Export Rule.
    name String
    The name of the Log Analytics Data Export Rule. Changing this forces a new Log Analytics Data Export Rule to be created.
    resourceGroupName String
    The name of the Resource Group where the Log Analytics Data Export should exist. Changing this forces a new Log Analytics Data Export Rule to be created.
    tableNames List<String>
    A list of table names to export to the destination resource, for example: ["Heartbeat", "SecurityEvent"].
    workspaceResourceId String
    The resource ID of the workspace. Changing this forces a new Log Analytics Data Export Rule to be created.

    Import

    Log Analytics Data Export Rule can be imported using the resource id, e.g.

    $ pulumi import azure:loganalytics/dataExportRule:DataExportRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.OperationalInsights/workspaces/workspace1/dataExports/dataExport1
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi