Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. SentinelOnboardingState
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.securityinsights.SentinelOnboardingState

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Sentinel onboarding state

Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-04-01-preview, 2023-05-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-10-01-preview, 2025-01-01-preview, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native securityinsights [ApiVersion]. See the version guide for details.

Example Usage

Create Sentinel onboarding state

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sentinelOnboardingState = new AzureNative.SecurityInsights.SentinelOnboardingState("sentinelOnboardingState", new()
    {
        CustomerManagedKey = false,
        ResourceGroupName = "myRg",
        SentinelOnboardingStateName = "default",
        WorkspaceName = "myWorkspace",
    });

});
Copy
package main

import (
	securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityinsights.NewSentinelOnboardingState(ctx, "sentinelOnboardingState", &securityinsights.SentinelOnboardingStateArgs{
			CustomerManagedKey:          pulumi.Bool(false),
			ResourceGroupName:           pulumi.String("myRg"),
			SentinelOnboardingStateName: pulumi.String("default"),
			WorkspaceName:               pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.SentinelOnboardingState;
import com.pulumi.azurenative.securityinsights.SentinelOnboardingStateArgs;
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 sentinelOnboardingState = new SentinelOnboardingState("sentinelOnboardingState", SentinelOnboardingStateArgs.builder()
            .customerManagedKey(false)
            .resourceGroupName("myRg")
            .sentinelOnboardingStateName("default")
            .workspaceName("myWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sentinelOnboardingState = new azure_native.securityinsights.SentinelOnboardingState("sentinelOnboardingState", {
    customerManagedKey: false,
    resourceGroupName: "myRg",
    sentinelOnboardingStateName: "default",
    workspaceName: "myWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sentinel_onboarding_state = azure_native.securityinsights.SentinelOnboardingState("sentinelOnboardingState",
    customer_managed_key=False,
    resource_group_name="myRg",
    sentinel_onboarding_state_name="default",
    workspace_name="myWorkspace")
Copy
resources:
  sentinelOnboardingState:
    type: azure-native:securityinsights:SentinelOnboardingState
    properties:
      customerManagedKey: false
      resourceGroupName: myRg
      sentinelOnboardingStateName: default
      workspaceName: myWorkspace
Copy

Create SentinelOnboardingState Resource

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

Constructor syntax

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

@overload
def SentinelOnboardingState(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            resource_group_name: Optional[str] = None,
                            workspace_name: Optional[str] = None,
                            customer_managed_key: Optional[bool] = None,
                            sentinel_onboarding_state_name: Optional[str] = None)
func NewSentinelOnboardingState(ctx *Context, name string, args SentinelOnboardingStateArgs, opts ...ResourceOption) (*SentinelOnboardingState, error)
public SentinelOnboardingState(string name, SentinelOnboardingStateArgs args, CustomResourceOptions? opts = null)
public SentinelOnboardingState(String name, SentinelOnboardingStateArgs args)
public SentinelOnboardingState(String name, SentinelOnboardingStateArgs args, CustomResourceOptions options)

type: azure-native:securityinsights:SentinelOnboardingState
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SentinelOnboardingStateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SentinelOnboardingStateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SentinelOnboardingStateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SentinelOnboardingStateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SentinelOnboardingStateArgs
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 sentinelOnboardingStateResource = new AzureNative.SecurityInsights.SentinelOnboardingState("sentinelOnboardingStateResource", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    CustomerManagedKey = false,
    SentinelOnboardingStateName = "string",
});
Copy
example, err := securityinsights.NewSentinelOnboardingState(ctx, "sentinelOnboardingStateResource", &securityinsights.SentinelOnboardingStateArgs{
	ResourceGroupName:           pulumi.String("string"),
	WorkspaceName:               pulumi.String("string"),
	CustomerManagedKey:          pulumi.Bool(false),
	SentinelOnboardingStateName: pulumi.String("string"),
})
Copy
var sentinelOnboardingStateResource = new SentinelOnboardingState("sentinelOnboardingStateResource", SentinelOnboardingStateArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .customerManagedKey(false)
    .sentinelOnboardingStateName("string")
    .build());
Copy
sentinel_onboarding_state_resource = azure_native.securityinsights.SentinelOnboardingState("sentinelOnboardingStateResource",
    resource_group_name="string",
    workspace_name="string",
    customer_managed_key=False,
    sentinel_onboarding_state_name="string")
Copy
const sentinelOnboardingStateResource = new azure_native.securityinsights.SentinelOnboardingState("sentinelOnboardingStateResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    customerManagedKey: false,
    sentinelOnboardingStateName: "string",
});
Copy
type: azure-native:securityinsights:SentinelOnboardingState
properties:
    customerManagedKey: false
    resourceGroupName: string
    sentinelOnboardingStateName: string
    workspaceName: string
Copy

SentinelOnboardingState 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 SentinelOnboardingState resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
CustomerManagedKey bool
Flag that indicates the status of the CMK setting
SentinelOnboardingStateName Changes to this property will trigger replacement. string
The Sentinel onboarding state name. Supports - default
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
CustomerManagedKey bool
Flag that indicates the status of the CMK setting
SentinelOnboardingStateName Changes to this property will trigger replacement. string
The Sentinel onboarding state name. Supports - default
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
customerManagedKey Boolean
Flag that indicates the status of the CMK setting
sentinelOnboardingStateName Changes to this property will trigger replacement. String
The Sentinel onboarding state name. Supports - default
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
customerManagedKey boolean
Flag that indicates the status of the CMK setting
sentinelOnboardingStateName Changes to this property will trigger replacement. string
The Sentinel onboarding state name. Supports - default
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
customer_managed_key bool
Flag that indicates the status of the CMK setting
sentinel_onboarding_state_name Changes to this property will trigger replacement. str
The Sentinel onboarding state name. Supports - default
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
customerManagedKey Boolean
Flag that indicates the status of the CMK setting
sentinelOnboardingStateName Changes to this property will trigger replacement. String
The Sentinel onboarding state name. Supports - default

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Etag string
Etag of the azure resource
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Etag string
Etag of the azure resource
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag String
Etag of the azure resource
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag string
Etag of the azure resource
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag str
Etag of the azure resource
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag String
Etag of the azure resource

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:securityinsights:SentinelOnboardingState default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native