Assessments Metadata - Get In Subscription

Référence

Service:: Defender for Cloud

Version d'API:: 2020-01-01

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

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

Paramètres URI

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

Réponses

Nom	Type	Description
200 OK	SecurityAssessmentMetadata	D’ACCORD
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Get security assessment metadata for subscription

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/0980887d-03d6-408c-9566-532f3456804e/providers/Microsoft.Security/assessmentMetadata/21300918-b2e3-0346-785f-c77ff57d243b?api-version=2020-01-01

Exemple de réponse

Code d’état:: 200

{
  "id": "/providers/Microsoft.Security/assessmentMetadata/21300918-b2e3-0346-785f-c77ff57d243b",
  "name": "21300918-b2e3-0346-785f-c77ff57d243b",
  "type": "Microsoft.Security/assessmentMetadata",
  "properties": {
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/26a828e1-e88f-464e-bbb3-c134a282b9de",
    "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": "BuiltIn"
  }
}

Définitions

Nom	Description
assessmentType	BuiltIn si l’évaluation basée sur la définition Azure Policy intégrée, personnalisée si l’évaluation basée sur une définition Azure Policy personnalisée
categories
CloudError	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour 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	L’effort d’implémentation requis 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 par l’utilisateur

assessmentType

Énumération

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

Valeur	Description
BuiltIn	Évaluations gérées par Microsoft Defender pour cloud
CustomPolicy	Stratégies définies par l’utilisateur qui sont ingérées automatiquement à partir d’Azure Policy vers Microsoft Defender pour cloud
CustomerManaged	Évaluations des utilisateurs envoyées directement par l’utilisateur ou d’autres tiers à Microsoft Defender pour cloud
VerifiedPartner	Évaluation créée par un tiers vérifié si l’utilisateur l’a connecté à ASC

Valeur	Description
Compute
Data
IdentityAndAccess
IoT
Networking

CloudError

Object

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour 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

Object

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

Object

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

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

implementationEffort

Énumération

L’effort d’implémentation requis pour corriger cette évaluation

Valeur	Description
High
Low
Moderate

SecurityAssessmentMetadata

Object

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 la définition Azure Policy intégrée, personnalisée si l’évaluation basée sur une définition Azure Policy personnalisée
properties.categories	categories[]	Catégories de ressources à risque lorsque l’évaluation n’est pas saine
properties.description	string	Description lisible humaine de l’évaluation
properties.displayName	string	Nom complet convivial de l’évaluation
properties.implementationEffort	implementationEffort	L’effort d’implémentation requis 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 dans l’état de la préversion
properties.remediationDescription	string	Description lisible humaine 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 sur les menaces de l’évaluation
properties.userImpact	userImpact	Impact de l’évaluation par l’utilisateur
type	string	Type de ressource

SecurityAssessmentMetadataPartnerData

Object

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 - écrire uniquement

severity

Énumération

Niveau de gravité de l’évaluation

Valeur	Description
High
Low
Medium

threats

Énumération

Valeur	Description
accountBreach
dataExfiltration
dataSpillage
denialOfService
elevationOfPrivilege
maliciousInsider
missingCoverage
threatResistance

userImpact

Énumération

Impact de l’évaluation par l’utilisateur

Valeur	Description
High
Low
Moderate

Partager via

Assessments Metadata - Get In Subscription

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get security assessment metadata for subscription

Exemple de requête

Exemple de réponse

Définitions

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

Ressources supplémentaires