Freigeben über

Sentinel Onboarding States - Create

Dienst:
Sentinel
API-Version:
2025-09-01

Erstellen des Sentinel-Onboarding-Zustands

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
sentinelOnboardingStateName
 path True

string

Der Name des Sentinel-Onboardingzustands. Unterstützt - Standard
subscriptionId
 path True

string (uuid)

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceName
 path True

string

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

Der Name des Arbeitsbereichs.
api-version
 query True

string

minLength: 1

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Typ Beschreibung
etag

string

Etag der Azure-Ressource
properties.customerManagedKey

boolean

Flag, das den Status der CMK-Einstellung angibt

Antworten

Name Typ Beschreibung
200 OK

SentinelOnboardingState

OKAY
201 Created

SentinelOnboardingState

Erstellt
Other Status Codes

CloudError

Fehler beim Erstellen des Sentinel-Onboarding-Status

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

Create Sentinel onboarding state

Beispielanforderung

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=2025-09-01

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

Beispiel für eine Antwort

Statuscode:
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
  }
}
Statuscode:
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
  }
}

Definitionen

Name Beschreibung
CloudError

Struktur der Fehlerantwort.
CloudErrorBody

Fehlerdetails.
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
SentinelOnboardingState

Status des Sentinel-Onboardings
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Objekt

Struktur der Fehlerantwort.

Name Typ Beschreibung
error

CloudErrorBody

Fehlerdaten

CloudErrorBody

Objekt

Fehlerdetails.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

SentinelOnboardingState

Objekt

Status des Sentinel-Onboardings

Name Typ Beschreibung
etag

string

Etag der Azure-Ressource
id

string (arm-id)

Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Der Name der Ressource
properties.customerManagedKey

boolean

Flag, das den Status der CMK-Einstellung angibt
systemData

systemData

Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string (date-time)

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.