Azure Classic v5.38.0, Mar 21 23

azure.sentinel.LogAnalyticsWorkspaceOnboarding

Manages a Security Insights Sentinel Onboarding.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "PerGB2018",
    });

    var exampleLogAnalyticsWorkspaceOnboarding = new Azure.Sentinel.LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        WorkspaceName = exampleAnalyticsWorkspace.Name,
        CustomerManagedKeyEnabled = false,
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/operationalinsights"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/sentinel"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "exampleAnalyticsWorkspace", &operationalinsights.AnalyticsWorkspaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("PerGB2018"),
		})
		if err != nil {
			return err
		}
		_, err = sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "exampleLogAnalyticsWorkspaceOnboarding", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
			ResourceGroupName:         exampleResourceGroup.Name,
			WorkspaceName:             exampleAnalyticsWorkspace.Name,
			CustomerManagedKeyEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("PerGB2018")
            .build());

        var exampleLogAnalyticsWorkspaceOnboarding = new LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", LogAnalyticsWorkspaceOnboardingArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .workspaceName(exampleAnalyticsWorkspace.name())
            .customerManagedKeyEnabled(false)
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="PerGB2018")
example_log_analytics_workspace_onboarding = azure.sentinel.LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding",
    resource_group_name=example_resource_group.name,
    workspace_name=example_analytics_workspace.name,
    customer_managed_key_enabled=False)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "PerGB2018",
});
const exampleLogAnalyticsWorkspaceOnboarding = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", {
    resourceGroupName: exampleResourceGroup.name,
    workspaceName: exampleAnalyticsWorkspace.name,
    customerManagedKeyEnabled: false,
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: PerGB2018
  exampleLogAnalyticsWorkspaceOnboarding:
    type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      workspaceName: ${exampleAnalyticsWorkspace.name}
      customerManagedKeyEnabled: false

Create LogAnalyticsWorkspaceOnboarding Resource

new LogAnalyticsWorkspaceOnboarding(name: string, args: LogAnalyticsWorkspaceOnboardingArgs, opts?: CustomResourceOptions);

@overload
def LogAnalyticsWorkspaceOnboarding(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    customer_managed_key_enabled: Optional[bool] = None,
                                    resource_group_name: Optional[str] = None,
                                    workspace_name: Optional[str] = None)
@overload
def LogAnalyticsWorkspaceOnboarding(resource_name: str,
                                    args: LogAnalyticsWorkspaceOnboardingArgs,
                                    opts: Optional[ResourceOptions] = 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.

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.

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

The LogAnalyticsWorkspaceOnboarding resource accepts the following input properties:

ResourceGroupName string: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
WorkspaceName string: Specifies the Workspace Name. 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.

ResourceGroupName string: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
WorkspaceName string: Specifies the Workspace Name. 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.

resourceGroupName String: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspaceName String: Specifies the Workspace Name. 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.

resourceGroupName string: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspaceName string: Specifies the Workspace Name. 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.

resource_group_name str: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspace_name str: Specifies the Workspace Name. 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.

resourceGroupName String: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspaceName String: Specifies the Workspace Name. 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.

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,
        resource_group_name: Optional[str] = None,
        workspace_name: 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)

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:

CustomerManagedKeyEnabled bool: Specifies if the Workspace is using Customer managed key. Defaults to false. Changing this forces a new resource to be created.
ResourceGroupName string: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
WorkspaceName string: Specifies the Workspace Name. 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.
ResourceGroupName string: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
WorkspaceName string: Specifies the Workspace Name. 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.
resourceGroupName String: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspaceName String: Specifies the Workspace Name. 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.
resourceGroupName string: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspaceName string: Specifies the Workspace Name. 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.
resource_group_name str: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspace_name str: Specifies the Workspace Name. 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.
resourceGroupName String: Specifies the name of the Resource Group where the Security Insights Sentinel Onboarding States should exist. Changing this forces the Log Analytics Workspace off the board and onboard again.
workspaceName String: Specifies the Workspace Name. 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

Package Details

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