Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. securityinsights
  5. getSentinelOnboardingState
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.securityinsights.getSentinelOnboardingState

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get Sentinel onboarding state Azure REST API version: 2023-02-01.

Other available API versions: 2021-03-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-09-01, 2024-10-01-preview.

Using getSentinelOnboardingState

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSentinelOnboardingState(args: GetSentinelOnboardingStateArgs, opts?: InvokeOptions): Promise<GetSentinelOnboardingStateResult>
function getSentinelOnboardingStateOutput(args: GetSentinelOnboardingStateOutputArgs, opts?: InvokeOptions): Output<GetSentinelOnboardingStateResult>
Copy
def get_sentinel_onboarding_state(resource_group_name: Optional[str] = None,
                                  sentinel_onboarding_state_name: Optional[str] = None,
                                  workspace_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetSentinelOnboardingStateResult
def get_sentinel_onboarding_state_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                  sentinel_onboarding_state_name: Optional[pulumi.Input[str]] = None,
                                  workspace_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetSentinelOnboardingStateResult]
Copy
func LookupSentinelOnboardingState(ctx *Context, args *LookupSentinelOnboardingStateArgs, opts ...InvokeOption) (*LookupSentinelOnboardingStateResult, error)
func LookupSentinelOnboardingStateOutput(ctx *Context, args *LookupSentinelOnboardingStateOutputArgs, opts ...InvokeOption) LookupSentinelOnboardingStateResultOutput
Copy

> Note: This function is named LookupSentinelOnboardingState in the Go SDK.

public static class GetSentinelOnboardingState 
{
    public static Task<GetSentinelOnboardingStateResult> InvokeAsync(GetSentinelOnboardingStateArgs args, InvokeOptions? opts = null)
    public static Output<GetSentinelOnboardingStateResult> Invoke(GetSentinelOnboardingStateInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSentinelOnboardingStateResult> getSentinelOnboardingState(GetSentinelOnboardingStateArgs args, InvokeOptions options)
public static Output<GetSentinelOnboardingStateResult> getSentinelOnboardingState(GetSentinelOnboardingStateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getSentinelOnboardingState
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SentinelOnboardingStateName
This property is required.
Changes to this property will trigger replacement.
string
The Sentinel onboarding state name. Supports - default
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SentinelOnboardingStateName
This property is required.
Changes to this property will trigger replacement.
string
The Sentinel onboarding state name. Supports - default
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sentinelOnboardingStateName
This property is required.
Changes to this property will trigger replacement.
String
The Sentinel onboarding state name. Supports - default
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
sentinelOnboardingStateName
This property is required.
Changes to this property will trigger replacement.
string
The Sentinel onboarding state name. Supports - default
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
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.
sentinel_onboarding_state_name
This property is required.
Changes to this property will trigger replacement.
str
The Sentinel onboarding state name. Supports - default
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sentinelOnboardingStateName
This property is required.
Changes to this property will trigger replacement.
String
The Sentinel onboarding state name. Supports - default
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getSentinelOnboardingState Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
CustomerManagedKey bool
Flag that indicates the status of the CMK setting
Etag string
Etag of the azure resource
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
CustomerManagedKey bool
Flag that indicates the status of the CMK setting
Etag string
Etag of the azure resource
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
customerManagedKey Boolean
Flag that indicates the status of the CMK setting
etag String
Etag of the azure resource
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
customerManagedKey boolean
Flag that indicates the status of the CMK setting
etag string
Etag of the azure resource
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
customer_managed_key bool
Flag that indicates the status of the CMK setting
etag str
Etag of the azure resource
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
customerManagedKey Boolean
Flag that indicates the status of the CMK setting
etag String
Etag of the azure resource

Supporting Types

SystemDataResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native