Assessments Metadata - Create In Subscription

Referência

Service:: Defender for Cloud

API Version:: 2020-01-01

Criar informações de metadados num tipo de avaliação numa subscrição específica

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

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
assessmentMetadataName	path	True	string	A Chave de Avaliação – Chave exclusiva para o tipo de avaliação
subscriptionId	path	True	string	ID da subscrição do Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versão da API para a operação

assessmentMetadataName

path

True

string

A Chave de Avaliação – Chave exclusiva para o tipo de avaliação

subscriptionId

path

True

string

ID da subscrição do Azure

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

api-version

query

True

string

Versão da API para a operação

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.assessmentType	True	assessmentType	BuiltIn se a avaliação baseada na definição de Azure Policy incorporada, Personalizar se a avaliação com base na definição de Azure Policy personalizada
properties.displayName	True	string	Nome a apresentar amigável do utilizador da avaliação
properties.severity	True	severity	O nível de gravidade da avaliação
properties.categories		categories[]	As categorias de recursos que estão em risco quando a avaliação está em mau estado de funcionamento
properties.description		string	Descrição legível por humanos da avaliação
properties.implementationEffort		implementationEffort	O esforço de implementação necessário para remediar esta avaliação
properties.partnerData		SecurityAssessmentMetadataPartnerData	Descreve o parceiro que criou a avaliação
properties.preview		boolean	Verdadeiro se esta avaliação estiver no estado de versão de pré-visualização
properties.remediationDescription		string	Descrição legível por humanos do que deve fazer para mitigar este problema de segurança
properties.threats		threats[]	Impacto de ameaças da avaliação
properties.userImpact		userImpact	O impacto do utilizador da avaliação

Respostas

Name	Tipo	Description
200 OK	SecurityAssessmentMetadata	OK
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
assessmentType	BuiltIn se a avaliação baseada na definição de Azure Policy incorporada, Personalizar se a avaliação com base na definição de Azure Policy personalizada
categories
CloudError	Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
implementationEffort	O esforço de implementação necessário para remediar esta avaliação
SecurityAssessmentMetadata	Metadados de avaliação de segurança
SecurityAssessmentMetadataPartnerData	Descreve o parceiro que criou a avaliação
severity	O nível de gravidade da avaliação
threats
userImpact	O impacto do utilizador da avaliação

assessmentType

BuiltIn se a avaliação baseada na definição de Azure Policy incorporada, Personalizar se a avaliação com base na definição de Azure Policy personalizada

Name	Tipo	Description
BuiltIn	string	Microsoft Defender para avaliações geridas pela Cloud
CustomPolicy	string	Políticas definidas pelo utilizador que são ingeridas automaticamente de Azure Policy para Microsoft Defender para a Cloud
CustomerManaged	string	Avaliações de utilizadores enviadas diretamente pelo utilizador ou por outros terceiros para Microsoft Defender para a Cloud
VerifiedPartner	string	Uma avaliação que foi criada por terceiros verificado se o utilizador a ligou ao ASC

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

CloudError

Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta de erro OData.).

Name	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

implementationEffort

O esforço de implementação necessário para remediar esta avaliação

Name	Tipo	Description
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

Metadados de avaliação de segurança

Name	Tipo	Description
id	string	ID do Recurso
name	string	Nome do recurso
properties.assessmentType	assessmentType	BuiltIn se a avaliação baseada na definição de Azure Policy incorporada, Personalizar se a avaliação com base na definição de Azure Policy personalizada
properties.categories	categories[]	As categorias de recursos que estão em risco quando a avaliação está em mau estado de funcionamento
properties.description	string	Descrição legível por humanos da avaliação
properties.displayName	string	Nome a apresentar amigável do utilizador da avaliação
properties.implementationEffort	implementationEffort	O esforço de implementação necessário para remediar esta avaliação
properties.partnerData	SecurityAssessmentMetadataPartnerData	Descreve o parceiro que criou a avaliação
properties.policyDefinitionId	string	ID de recurso do Azure da definição de política que ativa este cálculo de avaliação
properties.preview	boolean	Verdadeiro se esta avaliação estiver no estado de versão de pré-visualização
properties.remediationDescription	string	Descrição legível por humanos do que deve fazer para mitigar este problema de segurança
properties.severity	severity	O nível de gravidade da avaliação
properties.threats	threats[]	Impacto de ameaças da avaliação
properties.userImpact	userImpact	O impacto do utilizador da avaliação
type	string	Tipo de recurso

SecurityAssessmentMetadataPartnerData

Descreve o parceiro que criou a avaliação

Name	Tipo	Description
partnerName	string	Nome da empresa do parceiro
productName	string	Nome do produto do parceiro que criou a avaliação
secret	string	Segredo para autenticar o parceiro e verificar se criou a avaliação – escrever apenas

severity

O nível de gravidade da avaliação

Name	Tipo	Description
High	string
Low	string
Medium	string

threats

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

userImpact

O impacto do utilizador da avaliação

Name	Tipo	Description
High	string
Low	string
Moderate	string

Partilhar via

Assessments Metadata - Create In Subscription

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Scopes

Exemplos

Create security assessment metadata for subscription

Sample Request

Sample Response

Definições

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

Recursos adicionais