Assessments - Get

Referência

Service:: Defender for Cloud

API Version:: 2020-01-01

Obter uma avaliação de segurança no recurso analisado

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
assessmentName	path	True	string	A Chave de Avaliação – Chave exclusiva para o tipo de avaliação
resourceId	path	True	string	O identificador do recurso.
api-version	query	True	string	Versão da API para a operação
$expand	query		ExpandEnum	Expandir OData. Opcional.

Respostas

Name	Tipo	Description
200 OK	SecurityAssessment	OK
Other Status Codes	CloudError	Resposta de erro que descreve o motivo 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

Get security recommendation task from security data location

Get security recommendation task from security data location with expand parameter

Get security recommendation task from security data location

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b?api-version=2020-01-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b",
  "name": "21300918-b2e3-0346-785f-c77ff57d243b",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2"
    },
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "status": {
      "code": "NotApplicable",
      "cause": "OffByPolicy",
      "description": "The effective policy for the assessment was evaluated to off - use Microsoft.Authorization/policyAssignments to turn this assessment on"
    },
    "additionalData": {
      "linkedWorkspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"
    }
  }
}

Get security recommendation task from security data location with expand parameter

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b?api-version=2020-01-01&$expand=links

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b",
  "name": "21300918-b2e3-0346-785f-c77ff57d243b",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2"
    },
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "status": {
      "code": "NotApplicable",
      "cause": "OffByPolicy",
      "description": "The effective policy for the assessment was evaluated to off - use Microsoft.Authorization/policyAssignments to turn this assessment on"
    },
    "additionalData": {
      "linkedWorkspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"
    },
    "links": {
      "azurePortalUri": "https://www.portal.azure.com/?fea#blade/Microsoft_Azure_Security/RecommendationsBlade/assessmentKey/21300918-b2e3-0346-785f-c77ff57d243b"
    }
  }
}

Definições

Name	Description
AssessmentLinks	Ligações relevantes para a avaliação
AssessmentStatus	O resultado da avaliação
AssessmentStatusCode	Código programático para o estado da avaliação
assessmentType	BuiltIn se a avaliação baseada na definição de Azure Policy incorporada, Personalizar se a avaliação for baseada na definição de Azure Policy personalizada
AzureResourceDetails	Detalhes do recurso do Azure que foi avaliado
categories
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (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.
ExpandEnum	Expandir OData. Opcional.
implementationEffort	O esforço de implementação necessário para remediar esta avaliação
OnPremiseResourceDetails	Detalhes do recurso No Local que foi avaliado
OnPremiseSqlResourceDetails	Detalhes do recurso Sql no Local que foi avaliado
SecurityAssessment	Avaliação de segurança num recurso
SecurityAssessmentMetadataPartnerData	Descreve o parceiro que criou a avaliação
SecurityAssessmentMetadataProperties	Descreve as propriedades de um metadados de avaliação.
SecurityAssessmentPartnerData	Dados relativos à integração de parceiros de terceiros
severity	O nível de gravidade da avaliação
threats
userImpact	O impacto do utilizador da avaliação

AssessmentLinks

Ligações relevantes para a avaliação

Name	Tipo	Description
azurePortalUri	string	Ligação para avaliação no portal do Azure

AssessmentStatus

O resultado da avaliação

Name	Tipo	Description
cause	string	Código programático para a causa do estado da avaliação
code	AssessmentStatusCode	Código programático para o estado da avaliação
description	string	Descrição legível por humanos do estado da avaliação

AssessmentStatusCode

Código programático para o estado da avaliação

Name	Tipo	Description
Healthy	string	O recurso está em bom estado de funcionamento
NotApplicable	string	A avaliação para este recurso não aconteceu
Unhealthy	string	O recurso tem um problema de segurança que tem de ser resolvido

assessmentType

BuiltIn se a avaliação baseada na definição de Azure Policy incorporada, Personalizar se a avaliação for baseada 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 outros terceiros para Microsoft Defender para a Cloud
VerifiedPartner	string	Uma avaliação criada por terceiros verificado se o utilizador a tiver ligado ao ASC

AzureResourceDetails

Detalhes do recurso do Azure que foi avaliado

Name	Tipo	Description
id	string	ID do recurso avaliado do Azure
source	string: Azure	A plataforma onde reside o recurso avaliado

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

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (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ções adicionais.

ExpandEnum

Expandir OData. Opcional.

Name	Tipo	Description
links	string	Todas as ligações associadas a uma avaliação
metadata	string	Metadados de avaliação

implementationEffort

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

Name	Tipo	Description
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

Detalhes do recurso No Local que foi avaliado

Name	Tipo	Description
machineName	string	O nome do computador
source	string: OnPremise	A plataforma onde reside o recurso avaliado
sourceComputerId	string	O ID do agente oms instalado no computador
vmuuid	string	O ID exclusivo da máquina
workspaceId	string	ID do recurso do Azure da área de trabalho à que o computador está anexado

OnPremiseSqlResourceDetails

Detalhes do recurso Sql no Local que foi avaliado

Name	Tipo	Description
databaseName	string	O nome da base de dados Sql instalado no computador
machineName	string	O nome do computador
serverName	string	O nome do sql server instalado no computador
source	string: OnPremiseSql	A plataforma onde reside o recurso avaliado
sourceComputerId	string	O ID do agente oms instalado no computador
vmuuid	string	O ID exclusivo da máquina
workspaceId	string	ID do recurso do Azure da área de trabalho à que o computador está anexado

SecurityAssessment

Avaliação de segurança num recurso

Name	Tipo	Description
id	string	ID do Recurso
name	string	Nome do recurso
properties.additionalData	object	Dados adicionais sobre a avaliação
properties.displayName	string	Nome a apresentar amigável do utilizador da avaliação
properties.links	AssessmentLinks	Ligações relevantes para a avaliação
properties.metadata	SecurityAssessmentMetadataProperties	Descreve as propriedades de um metadados de avaliação.
properties.partnersData	SecurityAssessmentPartnerData	Dados relativos à integração de parceiros de terceiros
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Detalhes do recurso que foi avaliado
properties.status	AssessmentStatus	O resultado 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

SecurityAssessmentMetadataProperties

Descreve as propriedades de um metadados de avaliação.

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

SecurityAssessmentPartnerData

Dados relativos à integração de parceiros de terceiros

Name	Tipo	Description
partnerName	string	Nome da empresa do parceiro
secret	string	secret to authenticate the partner - write only

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

Share via

Assessments - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

Get security recommendation task from security data location

Sample Request

Sample Response

Get security recommendation task from security data location with expand parameter

Sample Request

Sample Response

Definições

AssessmentLinks

AssessmentStatus

AssessmentStatusCode

assessmentType

AzureResourceDetails

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

ExpandEnum

implementationEffort

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecurityAssessment

SecurityAssessmentMetadataPartnerData

SecurityAssessmentMetadataProperties

SecurityAssessmentPartnerData

severity

threats

userImpact

Recursos adicionais