Assessments Metadata - Create In Subscription

Referencia

Service:: Defender for Cloud

API Version:: 2020-01-01

Creación de información de metadatos sobre un tipo de evaluación en una suscripción específica

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
assessmentMetadataName	path	True	string	Clave de evaluación: clave única para el tipo de evaluación
subscriptionId	path	True	string	Identificador de suscripción de Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versión de API para la operación

assessmentMetadataName

path

True

string

Clave de evaluación: clave única para el tipo de evaluación

subscriptionId

path

True

string

Identificador de suscripción de Azure

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

api-version

query

True

string

Versión de API para la operación

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.assessmentType	True	assessmentType	BuiltIn si la evaluación se basa en la definición de Azure Policy integrada, Personalizada si la evaluación se basa en la definición de Azure Policy personalizada
properties.displayName	True	string	Nombre para mostrar descriptivo de la evaluación
properties.severity	True	severity	El nivel de gravedad de la evaluación
properties.categories		categories[]	Categorías de recursos que están en riesgo cuando la evaluación es incorrecta
properties.description		string	Descripción legible de la evaluación
properties.implementationEffort		implementationEffort	El esfuerzo de implementación necesario para corregir esta evaluación
properties.partnerData		SecurityAssessmentMetadataPartnerData	Describe el asociado que creó la evaluación.
properties.preview		boolean	True si esta evaluación está en estado de versión preliminar
properties.remediationDescription		string	Descripción legible de lo que debe hacer para mitigar este problema de seguridad
properties.threats		threats[]	Impacto en las amenazas de la evaluación
properties.userImpact		userImpact	Impacto del usuario de la evaluación

Respuestas

Nombre	Tipo	Description
200 OK	SecurityAssessmentMetadata	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
assessmentType	BuiltIn si la evaluación se basa en la definición de Azure Policy integrada, Personalizada si la evaluación se basa en la definición de Azure Policy personalizada
categories
CloudError	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
CloudErrorBody	Detalle del error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
implementationEffort	El esfuerzo de implementación necesario para corregir esta evaluación
SecurityAssessmentMetadata	Metadatos de evaluación de seguridad
SecurityAssessmentMetadataPartnerData	Describe el asociado que creó la evaluación.
severity	El nivel de gravedad de la evaluación
threats
userImpact	Impacto del usuario de la evaluación

assessmentType

BuiltIn si la evaluación se basa en la definición de Azure Policy integrada, Personalizada si la evaluación se basa en la definición de Azure Policy personalizada

Nombre	Tipo	Description
BuiltIn	string	Microsoft Defender para evaluaciones administradas en la nube
CustomPolicy	string	Directivas definidas por el usuario que se ingieren automáticamente de Azure Policy a Microsoft Defender for Cloud
CustomerManaged	string	Evaluaciones de usuarios insertadas directamente por el usuario u otro tercero para Microsoft Defender for Cloud
VerifiedPartner	string	Una evaluación creada por un tercero comprobado si el usuario lo conectó a ASC.

Nombre	Tipo	Description
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
error.code	string	Código de error.
error.details	CloudErrorBody[]	Los detalles del error.
error.message	string	El mensaje de error.
error.target	string	Destino del error.

CloudErrorBody

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	CloudErrorBody[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

implementationEffort

El esfuerzo de implementación necesario para corregir esta evaluación

Nombre	Tipo	Description
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

Metadatos de evaluación de seguridad

Nombre	Tipo	Description
id	string	Id. de recurso
name	string	Nombre del recurso
properties.assessmentType	assessmentType	BuiltIn si la evaluación se basa en la definición de Azure Policy integrada, Personalizada si la evaluación se basa en la definición de Azure Policy personalizada
properties.categories	categories[]	Categorías de recursos que están en riesgo cuando la evaluación es incorrecta
properties.description	string	Descripción legible de la evaluación
properties.displayName	string	Nombre para mostrar descriptivo de la evaluación
properties.implementationEffort	implementationEffort	El esfuerzo de implementación necesario para corregir esta evaluación
properties.partnerData	SecurityAssessmentMetadataPartnerData	Describe el asociado que creó la evaluación.
properties.policyDefinitionId	string	Identificador de recurso de Azure de la definición de directiva que activa este cálculo de evaluación
properties.preview	boolean	True si esta evaluación está en estado de versión preliminar
properties.remediationDescription	string	Descripción legible de lo que debe hacer para mitigar este problema de seguridad
properties.severity	severity	El nivel de gravedad de la evaluación
properties.threats	threats[]	Impacto en las amenazas de la evaluación
properties.userImpact	userImpact	Impacto del usuario de la evaluación
type	string	Tipo de recurso

SecurityAssessmentMetadataPartnerData

Describe el asociado que creó la evaluación.

Nombre	Tipo	Description
partnerName	string	Nombre de la empresa del asociado
productName	string	Nombre del producto del asociado que creó la evaluación
secret	string	Secreto para autenticar al asociado y comprobar que creó la evaluación: solo escritura

severity

El nivel de gravedad de la evaluación

Nombre	Tipo	Description
High	string
Low	string
Medium	string

threats

Nombre	Tipo	Description
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Impacto del usuario de la evaluación

Nombre	Tipo	Description
High	string
Low	string
Moderate	string

Compartir a través de

Assessments Metadata - Create In Subscription

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Create security assessment metadata for subscription

Sample Request

Sample Response

Definiciones

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

Recursos adicionales