Assessments - List

Odwołanie

Usługa:: Defender for Cloud

Wersja interfejsu API:: 2021-06-01

Pobieranie ocen zabezpieczeń dla wszystkich zeskanowanych zasobów w zakresie

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
scope	path	True	string	Zakres zapytania może być subskrypcją (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) lub grupą zarządzania (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Wersja interfejsu API dla operacji

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SecurityAssessmentList	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List security assessments

Przykładowe żądanie

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


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

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
AssessmentLinks	Linki istotne dla oceny
AssessmentStatusCode	Kod programowy stanu oceny
AssessmentStatusResponse	Wynik oceny
assessmentType	BuiltIn, jeśli ocena oparta na wbudowanej definicji usługi Azure Policy, niestandardowy, jeśli ocena jest oparta na niestandardowej definicji usługi Azure Policy
AzureResourceDetails	Szczegóły zasobu platformy Azure, który został oceniony
categories
CloudError	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
CloudErrorBody	Szczegóły błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
implementationEffort	Wysiłek wdrożeniowy wymagany do skorygowania tej oceny
OnPremiseResourceDetails	Szczegóły zasobu lokalnego, który został oceniony
OnPremiseSqlResourceDetails	Szczegóły zasobu Sql lokalnego, który został oceniony
SecurityAssessmentList	Strona listy ocen zabezpieczeń
SecurityAssessmentMetadataPartnerData	Opisuje partnera, który utworzył ocenę
SecurityAssessmentMetadataProperties	Opisuje właściwości metadanych oceny.
SecurityAssessmentPartnerData	Dane dotyczące integracji partnera innej firmy
SecurityAssessmentResponse	Ocena zabezpieczeń zasobu — format odpowiedzi
severity	Poziom ważności oceny
threats
userImpact	Wpływ oceny na użytkownika

AssessmentLinks

Linki istotne dla oceny

Nazwa	Typ	Opis
azurePortalUri	string	Link do oceny w witrynie Azure Portal

AssessmentStatusCode

Kod programowy stanu oceny

Nazwa	Typ	Opis
Healthy	string	Zasób jest w dobrej kondycji
NotApplicable	string	Ocena tego zasobu nie została wykonana
Unhealthy	string	Zasób ma problem z zabezpieczeniami, który należy rozwiązać

AssessmentStatusResponse

Wynik oceny

Nazwa	Typ	Opis
cause	string	Kod programowy przyczyny stanu oceny
code	AssessmentStatusCode	Kod programowy stanu oceny
description	string	Czytelny opis stanu oceny przez człowieka
firstEvaluationDate	string	Czas utworzenia i oceny. Zwracany jako czas UTC w formacie ISO 8601
statusChangeDate	string	Czas ostatniego zmiany stanu oceny. Zwracany jako czas UTC w formacie ISO 8601

assessmentType

BuiltIn, jeśli ocena oparta na wbudowanej definicji usługi Azure Policy, niestandardowy, jeśli ocena jest oparta na niestandardowej definicji usługi Azure Policy

Nazwa	Typ	Opis
BuiltIn	string	Oceny zarządzane przez usługę Microsoft Defender for Cloud
CustomPolicy	string	Zasady zdefiniowane przez użytkownika, które są automatycznie pozyskiwane z usługi Azure Policy do usługi Microsoft Defender for Cloud
CustomerManaged	string	Oceny użytkowników wypychane bezpośrednio przez użytkownika lub inną firmę do usługi Microsoft Defender for Cloud
VerifiedPartner	string	Ocena utworzona przez zweryfikowaną inną firmę, jeśli użytkownik połączył ją z usługą ASC

AzureResourceDetails

Szczegóły zasobu platformy Azure, który został oceniony

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure dla ocenianego zasobu
source	string: Azure	Platforma, na której znajduje się oceniony zasób

Nazwa	Typ	Opis
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error.additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Szczegóły błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	CloudErrorBody[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

implementationEffort

Wysiłek wdrożeniowy wymagany do skorygowania tej oceny

Nazwa	Typ	Opis
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

Szczegóły zasobu lokalnego, który został oceniony

Nazwa	Typ	Opis
machineName	string	Nazwa maszyny
source	string: OnPremise	Platforma, na której znajduje się oceniony zasób
sourceComputerId	string	Identyfikator agenta pakietu oms zainstalowany na maszynie
vmuuid	string	Unikatowy identyfikator maszyny
workspaceId	string	Identyfikator zasobu platformy Azure obszaru roboczego, do którego jest dołączony komputer

OnPremiseSqlResourceDetails

Szczegóły zasobu Sql lokalnego, który został oceniony

Nazwa	Typ	Opis
databaseName	string	Nazwa bazy danych Sql zainstalowana na maszynie
machineName	string	Nazwa maszyny
serverName	string	Nazwa serwera SQL zainstalowana na maszynie
source	string: OnPremiseSql	Platforma, na której znajduje się oceniony zasób
sourceComputerId	string	Identyfikator agenta pakietu oms zainstalowany na maszynie
vmuuid	string	Unikatowy identyfikator maszyny
workspaceId	string	Identyfikator zasobu platformy Azure obszaru roboczego, do którego jest dołączony komputer

SecurityAssessmentList

Strona listy ocen zabezpieczeń

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI do pobrania następnej strony.
value	SecurityAssessmentResponse[]	Kolekcja ocen zabezpieczeń na tej stronie

SecurityAssessmentMetadataPartnerData

Opisuje partnera, który utworzył ocenę

Nazwa	Typ	Opis
partnerName	string	Nazwa firmy partnera
productName	string	Nazwa produktu partnera, który utworzył ocenę
secret	string	Wpis tajny umożliwiający uwierzytelnienie partnera i zweryfikowanie utworzenia oceny — tylko zapis

SecurityAssessmentMetadataProperties

Opisuje właściwości metadanych oceny.

Nazwa	Typ	Opis
assessmentType	assessmentType	BuiltIn, jeśli ocena oparta na wbudowanej definicji usługi Azure Policy, niestandardowy, jeśli ocena jest oparta na niestandardowej definicji usługi Azure Policy
categories	categories[]	Kategorie zasobów, które są zagrożone, gdy ocena jest w złej kondycji
description	string	Czytelny opis oceny przez człowieka
displayName	string	Przyjazna dla użytkownika nazwa wyświetlana oceny
implementationEffort	implementationEffort	Wysiłek wdrożeniowy wymagany do skorygowania tej oceny
partnerData	SecurityAssessmentMetadataPartnerData	Opisuje partnera, który utworzył ocenę
policyDefinitionId	string	Identyfikator zasobu platformy Azure definicji zasad, która włącza to obliczenie oceny
preview	boolean	Prawda, jeśli ta ocena ma stan wersji zapoznawczej
remediationDescription	string	Czytelny opis tego, co należy zrobić, aby rozwiązać ten problem z zabezpieczeniami
severity	severity	Poziom ważności oceny
threats	threats[]	Wpływ oceny na zagrożenia
userImpact	userImpact	Wpływ oceny na użytkownika

SecurityAssessmentPartnerData

Dane dotyczące integracji partnera innej firmy

Nazwa	Typ	Opis
partnerName	string	Nazwa firmy partnera
secret	string	wpis tajny do uwierzytelniania partnera — tylko zapis

SecurityAssessmentResponse

Ocena zabezpieczeń zasobu — format odpowiedzi

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
name	string	Nazwa zasobu
properties.additionalData	object	Dodatkowe dane dotyczące oceny
properties.displayName	string	Przyjazna dla użytkownika nazwa wyświetlana oceny
properties.links	AssessmentLinks	Linki istotne dla oceny
properties.metadata	SecurityAssessmentMetadataProperties	Opisuje właściwości metadanych oceny.
properties.partnersData	SecurityAssessmentPartnerData	Dane dotyczące integracji partnera innej firmy
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Szczegóły zasobu, który został oceniony
properties.status	AssessmentStatusResponse	Wynik oceny
type	string	Typ zasobu

severity

Poziom ważności oceny

Nazwa	Typ	Opis
High	string
Low	string
Medium	string

threats

Nazwa	Typ	Opis
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Wpływ oceny na użytkownika

Nazwa	Typ	Opis
High	string
Low	string
Moderate	string

Udostępnij za pośrednictwem

Assessments - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

List security assessments

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AssessmentLinks

AssessmentStatusCode

AssessmentStatusResponse

assessmentType

AzureResourceDetails

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecurityAssessmentList

SecurityAssessmentMetadataPartnerData

SecurityAssessmentMetadataProperties

SecurityAssessmentPartnerData

SecurityAssessmentResponse

severity

threats

userImpact

Dodatkowe zasoby