Assessments - Create Or Update

Référence

Service:: Defender for Cloud

API Version:: 2020-01-01

Créez une évaluation de sécurité sur votre ressource. Les métadonnées d’évaluation qui décrivent cette évaluation doivent être prédéfinies avec le même nom avant d’insérer le résultat de l’évaluation

PUT https://management.azure.com/{resourceId}/providers/Microsoft.Security/assessments/{assessmentName}?api-version=2020-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
assessmentName	path	True	string	La clé d’évaluation : clé unique pour le type d’évaluation
resourceId	path	True	string	Identificateur de la ressource.
api-version	query	True	string	Version de l’API pour l’opération

Corps de la demande

Nom	Obligatoire	Type	Description
properties.resourceDetails	True	ResourceDetails: OnPremiseResourceDetails AzureResourceDetails OnPremiseSqlResourceDetails	Détails de la ressource évaluée
properties.status	True	AssessmentStatus	Résultat de l’évaluation
properties.additionalData		object	Données supplémentaires relatives à l’évaluation
properties.metadata		SecurityAssessmentMetadataProperties	Décrit les propriétés d’une métadonnées d’évaluation.
properties.partnersData		SecurityAssessmentPartnerData	Données relatives à l’intégration de partenaires tiers

Réponses

Nom	Type	Description
200 OK	SecurityAssessment	OK - Mise à jour
201 Created	SecurityAssessment	Date de création
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

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 security recommendation task on a resource

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e?api-version=2020-01-01

{
  "properties": {
    "resourceDetails": {
      "source": "Azure"
    },
    "status": {
      "code": "Healthy"
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "name": "8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"
    },
    "displayName": "Install internal agent on VM",
    "status": {
      "code": "Healthy"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "name": "8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"
    },
    "displayName": "Install internal agent on VM",
    "status": {
      "code": "Healthy"
    }
  }
}

Définitions

Nom	Description
AssessmentLinks	Liens pertinents pour l’évaluation
AssessmentStatus	Résultat de l’évaluation
AssessmentStatusCode	Code programmatique pour le status de l’évaluation
assessmentType	BuiltIn si l’évaluation basée sur une définition de Azure Policy intégrée, Personnalisé si l’évaluation basée sur une définition de Azure Policy personnalisée
AzureResourceDetails	Détails de la ressource Azure évaluée
categories
CloudError	Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
CloudErrorBody	Détail de l’erreur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
implementationEffort	Effort de mise en œuvre nécessaire pour corriger cette évaluation
OnPremiseResourceDetails	Détails de la ressource locale évaluée
OnPremiseSqlResourceDetails	Détails de la ressource Sql locale qui a été évaluée
SecurityAssessment	Évaluation de la sécurité sur une ressource
SecurityAssessmentMetadataPartnerData	Décrit le partenaire qui a créé l’évaluation
SecurityAssessmentMetadataProperties	Décrit les propriétés d’une métadonnées d’évaluation.
SecurityAssessmentPartnerData	Données relatives à l’intégration de partenaires tiers
severity	Niveau de gravité de l’évaluation
threats
userImpact	Impact de l’évaluation sur l’utilisateur

AssessmentLinks

Liens pertinents pour l’évaluation

Nom	Type	Description
azurePortalUri	string	Lien vers l’évaluation dans le portail Azure

AssessmentStatus

Résultat de l’évaluation

Nom	Type	Description
cause	string	Code programmatique pour la cause de l’évaluation status
code	AssessmentStatusCode	Code programmatique pour le status de l’évaluation
description	string	Description lisible par l’homme de l’état d’évaluation

AssessmentStatusCode

Code programmatique pour le status de l’évaluation

Nom	Type	Description
Healthy	string	La ressource est saine
NotApplicable	string	L’évaluation de cette ressource n’a pas eu lieu
Unhealthy	string	La ressource présente un problème de sécurité qui doit être résolu

assessmentType

BuiltIn si l’évaluation basée sur une définition de Azure Policy intégrée, Personnalisé si l’évaluation basée sur une définition de Azure Policy personnalisée

Nom	Type	Description
BuiltIn	string	Microsoft Defender pour les évaluations gérées par le cloud
CustomPolicy	string	Stratégies définies par l’utilisateur qui sont automatiquement ingérées de Azure Policy à Microsoft Defender pour le cloud
CustomerManaged	string	Évaluations utilisateur envoyées directement par l’utilisateur ou un autre tiers pour Microsoft Defender pour le cloud
VerifiedPartner	string	Évaluation qui a été créée par une tierce partie vérifiée si l’utilisateur l’a connectée à ASC

AzureResourceDetails

Détails de la ressource Azure évaluée

Nom	Type	Description
id	string	ID de ressource Azure de la ressource évaluée
source	string: Azure	Plateforme où réside la ressource évaluée

Nom	Type	Description
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
error.code	string	Code d'erreur.
error.details	CloudErrorBody[]	Détails de l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible d’erreur.

CloudErrorBody

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	CloudErrorBody[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

implementationEffort

Effort de mise en œuvre nécessaire pour corriger cette évaluation

Nom	Type	Description
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

Détails de la ressource locale évaluée

Nom	Type	Description
machineName	string	Nom de la machine
source	string: OnPremise	Plateforme où réside la ressource évaluée
sourceComputerId	string	ID de l’agent OMS installé sur l’ordinateur
vmuuid	string	ID unique de la machine
workspaceId	string	ID de ressource Azure de l’espace de travail auquel la machine est attachée

OnPremiseSqlResourceDetails

Détails de la ressource Sql locale qui a été évaluée

Nom	Type	Description
databaseName	string	Nom de la base de données Sql installée sur l’ordinateur
machineName	string	Nom de la machine
serverName	string	Nom du serveur Sql installé sur l’ordinateur
source	string: OnPremiseSql	Plateforme où réside la ressource évaluée
sourceComputerId	string	ID de l’agent OMS installé sur l’ordinateur
vmuuid	string	ID unique de la machine
workspaceId	string	ID de ressource Azure de l’espace de travail auquel la machine est attachée

SecurityAssessment

Évaluation de la sécurité sur une ressource

Nom	Type	Description
id	string	ID de ressource
name	string	Nom de la ressource
properties.additionalData	object	Données supplémentaires relatives à l’évaluation
properties.displayName	string	Nom d’affichage convivial de l’évaluation
properties.links	AssessmentLinks	Liens pertinents pour l’évaluation
properties.metadata	SecurityAssessmentMetadataProperties	Décrit les propriétés d’une métadonnées d’évaluation.
properties.partnersData	SecurityAssessmentPartnerData	Données relatives à l’intégration de partenaires tiers
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Détails de la ressource évaluée
properties.status	AssessmentStatus	Résultat de l’évaluation
type	string	Type de ressource

SecurityAssessmentMetadataPartnerData

Décrit le partenaire qui a créé l’évaluation

Nom	Type	Description
partnerName	string	Nom de la société du partenaire
productName	string	Nom du produit du partenaire qui a créé l’évaluation
secret	string	Secret pour authentifier le partenaire et vérifier qu’il a créé l’évaluation - écriture uniquement

SecurityAssessmentMetadataProperties

Décrit les propriétés d’une métadonnées d’évaluation.

Nom	Type	Description
assessmentType	assessmentType	BuiltIn si l’évaluation basée sur une définition de Azure Policy intégrée, Personnalisé si l’évaluation basée sur une définition de Azure Policy personnalisée
categories	categories[]	Catégories de ressources à risque lorsque l’évaluation n’est pas saine
description	string	Description lisible par l’homme de l’évaluation
displayName	string	Nom d’affichage convivial de l’évaluation
implementationEffort	implementationEffort	Effort de mise en œuvre nécessaire pour corriger cette évaluation
partnerData	SecurityAssessmentMetadataPartnerData	Décrit le partenaire qui a créé l’évaluation
policyDefinitionId	string	ID de ressource Azure de la définition de stratégie qui active ce calcul d’évaluation
preview	boolean	True si cette évaluation est en préversion status
remediationDescription	string	Description lisible par l’utilisateur de ce que vous devez faire pour atténuer ce problème de sécurité
severity	severity	Niveau de gravité de l’évaluation
threats	threats[]	Impact des menaces de l’évaluation
userImpact	userImpact	Impact de l’évaluation sur l’utilisateur

SecurityAssessmentPartnerData

Données relatives à l’intégration de partenaires tiers

Nom	Type	Description
partnerName	string	Nom de la société du partenaire
secret	string	secret pour authentifier le partenaire - écriture uniquement

severity

Niveau de gravité de l’évaluation

Nom	Type	Description
High	string
Low	string
Medium	string

threats

Nom	Type	Description
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Impact de l’évaluation sur l’utilisateur

Nom	Type	Description
High	string
Low	string
Moderate	string

Partager via