Assessments - Get

Service:

Defender for Cloud

API Version:

2020-01-01

Pobieranie oceny zabezpieczeń w zeskanowanym zasobie

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
assessmentName	path	True	string	Klucz oceny — unikatowy klucz dla typu oceny
resourceId	path	True	string	Identyfikator zasobu.
api-version	query	True	string	Wersja interfejsu API dla operacji
$expand	query		ExpandEnum	Rozwiń węzeł OData. Opcjonalny.

Odpowiedzi

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

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
AssessmentLinks	Linki dotyczące oceny
AssessmentStatus	Wynik oceny
AssessmentStatusCode	Kod programowy stanu oceny
assessmentType	BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition (Niestandardowe, jeśli ocena jest oparta na niestandardowej definicji Azure Policy)
AzureResourceDetails	Szczegóły zasobu platformy Azure, który został oceniony
categories
CloudError	Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).
CloudErrorBody	Szczegóły błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ExpandEnum	Rozwiń węzeł OData. Opcjonalny.
implementationEffort	Nakład pracy implementacji wymagany do skorygowania tej oceny
OnPremiseResourceDetails	Szczegóły zasobu lokalnego, który został oceniony
OnPremiseSqlResourceDetails	Szczegóły zasobu Lokalnego sql, który został oceniony
SecurityAssessment	Ocena zabezpieczeń zasobu
SecurityAssessmentMetadataPartnerData	Opisuje partnera, który utworzył ocenę
SecurityAssessmentMetadataProperties	Opisuje właściwości metadanych oceny.
SecurityAssessmentPartnerData	Dane dotyczące integracji partnerów innych firm
severity	Poziom ważności oceny
threats
userImpact	Wpływ użytkownika na ocenę

AssessmentLinks

Linki dotyczące oceny

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

AssessmentStatus

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

AssessmentStatusCode

Kod programowy stanu oceny

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

assessmentType

BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition (Niestandardowe, jeśli ocena jest oparta na niestandardowej definicji Azure Policy)

Nazwa	Typ	Opis
BuiltIn	string	Microsoft Defender dla ocen zarządzanych przez chmurę
CustomPolicy	string	Zasady zdefiniowane przez użytkownika, które są automatycznie pozyskiwane z Azure Policy do Microsoft Defender for Cloud
CustomerManaged	string	Oceny użytkowników wypychane bezpośrednio przez użytkownika lub inną osobę trzecią do 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

categories

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

CloudError

Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi 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.

ExpandEnum

Rozwiń węzeł OData. Opcjonalny.

Nazwa	Typ	Opis
links	string	Wszystkie linki skojarzone z oceną
metadata	string	Metadane oceny

implementationEffort

Nakład pracy implementacji 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órych jest dołączona maszyna

OnPremiseSqlResourceDetails

Szczegóły zasobu Lokalnego sql, 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órych jest dołączona maszyna

SecurityAssessment

Ocena zabezpieczeń zasobu

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 dotyczące oceny
properties.metadata	SecurityAssessmentMetadataProperties	Opisuje właściwości metadanych oceny.
properties.partnersData	SecurityAssessmentPartnerData	Dane dotyczące integracji partnerów innych firm
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Szczegóły zasobu, który został oceniony
properties.status	AssessmentStatus	Wynik oceny
type	string	Typ zasobu

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, czy utworzono ocenę — tylko zapis

SecurityAssessmentMetadataProperties

Opisuje właściwości metadanych oceny.

Nazwa	Typ	Opis
assessmentType	assessmentType	BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition (Niestandardowe, jeśli ocena jest oparta na niestandardowej definicji 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	Nakład pracy implementacji 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 na zagrożenia oceny
userImpact	userImpact	Wpływ użytkownika na ocenę

SecurityAssessmentPartnerData

Dane dotyczące integracji partnerów innych firm

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

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 użytkownika na ocenę

Nazwa	Typ	Opis
High	string
Low	string
Moderate	string