Assessments Metadata - Create In Subscription

Service:

Defender for Cloud

API Version:

2020-01-01

Skapa metadatainformation om en utvärderingstyp i en viss prenumeration

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
assessmentMetadataName	path	True	string	Utvärderingsnyckeln – unik nyckel för utvärderingstypen
subscriptionId	path	True	string	Azure-prenumerations-ID Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	API-version för åtgärden

Begärandetext

Name	Obligatorisk	Typ	Description
properties.assessmentType	True	assessmentType	BuiltIn om utvärderingen baseras på inbyggd Azure Policy definition, Anpassad om utvärderingen baseras på anpassad Azure Policy definition
properties.displayName	True	string	Användarvänligt visningsnamn för utvärderingen
properties.severity	True	severity	Utvärderingens allvarlighetsgrad
properties.categories		categories[]	De resurskategorier som är i riskzonen när utvärderingen inte är felfri
properties.description		string	Mänsklig läsbar beskrivning av utvärderingen
properties.implementationEffort		implementationEffort	Den implementeringsinsats som krävs för att åtgärda den här utvärderingen
properties.partnerData		SecurityAssessmentMetadataPartnerData	Beskriver partnern som skapade utvärderingen
properties.preview		boolean	Sant om den här utvärderingen är i förhandsversionsstatus
properties.remediationDescription		string	Mänsklig läsbar beskrivning av vad du bör göra för att åtgärda det här säkerhetsproblemet
properties.threats		threats[]	Hotpåverkan av utvärderingen
properties.userImpact		userImpact	Användarpåverkan av utvärderingen

Svar

Name	Typ	Description
200 OK	SecurityAssessmentMetadata	OK
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
assessmentType	BuiltIn om utvärderingen baseras på inbyggd Azure Policy definition, Anpassad om utvärderingen baseras på anpassad Azure Policy definition
categories
CloudError	Vanliga felsvar för alla Azure Resource Manager API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).
CloudErrorBody	Felinformationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
implementationEffort	Den implementeringsinsats som krävs för att åtgärda den här utvärderingen
SecurityAssessmentMetadata	Metadata för säkerhetsutvärdering
SecurityAssessmentMetadataPartnerData	Beskriver partnern som skapade utvärderingen
severity	Utvärderingens allvarlighetsgrad
threats
userImpact	Användarpåverkan av utvärderingen

assessmentType

BuiltIn om utvärderingen baseras på inbyggd Azure Policy definition, Anpassad om utvärderingen baseras på anpassad Azure Policy definition

Name	Typ	Description
BuiltIn	string	Microsoft Defender för molnhanterade utvärderingar
CustomPolicy	string	Användardefinierade principer som matas in automatiskt från Azure Policy till Microsoft Defender för molnet
CustomerManaged	string	Användarutvärderingar som skickas direkt av användaren eller någon annan tredje part för att Microsoft Defender för molnet
VerifiedPartner	string	En utvärdering som skapades av en verifierad tredje part om användaren anslöt den till ASC

categories

Name	Typ	Description
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

Vanliga felsvar för alla Azure Resource Manager API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

implementationEffort

Den implementeringsinsats som krävs för att åtgärda den här utvärderingen

Name	Typ	Description
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

Metadata för säkerhetsutvärdering

Name	Typ	Description
id	string	Resurs-ID
name	string	Resursnamn
properties.assessmentType	assessmentType	BuiltIn om utvärderingen baseras på inbyggd Azure Policy definition, Anpassad om utvärderingen baseras på anpassad Azure Policy definition
properties.categories	categories[]	De resurskategorier som är i riskzonen när utvärderingen inte är felfri
properties.description	string	Mänsklig läsbar beskrivning av utvärderingen
properties.displayName	string	Användarvänligt visningsnamn för utvärderingen
properties.implementationEffort	implementationEffort	Den implementeringsinsats som krävs för att åtgärda den här utvärderingen
properties.partnerData	SecurityAssessmentMetadataPartnerData	Beskriver partnern som skapade utvärderingen
properties.policyDefinitionId	string	Azure-resurs-ID för principdefinitionen som aktiverar den här utvärderingsberäkningen
properties.preview	boolean	Sant om den här utvärderingen är i förhandsversionsstatus
properties.remediationDescription	string	Mänsklig läsbar beskrivning av vad du bör göra för att åtgärda det här säkerhetsproblemet
properties.severity	severity	Utvärderingens allvarlighetsgrad
properties.threats	threats[]	Hotpåverkan av utvärderingen
properties.userImpact	userImpact	Användarpåverkan av utvärderingen
type	string	Resurstyp

SecurityAssessmentMetadataPartnerData

Beskriver partnern som skapade utvärderingen

Name	Typ	Description
partnerName	string	Namnet på partnerns företag
productName	string	Namnet på produkten för partnern som skapade utvärderingen
secret	string	Hemlighet för att autentisera partnern och verifiera att den skapade utvärderingen – skriv endast

severity

Utvärderingens allvarlighetsgrad

Name	Typ	Description
High	string
Low	string
Medium	string

threats

Name	Typ	Description
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Användarpåverkan av utvärderingen

Name	Typ	Description
High	string
Low	string
Moderate	string