We recommend using Azure Native.
azure.sentinel.LogAnalyticsWorkspaceOnboarding
Explore with Pulumi AI
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", {
resourceGroupName: example.name,
workspaceName: exampleAnalyticsWorkspace.name,
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",
resource_group_name=example.name,
workspace_name=example_analytics_workspace.name,
customer_managed_key_enabled=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 {
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{
ResourceGroupName: example.Name,
WorkspaceName: exampleAnalyticsWorkspace.Name,
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()
{
ResourceGroupName = example.Name,
WorkspaceName = exampleAnalyticsWorkspace.Name,
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()
.resourceGroupName(example.name())
.workspaceName(exampleAnalyticsWorkspace.name())
.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:
resourceGroupName: ${example.name}
workspaceName: ${exampleAnalyticsWorkspace.name}
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: Optional[LogAnalyticsWorkspaceOnboardingArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def LogAnalyticsWorkspaceOnboarding(resource_name: str,
opts: Optional[ResourceOptions] = None,
customer_managed_key_enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
workspace_id: Optional[str] = None,
workspace_name: Optional[str] = None)
func NewLogAnalyticsWorkspaceOnboarding(ctx *Context, name string, args *LogAnalyticsWorkspaceOnboardingArgs, opts ...ResourceOption) (*LogAnalyticsWorkspaceOnboarding, error)
public LogAnalyticsWorkspaceOnboarding(string name, LogAnalyticsWorkspaceOnboardingArgs? args = null, 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()
{
CustomerManagedKeyEnabled = false,
WorkspaceId = "string",
});
example, err := sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "logAnalyticsWorkspaceOnboardingResource", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
CustomerManagedKeyEnabled: pulumi.Bool(false),
WorkspaceId: pulumi.String("string"),
})
var logAnalyticsWorkspaceOnboardingResource = new LogAnalyticsWorkspaceOnboarding("logAnalyticsWorkspaceOnboardingResource", LogAnalyticsWorkspaceOnboardingArgs.builder()
.customerManagedKeyEnabled(false)
.workspaceId("string")
.build());
log_analytics_workspace_onboarding_resource = azure.sentinel.LogAnalyticsWorkspaceOnboarding("logAnalyticsWorkspaceOnboardingResource",
customer_managed_key_enabled=False,
workspace_id="string")
const logAnalyticsWorkspaceOnboardingResource = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("logAnalyticsWorkspaceOnboardingResource", {
customerManagedKeyEnabled: false,
workspaceId: "string",
});
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
The LogAnalyticsWorkspaceOnboarding resource accepts the following input properties:
- Customer
Managed boolKey Enabled 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 withcustomer_managed_key_enabled
set to false.- Resource
Group stringName - 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
Id string - Workspace
Name 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 boolKey Enabled 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 withcustomer_managed_key_enabled
set to false.- Resource
Group stringName - 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
Id string - Workspace
Name 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 BooleanKey Enabled 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 withcustomer_managed_key_enabled
set to false.- resource
Group StringName - 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
Id String - workspace
Name 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 booleanKey Enabled 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 withcustomer_managed_key_enabled
set to false.- resource
Group stringName - 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
Id string - workspace
Name 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_ boolkey_ enabled 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 withcustomer_managed_key_enabled
set to false.- resource_
group_ strname - 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_
id str - 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 BooleanKey Enabled 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 withcustomer_managed_key_enabled
set to false.- resource
Group StringName - 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
Id String - workspace
Name 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.
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_id: 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.
- Customer
Managed boolKey Enabled 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 withcustomer_managed_key_enabled
set to false.- Resource
Group stringName - 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
Id string - Workspace
Name 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 boolKey Enabled 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 withcustomer_managed_key_enabled
set to false.- Resource
Group stringName - 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
Id string - Workspace
Name 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 BooleanKey Enabled 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 withcustomer_managed_key_enabled
set to false.- resource
Group StringName - 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
Id String - workspace
Name 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 booleanKey Enabled 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 withcustomer_managed_key_enabled
set to false.- resource
Group stringName - 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
Id string - workspace
Name 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_ boolkey_ enabled 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 withcustomer_managed_key_enabled
set to false.- resource_
group_ strname - 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_
id str - 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 BooleanKey Enabled 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 withcustomer_managed_key_enabled
set to false.- resource
Group StringName - 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
Id String - workspace
Name 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
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.