Partilhar via

Sentinel Onboarding States - Create

  • Reference
Service:
Sentinel
API Version:
2024-09-01

Create Sentinel onboarding state

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}?api-version=2024-09-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
sentinelOnboardingStateName
 path True

string

The Sentinel onboarding state name. Supports - default
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
workspaceName
 path True

string

The name of the workspace.

Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

The API version to use for this operation.

Request Body

Name Type Description
etag

string

Etag of the azure resource
properties.customerManagedKey

boolean

Flag that indicates the status of the CMK setting

Responses

Name Type Description
200 OK

SentinelOnboardingState

OK
201 Created

SentinelOnboardingState

Created
Other Status Codes

CloudError

Error in creating the Sentinel onboarding state

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create Sentinel onboarding state

Sample request

PUT https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default?api-version=2024-09-01

{
  "properties": {
    "customerManagedKey": false
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default",
  "name": "default",
  "type": "Microsoft.SecurityInsights/onboardingStates",
  "properties": {
    "customerManagedKey": false
  }
}
Status code:
201 
{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default",
  "name": "default",
  "type": "Microsoft.SecurityInsights/onboardingStates",
  "properties": {
    "customerManagedKey": false
  }
}

Definitions

Name Description
CloudError

Error response structure.
CloudErrorBody

Error details.
createdByType

The type of identity that created the resource.
SentinelOnboardingState

Sentinel onboarding state
systemData

Metadata pertaining to creation and last modification of the resource.

CloudError

Error response structure.

Name Type Description
error

CloudErrorBody

Error data

CloudErrorBody

Error details.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message

string

A message describing the error, intended to be suitable for display in a user interface.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

SentinelOnboardingState

Sentinel onboarding state

Name Type Description
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
properties.customerManagedKey

boolean

Flag that indicates the status of the CMK setting
systemData

systemData

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"

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

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

createdByType

The type of identity that last modified the resource.