Assessments - Get

Referência

Service:: Defender for Cloud

API Version:: 2020-01-01

Obter uma avaliação de segurança em seu recurso verificado

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 de URI

Nome	Em	Obrigató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	Expanda OData. Opcional.

Respostas

Nome	Tipo	Description
200 OK	SecurityAssessment	OK
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

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

Nome	Description
AssessmentLinks	Links relevantes para a avaliação
AssessmentStatus	O resultado da avaliação
AssessmentStatusCode	Código programático para o status da avaliação
assessmentType	BuiltIn se a avaliação com base na definição de Azure Policy interna, Personalizar se a avaliação com base 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 retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	Os detalhes do erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ExpandEnum	Expanda OData. Opcional.
implementationEffort	O esforço de implementação necessário para corrigir essa avaliação
OnPremiseResourceDetails	Detalhes do recurso local que foi avaliado
OnPremiseSqlResourceDetails	Detalhes do recurso sql local que foi avaliado
SecurityAssessment	Avaliação de segurança em um recurso
SecurityAssessmentMetadataPartnerData	Descreve o parceiro que criou a avaliação
SecurityAssessmentMetadataProperties	Descreve as propriedades de metadados de avaliação.
SecurityAssessmentPartnerData	Dados referentes à integração de parceiros de terceiros
severity	O nível de gravidade da avaliação
threats
userImpact	O impacto do usuário na avaliação

AssessmentLinks

Links relevantes para a avaliação

Nome	Tipo	Description
azurePortalUri	string	Link para avaliação no Portal do Azure

AssessmentStatus

O resultado da avaliação

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

AssessmentStatusCode

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

Nome	Tipo	Description
Healthy	string	O recurso está íntegro
NotApplicable	string	A avaliação desse recurso não aconteceu
Unhealthy	string	O recurso tem um problema de segurança que precisa ser resolvido

assessmentType

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

Nome	Tipo	Description
BuiltIn	string	Microsoft Defender para avaliações gerenciadas na nuvem
CustomPolicy	string	Políticas definidas pelo usuário que são ingeridas automaticamente de Azure Policy para Microsoft Defender para Nuvem
CustomerManaged	string	Avaliações de usuário enviadas diretamente pelo usuário ou por terceiros para Microsoft Defender para Nuvem
VerifiedPartner	string	Uma avaliação que foi criada por terceiros verificado se o usuário a conectou ao ASC

AzureResourceDetails

Detalhes do recurso do Azure que foi avaliado

Nome	Tipo	Description
id	string	ID de recurso do Azure do recurso avaliado
source	string: Azure	A plataforma em que o recurso avaliado reside

Nome	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 retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	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

Os detalhes do erro.

Nome	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

As informações adicionais do erro de gerenciamento de recursos.

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

ExpandEnum

Expanda OData. Opcional.

Nome	Tipo	Description
links	string	Todos os links associados a uma avaliação
metadata	string	Metadados de avaliação

implementationEffort

O esforço de implementação necessário para corrigir essa avaliação

Nome	Tipo	Description
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

Detalhes do recurso local que foi avaliado

Nome	Tipo	Description
machineName	string	O nome do computador
source	string: OnPremise	A plataforma em que o recurso avaliado reside
sourceComputerId	string	A ID do agente do oms instalada no computador
vmuuid	string	A ID exclusiva do computador
workspaceId	string	ID de recurso do Azure do workspace ao qual o computador está anexado

OnPremiseSqlResourceDetails

Detalhes do recurso sql local que foi avaliado

Nome	Tipo	Description
databaseName	string	O nome do banco 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 em que o recurso avaliado reside
sourceComputerId	string	A ID do agente do oms instalada no computador
vmuuid	string	A ID exclusiva do computador
workspaceId	string	ID de recurso do Azure do workspace ao qual o computador está anexado

SecurityAssessment

Avaliação de segurança em um recurso

Nome	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 de exibição amigável da avaliação
properties.links	AssessmentLinks	Links relevantes para a avaliação
properties.metadata	SecurityAssessmentMetadataProperties	Descreve as propriedades de metadados de avaliação.
properties.partnersData	SecurityAssessmentPartnerData	Dados referentes à 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

Nome	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 ele criou a avaliação – somente gravação

SecurityAssessmentMetadataProperties

Descreve as propriedades de metadados de avaliação.

Nome	Tipo	Description
assessmentType	assessmentType	BuiltIn se a avaliação com base na definição de Azure Policy interna, Personalizar se a avaliação com base na definição de Azure Policy personalizada
categories	categories[]	As categorias de recurso que estão em risco quando a avaliação não está íntegra
description	string	Descrição legível da avaliação
displayName	string	Nome de exibição amigável da avaliação
implementationEffort	implementationEffort	O esforço de implementação necessário para corrigir essa 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 esse cálculo de avaliação
preview	boolean	True se essa avaliação estiver em versão prévia status
remediationDescription	string	Descrição legível do que você deve fazer para atenuar esse problema de segurança
severity	severity	O nível de gravidade da avaliação
threats	threats[]	Impacto das ameaças da avaliação
userImpact	userImpact	O impacto do usuário na avaliação

SecurityAssessmentPartnerData

Dados referentes à integração de parceiros de terceiros

Nome	Tipo	Description
partnerName	string	Nome da empresa do parceiro
secret	string	segredo para autenticar o parceiro – somente gravação

severity

O nível de gravidade da avaliação

Nome	Tipo	Description
High	string
Low	string
Medium	string

threats

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

userImpact

O impacto do usuário na avaliação

Nome	Tipo	Description
High	string
Low	string
Moderate	string

Compartilhar via

Assessments - Get

Parâmetros de 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