Assessments - List

Serviço:

Defender for Cloud

Versão da API:

2021-06-01

Obter avaliações de segurança em todos os recursos verificados dentro de um escopo

GET https://management.azure.com/{scope}/providers/Microsoft.Security/assessments?api-version=2021-06-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
scope	path	True	string	O escopo da consulta pode ser assinatura (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) ou grupo de gerenciamento (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Versão da API para a operação

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List security assessments

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/assessments?api-version=2021-06-01

Java

/**
 * Samples for Assessments List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Assessments/
     * ListAssessments_example.json
     */
    /**
     * Sample code: List security assessments.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecurityAssessments(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.assessments().list("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Assessments/ListAssessments_example.json
func ExampleAssessmentsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAssessmentsClient().NewListPager("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AssessmentList = armsecurity.AssessmentList{
		// 	Value: []*armsecurity.AssessmentResponse{
		// 		{
		// 			Name: to.Ptr("21300918-b2e3-0346-785f-c77ff57d243b"),
		// 			Type: to.Ptr("Microsoft.Security/assessments"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b"),
		// 			Properties: &armsecurity.AssessmentPropertiesResponse{
		// 				DisplayName: to.Ptr("Install endpoint protection solution on virtual machine scale sets"),
		// 				ResourceDetails: &armsecurity.AzureResourceDetails{
		// 					Source: to.Ptr(armsecurity.SourceAzure),
		// 					ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1"),
		// 				},
		// 				Status: &armsecurity.AssessmentStatusResponse{
		// 					Code: to.Ptr(armsecurity.AssessmentStatusCodeHealthy),
		// 					FirstEvaluationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-12T09:07:18.675Z"); return t}()),
		// 					StatusChangeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-12T09:07:18.675Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("21300918-b2e3-0346-785f-c77ff57d243b"),
		// 			Type: to.Ptr("Microsoft.Security/assessments"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b"),
		// 			Properties: &armsecurity.AssessmentPropertiesResponse{
		// 				AdditionalData: map[string]*string{
		// 					"linkedWorkspaceId": to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"),
		// 				},
		// 				DisplayName: to.Ptr("Install endpoint protection solution on virtual machine scale sets"),
		// 				ResourceDetails: &armsecurity.AzureResourceDetails{
		// 					Source: to.Ptr(armsecurity.SourceAzure),
		// 					ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2"),
		// 				},
		// 				Status: &armsecurity.AssessmentStatusResponse{
		// 					Description: to.Ptr("The effective policy for the assessment was evaluated to off - use Microsoft.Authorization/policyAssignments to turn this assessment on"),
		// 					Cause: to.Ptr("OffByPolicy"),
		// 					Code: to.Ptr(armsecurity.AssessmentStatusCodeNotApplicable),
		// 					FirstEvaluationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-12T09:07:18.675Z"); return t}()),
		// 					StatusChangeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-12T09:07:18.675Z"); return t}()),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get security assessments on all your scanned resources inside a scope
 *
 * @summary Get security assessments on all your scanned resources inside a scope
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Assessments/ListAssessments_example.json
 */
async function listSecurityAssessments() {
  const scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const resArray = new Array();
  for await (let item of client.assessments.list(scope)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/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/vmss1"
        },
        "displayName": "Install endpoint protection solution on virtual machine scale sets",
        "status": {
          "code": "Healthy",
          "statusChangeDate": "2021-04-12T09:07:18.6759138Z",
          "firstEvaluationDate": "2021-04-12T09:07:18.6759138Z"
        }
      }
    },
    {
      "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",
          "statusChangeDate": "2021-04-12T09:07:18.6759138Z",
          "firstEvaluationDate": "2021-04-12T09:07:18.6759138Z"
        },
        "additionalData": {
          "linkedWorkspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"
        }
      }
    }
  ]
}

Definições

Nome	Description
AssessmentLinks	Links relevantes para a avaliação
AssessmentStatusCode	Código programático para o status da avaliação
AssessmentStatusResponse	O resultado da avaliação
assessmentType	BuiltIn se a avaliação baseada na definição interna do Azure Policy, Personalizar se a avaliação com base na definição personalizada do Azure Policy
AzureResourceDetails	Detalhes do recurso do Azure que foi avaliado
categories
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
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
SecurityAssessmentList	Página de uma lista de avaliações de segurança
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
SecurityAssessmentResponse	Avaliação de segurança em um recurso – formato de resposta
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

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

AssessmentStatusResponse

O resultado da avaliação

Nome	Tipo	Description
cause	string	Código programático para a causa do status da avaliação
code	AssessmentStatusCode	Código programático para o status da avaliação
description	string	Descrição legível humana do status da avaliação
firstEvaluationDate	string	A hora em que a avaliação foi criada e avaliada pela primeira vez. Retornado como hora UTC no formato ISO 8601
statusChangeDate	string	A hora em que o status da avaliação foi alterado pela última vez. Retornado como hora UTC no formato ISO 8601

assessmentType

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

Nome	Tipo	Description
BuiltIn	string	Avaliações gerenciadas do Microsoft Defender para Nuvem
CustomPolicy	string	Políticas definidas pelo usuário que são ingeridas automaticamente do Azure Policy para o Microsoft Defender para Nuvem
CustomerManaged	string	Avaliações de usuário enviadas diretamente pelo usuário ou outros terceiros para o Microsoft Defender para Nuvem
VerifiedPartner	string	Uma avaliação que foi criada por um terceiro 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

categories

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 retornarem detalhes de erro para 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

O detalhe 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.

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

SecurityAssessmentList

Página de uma lista de avaliações de segurança

Nome	Tipo	Description
nextLink	string	O URI a ser buscado na próxima página.
value	SecurityAssessmentResponse[]	Coleção de avaliações de segurança nesta página

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 baseada na definição interna do Azure Policy, Personalizar se a avaliação com base na definição personalizada do Azure Policy
categories	categories[]	As categorias de recurso que está em risco quando a avaliação não está íntegra
description	string	Descrição legível humana 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 no status de versão prévia
remediationDescription	string	Descrição legível humana 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

SecurityAssessmentResponse

Avaliação de segurança em um recurso – formato de resposta

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	AssessmentStatusResponse	O resultado da avaliação
type	string	Tipo de recurso

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