Share via

Sentinel Onboarding States - List

Service:
Sentinel
API Version:
2025-09-01

Gets all Sentinel onboarding states

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

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

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

string (uuid)

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

string

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

The name of the workspace.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

SentinelOnboardingStatesList

OK
Other Status Codes

CloudError

Error in listing the Sentinel onboarding states

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

Get all Sentinel onboarding states

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "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
SentinelOnboardingStatesList

List of the Sentinel onboarding states
systemData

Metadata pertaining to creation and last modification of the resource.

CloudError

Object

Error response structure.

Name Type Description
error

CloudErrorBody

Error data

CloudErrorBody

Object

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

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

SentinelOnboardingState

Object

Sentinel onboarding state

Name Type Description
etag

string

Etag of the azure resource
id

string (arm-id)

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"

SentinelOnboardingStatesList

Object

List of the Sentinel onboarding states

Name Type Description
value

SentinelOnboardingState[]

Array of Sentinel onboarding states

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

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 (date-time)

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.