Microsoft.SecurityInsights onboardingStates 2022-11-01-preview

  • Article

Bicep resource definition

The onboardingStates resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SecurityInsights/onboardingStates resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.SecurityInsights/onboardingStates@2022-11-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  etag: 'string'
  properties: {
    customerManagedKey: bool
  }
}

Property values

onboardingStates

Name Description Value
name The resource name string (required)
scope Use when creating an extension resource at a scope that is different than the deployment scope. Target resource

For Bicep, set this property to the symbolic name of the resource to apply the extension resource.
etag Etag of the azure resource string
properties The Sentinel onboarding state object SentinelOnboardingStateProperties

SentinelOnboardingStateProperties

Name Description Value
customerManagedKey Flag that indicates the status of the CMK setting bool

ARM template resource definition

The onboardingStates resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SecurityInsights/onboardingStates resource, add the following JSON to your template.

{
  "type": "Microsoft.SecurityInsights/onboardingStates",
  "apiVersion": "2022-11-01-preview",
  "name": "string",
  "scope": "string",
  "etag": "string",
  "properties": {
    "customerManagedKey": "bool"
  }
}

Property values

onboardingStates

Name Description Value
type The resource type 'Microsoft.SecurityInsights/onboardingStates'
apiVersion The resource api version '2022-11-01-preview'
name The resource name string (required)
scope Use when creating an extension resource at a scope that is different than the deployment scope. Target resource

For JSON, set the value to the full name of the resource to apply the extension resource to.
etag Etag of the azure resource string
properties The Sentinel onboarding state object SentinelOnboardingStateProperties

SentinelOnboardingStateProperties

Name Description Value
customerManagedKey Flag that indicates the status of the CMK setting bool

Terraform (AzAPI provider) resource definition

The onboardingStates resource type is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SecurityInsights/onboardingStates resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SecurityInsights/onboardingStates@2022-11-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      customerManagedKey = bool
    }
    etag = "string"
  })
}

Property values

onboardingStates

Name Description Value
type The resource type "Microsoft.SecurityInsights/onboardingStates@2022-11-01-preview"
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
etag Etag of the azure resource string
properties The Sentinel onboarding state object SentinelOnboardingStateProperties

SentinelOnboardingStateProperties

Name Description Value
customerManagedKey Flag that indicates the status of the CMK setting bool