Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. sentinel
  5. LogAnalyticsWorkspaceOnboarding

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.sentinel.LogAnalyticsWorkspaceOnboarding

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Security Insights Sentinel Onboarding.

    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: "example-law",
    location: example.location,
    resourceGroupName: example.name,
    sku: "PerGB2018",
});
const exampleLogAnalyticsWorkspaceOnboarding = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("example", {
    workspaceId: exampleAnalyticsWorkspace.id,
    customerManagedKeyEnabled: false,
});

    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="example-law",
    location=example.location,
    resource_group_name=example.name,
    sku="PerGB2018")
example_log_analytics_workspace_onboarding = azure.sentinel.LogAnalyticsWorkspaceOnboarding("example",
    workspace_id=example_analytics_workspace.id,
    customer_managed_key_enabled=False)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/operationalinsights"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/sentinel"
	"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("example-law"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("PerGB2018"),
		})
		if err != nil {
			return err
		}
		_, err = sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "example", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
			WorkspaceId:               exampleAnalyticsWorkspace.ID(),
			CustomerManagedKeyEnabled: pulumi.Bool(false),
		})
		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 = "example-law",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "PerGB2018",
    });

    var exampleLogAnalyticsWorkspaceOnboarding = new Azure.Sentinel.LogAnalyticsWorkspaceOnboarding("example", new()
    {
        WorkspaceId = exampleAnalyticsWorkspace.Id,
        CustomerManagedKeyEnabled = false,
    });

});

    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.sentinel.LogAnalyticsWorkspaceOnboarding;
import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboardingArgs;
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("example-law")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("PerGB2018")
            .build());

        var exampleLogAnalyticsWorkspaceOnboarding = new LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", LogAnalyticsWorkspaceOnboardingArgs.builder()
            .workspaceId(exampleAnalyticsWorkspace.id())
            .customerManagedKeyEnabled(false)
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    name: example
    properties:
      name: example-law
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: PerGB2018
  exampleLogAnalyticsWorkspaceOnboarding:
    type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
    name: example
    properties:
      workspaceId: ${exampleAnalyticsWorkspace.id}
      customerManagedKeyEnabled: false

    Create LogAnalyticsWorkspaceOnboarding Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LogAnalyticsWorkspaceOnboarding(name: string, args: LogAnalyticsWorkspaceOnboardingArgs, opts?: CustomResourceOptions);
    @overload
def LogAnalyticsWorkspaceOnboarding(resource_name: str,
                                    args: LogAnalyticsWorkspaceOnboardingArgs,
                                    opts: Optional[ResourceOptions] = None)

@overload
def LogAnalyticsWorkspaceOnboarding(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    workspace_id: Optional[str] = None,
                                    customer_managed_key_enabled: Optional[bool] = None)
    func NewLogAnalyticsWorkspaceOnboarding(ctx *Context, name string, args LogAnalyticsWorkspaceOnboardingArgs, opts ...ResourceOption) (*LogAnalyticsWorkspaceOnboarding, error)
    public LogAnalyticsWorkspaceOnboarding(string name, LogAnalyticsWorkspaceOnboardingArgs args, CustomResourceOptions? opts = null)
    public LogAnalyticsWorkspaceOnboarding(String name, LogAnalyticsWorkspaceOnboardingArgs args)
public LogAnalyticsWorkspaceOnboarding(String name, LogAnalyticsWorkspaceOnboardingArgs args, CustomResourceOptions options)

    type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LogAnalyticsWorkspaceOnboardingArgs
    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 LogAnalyticsWorkspaceOnboardingArgs
    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 LogAnalyticsWorkspaceOnboardingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogAnalyticsWorkspaceOnboardingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogAnalyticsWorkspaceOnboardingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var logAnalyticsWorkspaceOnboardingResource = new Azure.Sentinel.LogAnalyticsWorkspaceOnboarding("logAnalyticsWorkspaceOnboardingResource", new()
{
    WorkspaceId = "string",
    CustomerManagedKeyEnabled = false,
});

    example, err := sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "logAnalyticsWorkspaceOnboardingResource", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
	WorkspaceId:               pulumi.String("string"),
	CustomerManagedKeyEnabled: pulumi.Bool(false),
})

    var logAnalyticsWorkspaceOnboardingResource = new LogAnalyticsWorkspaceOnboarding("logAnalyticsWorkspaceOnboardingResource", LogAnalyticsWorkspaceOnboardingArgs.builder()
    .workspaceId("string")
    .customerManagedKeyEnabled(false)
    .build());

    log_analytics_workspace_onboarding_resource = azure.sentinel.LogAnalyticsWorkspaceOnboarding("logAnalyticsWorkspaceOnboardingResource",
    workspace_id="string",
    customer_managed_key_enabled=False)

    const logAnalyticsWorkspaceOnboardingResource = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("logAnalyticsWorkspaceOnboardingResource", {
    workspaceId: "string",
    customerManagedKeyEnabled: false,
});

    type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
properties:
    customerManagedKeyEnabled: false
    workspaceId: string

    LogAnalyticsWorkspaceOnboarding Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LogAnalyticsWorkspaceOnboarding resource accepts the following input properties:

    WorkspaceId string
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    CustomerManagedKeyEnabled bool

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    WorkspaceId string
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    CustomerManagedKeyEnabled bool

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspaceId String
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customerManagedKeyEnabled Boolean

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspaceId string
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customerManagedKeyEnabled boolean

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspace_id str
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customer_managed_key_enabled bool

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspaceId String
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customerManagedKeyEnabled Boolean

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LogAnalyticsWorkspaceOnboarding Resource

    Get an existing LogAnalyticsWorkspaceOnboarding 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?: LogAnalyticsWorkspaceOnboardingState, opts?: CustomResourceOptions): LogAnalyticsWorkspaceOnboarding
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        customer_managed_key_enabled: Optional[bool] = None,
        workspace_id: Optional[str] = None) -> LogAnalyticsWorkspaceOnboarding
    func GetLogAnalyticsWorkspaceOnboarding(ctx *Context, name string, id IDInput, state *LogAnalyticsWorkspaceOnboardingState, opts ...ResourceOption) (*LogAnalyticsWorkspaceOnboarding, error)
    public static LogAnalyticsWorkspaceOnboarding Get(string name, Input<string> id, LogAnalyticsWorkspaceOnboardingState? state, CustomResourceOptions? opts = null)
    public static LogAnalyticsWorkspaceOnboarding get(String name, Output<String> id, LogAnalyticsWorkspaceOnboardingState state, CustomResourceOptions options)
    resources:  _:    type: azure:sentinel:LogAnalyticsWorkspaceOnboarding    get:      id: ${id}
    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:
    CustomerManagedKeyEnabled bool

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    WorkspaceId string
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    CustomerManagedKeyEnabled bool

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    WorkspaceId string
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customerManagedKeyEnabled Boolean

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspaceId String
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customerManagedKeyEnabled boolean

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspaceId string
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customer_managed_key_enabled bool

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspace_id str
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.
    customerManagedKeyEnabled Boolean

    Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.

    Note: To set up Microsoft Sentinel customer-managed key it needs to enable CMK on the workspace and add access policy to your Azure Key Vault. Details could be found on this document

    Note: Once a workspace is onboarded to Microsoft Sentinel with customer_managed_key_enabled set to true, it will not be able to be onboarded again with customer_managed_key_enabled set to false.

    workspaceId String
    Specifies the Workspace Id. Changing this forces the Log Analytics Workspace off the board and onboard again. Changing this forces a new resource to be created.

    Import

    Security Insights Sentinel Onboarding States can be imported using the resource id, e.g.

    $ pulumi import azure:sentinel/logAnalyticsWorkspaceOnboarding:LogAnalyticsWorkspaceOnboarding example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.OperationalInsights/workspaces/workspace1/providers/Microsoft.SecurityInsights/onboardingStates/defaults

    To learn more about importing existing cloud resources, see Importing resources.

    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 v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure