Assessments Metadata - Create In Subscription

Odwołanie

Service:: Defender for Cloud

API Version:: 2020-01-01

Tworzenie informacji o metadanych dotyczących typu oceny w określonej subskrypcji

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}?api-version=2020-01-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

Nazwa	W	Wymagane	Typ	Opis
assessmentMetadataName	path	True	string	Klucz oceny — unikatowy klucz dla typu oceny
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Wersja interfejsu API dla operacji

assessmentMetadataName

path

True

string

Klucz oceny — unikatowy klucz dla typu oceny

subscriptionId

path

True

string

Identyfikator subskrypcji platformy Azure

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

Wersja interfejsu API dla operacji

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.assessmentType	True	assessmentType	BuiltIn, jeśli ocena oparta na wbudowanej definicji Azure Policy, Niestandardowy, jeśli ocena oparta na niestandardowej definicji Azure Policy
properties.displayName	True	string	Przyjazna dla użytkownika nazwa wyświetlana oceny
properties.severity	True	severity	Poziom ważności oceny
properties.categories		categories[]	Kategorie zasobów, które są zagrożone, gdy ocena jest w złej kondycji
properties.description		string	Czytelny opis oceny przez człowieka
properties.implementationEffort		implementationEffort	Nakład pracy nad wdrożeniem wymagany do skorygowania tej oceny
properties.partnerData		SecurityAssessmentMetadataPartnerData	Opisuje partnera, który utworzył ocenę
properties.preview		boolean	Prawda, jeśli ta ocena ma stan wersji zapoznawczej
properties.remediationDescription		string	Czytelny opis tego, co należy zrobić, aby rozwiązać ten problem z zabezpieczeniami
properties.threats		threats[]	Wpływ oceny na zagrożenia
properties.userImpact		userImpact	Wpływ oceny na użytkownika

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SecurityAssessmentMetadata	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

Create security assessment metadata for subscription

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/0980887d-03d6-408c-9566-532f3456804e/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7?api-version=2020-01-01

{
  "properties": {
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "description": "Install an endpoint protection solution on your virtual machines scale sets, to protect them from threats and vulnerabilities.",
    "remediationDescription": "To install an endpoint protection solution: 1.  <a href=\"https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-faq#how-do-i-turn-on-antimalware-in-my-virtual-machine-scale-set\">Follow the instructions in How do I turn on antimalware in my virtual machine scale set</a>",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Sample Response

Status code:: 200

{
  "id": "/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "name": "ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "type": "Microsoft.Security/assessmentMetadata",
  "properties": {
    "displayName": "My organization security assessment",
    "description": "Assessment that my organization created to view our security assessment in Azure Security Center",
    "remediationDescription": "Fix it with these remediation instructions",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Definicje

Nazwa	Opis
assessmentType	BuiltIn, jeśli ocena oparta na wbudowanej definicji Azure Policy, Niestandardowy, jeśli ocena oparta na niestandardowej definicji Azure Policy
categories
CloudError	Typowa odpowiedź na błędy 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 na błąd OData).
CloudErrorBody	Szczegóły błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
implementationEffort	Nakład pracy nad wdrożeniem wymagany do skorygowania tej oceny
SecurityAssessmentMetadata	Metadane oceny zabezpieczeń
SecurityAssessmentMetadataPartnerData	Opisuje partnera, który utworzył ocenę
severity	Poziom ważności oceny
threats
userImpact	Wpływ oceny na użytkownika

assessmentType

BuiltIn, jeśli ocena oparta na wbudowanej definicji Azure Policy, Niestandardowy, jeśli ocena 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ą firmę do Microsoft Defender for Cloud
VerifiedPartner	string	Ocena utworzona przez zweryfikowaną inną firmę, jeśli użytkownik połączył ją z usługą ASC

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 zwraca szczegóły 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

Nakład pracy nad wdrożeniem wymagany do skorygowania tej oceny

Nazwa	Typ	Opis
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

Metadane oceny zabezpieczeń

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
name	string	Nazwa zasobu
properties.assessmentType	assessmentType	BuiltIn, jeśli ocena oparta na wbudowanej definicji Azure Policy, Niestandardowy, jeśli ocena oparta na niestandardowej definicji Azure Policy
properties.categories	categories[]	Kategorie zasobów, które są zagrożone, gdy ocena jest w złej kondycji
properties.description	string	Czytelny opis oceny przez człowieka
properties.displayName	string	Przyjazna dla użytkownika nazwa wyświetlana oceny
properties.implementationEffort	implementationEffort	Nakład pracy nad wdrożeniem wymagany do skorygowania tej oceny
properties.partnerData	SecurityAssessmentMetadataPartnerData	Opisuje partnera, który utworzył ocenę
properties.policyDefinitionId	string	Identyfikator zasobu platformy Azure definicji zasad, która włącza to obliczenie oceny
properties.preview	boolean	Prawda, jeśli ta ocena ma stan wersji zapoznawczej
properties.remediationDescription	string	Czytelny opis tego, co należy zrobić, aby rozwiązać ten problem z zabezpieczeniami
properties.severity	severity	Poziom ważności oceny
properties.threats	threats[]	Wpływ oceny na zagrożenia
properties.userImpact	userImpact	Wpływ oceny na użytkownika
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 w celu uwierzytelnienia partnera i zweryfikowania, czy utworzono ocenę — 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 oceny na użytkownika

Nazwa	Typ	Opis
High	string
Low	string
Moderate	string

Udostępnij za pośrednictwem

Assessments Metadata - Create In Subscription

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Create security assessment metadata for subscription

Sample Request

Sample Response

Definicje

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

Dodatkowe zasoby