Sentinel Onboarding States - Create

Service:

Sentinel

API Version:

2024-03-01

Créer un état d’intégration Sentinel

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
sentinelOnboardingStateName	path	True	string	Nom de l’état d’intégration Sentinel. Prise en charge : par défaut
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
etag	string	Etag de la ressource Azure
properties.customerManagedKey	boolean	Indicateur qui indique la status du paramètre CMK

Réponses

Nom	Type	Description
200 OK	SentinelOnboardingState	Ok
201 Created	SentinelOnboardingState	Date de création
Other Status Codes	CloudError	Erreur lors de la création de l’état d’intégration sentinel

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Create Sentinel onboarding state

Sample Request

HTTP

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-03-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
  }
}

Définitions

Nom	Description
CloudError	Structure de réponse d’erreur.
CloudErrorBody	Détails de l’erreur.
createdByType	Type d’identité qui a créé la ressource.
SentinelOnboardingState	État d’intégration de Sentinel
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CloudError

Structure de réponse d’erreur.

Nom	Type	Description
error	CloudErrorBody	Données d’erreur

CloudErrorBody

Détails de l’erreur.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SentinelOnboardingState

État d’intégration de Sentinel

Nom	Type	Description
etag	string	Etag de la ressource Azure
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.customerManagedKey	boolean	Indicateur qui indique la status du paramètre CMK
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.