Assessments Metadata - Create In Subscription

Référence

Service:: Defender for Cloud

API Version:: 2020-01-01

Créer des informations de métadonnées sur un type d’évaluation dans un abonnement spécifique

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}?api-version=2020-01-01

Paramètres URI

Nom Dans Obligatoire Type Description

Nom	Dans	Obligatoire	Type	Description
assessmentMetadataName	path	True	string	La clé d’évaluation : clé unique pour le type d’évaluation
subscriptionId	path	True	string	ID d’abonnement Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Version de l’API pour l’opération

assessmentMetadataName

path

True

string

La clé d’évaluation : clé unique pour le type d’évaluation

subscriptionId

path

True

string

ID d’abonnement Azure

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

Version de l’API pour l’opération

Corps de la demande

Nom	Obligatoire	Type	Description
properties.assessmentType	True	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
properties.displayName	True	string	Nom d’affichage convivial de l’évaluation
properties.severity	True	severity	Niveau de gravité de l’évaluation
properties.categories		categories[]	Catégories de ressources à risque lorsque l’évaluation n’est pas saine
properties.description		string	Description lisible par l’homme de l’évaluation
properties.implementationEffort		implementationEffort	Effort de mise en œuvre nécessaire pour corriger cette évaluation
properties.partnerData		SecurityAssessmentMetadataPartnerData	Décrit le partenaire qui a créé l’évaluation
properties.preview		boolean	True si cette évaluation est en préversion status
properties.remediationDescription		string	Description lisible par l’utilisateur de ce que vous devez faire pour atténuer ce problème de sécurité
properties.threats		threats[]	Impact des menaces de l’évaluation
properties.userImpact		userImpact	Impact de l’évaluation sur l’utilisateur

Réponses

Nom	Type	Description
200 OK	SecurityAssessmentMetadata	Ok
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 assessment metadata for subscription

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/0980887d-03d6-408c-9566-532f3456804e/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7?api-version=2020-01-01

{
  "properties": {
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "description": "Install an endpoint protection solution on your virtual machines scale sets, to protect them from threats and vulnerabilities.",
    "remediationDescription": "To install an endpoint protection solution: 1.  <a href=\"https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-faq#how-do-i-turn-on-antimalware-in-my-virtual-machine-scale-set\">Follow the instructions in How do I turn on antimalware in my virtual machine scale set</a>",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Sample Response

Status code:: 200

{
  "id": "/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "name": "ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "type": "Microsoft.Security/assessmentMetadata",
  "properties": {
    "displayName": "My organization security assessment",
    "description": "Assessment that my organization created to view our security assessment in Azure Security Center",
    "remediationDescription": "Fix it with these remediation instructions",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Définitions

Nom	Description
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
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
SecurityAssessmentMetadata	Métadonnées d’évaluation de la sécurité
SecurityAssessmentMetadataPartnerData	Décrit le partenaire qui a créé l’évaluation
severity	Niveau de gravité de l’évaluation
threats
userImpact	Impact de l’évaluation sur l’utilisateur

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

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

SecurityAssessmentMetadata

Métadonnées d’évaluation de la sécurité

Nom	Type	Description
id	string	ID de ressource
name	string	Nom de la ressource
properties.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
properties.categories	categories[]	Catégories de ressources à risque lorsque l’évaluation n’est pas saine
properties.description	string	Description lisible par l’homme de l’évaluation
properties.displayName	string	Nom d’affichage convivial de l’évaluation
properties.implementationEffort	implementationEffort	Effort de mise en œuvre nécessaire pour corriger cette évaluation
properties.partnerData	SecurityAssessmentMetadataPartnerData	Décrit le partenaire qui a créé l’évaluation
properties.policyDefinitionId	string	ID de ressource Azure de la définition de stratégie qui active ce calcul d’évaluation
properties.preview	boolean	True si cette évaluation est en préversion status
properties.remediationDescription	string	Description lisible par l’utilisateur de ce que vous devez faire pour atténuer ce problème de sécurité
properties.severity	severity	Niveau de gravité de l’évaluation
properties.threats	threats[]	Impact des menaces de l’évaluation
properties.userImpact	userImpact	Impact de l’évaluation sur l’utilisateur
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

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

Assessments Metadata - Create In Subscription

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Scopes

Exemples

Create security assessment metadata for subscription

Sample Request

Sample Response

Définitions

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

Ressources supplémentaires