Assessments Metadata - Create In Subscription

Referentie

Service:: Defender for Cloud

API Version:: 2020-01-01

Metagegevensgegevens maken voor een evaluatietype in een specifiek abonnement

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

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
assessmentMetadataName	path	True	string	De evaluatiesleutel - unieke sleutel voor het evaluatietype
subscriptionId	path	True	string	Azure-abonnements-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-versie voor de bewerking

assessmentMetadataName

path

True

string

De evaluatiesleutel - unieke sleutel voor het evaluatietype

subscriptionId

path

True

string

Azure-abonnements-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-versie voor de bewerking

Aanvraagbody

Name	Vereist	Type	Description
properties.assessmentType	True	assessmentType	BuiltIn als de evaluatie is gebaseerd op ingebouwde Azure Policy definitie, Aangepast als de evaluatie is gebaseerd op aangepaste Azure Policy definitie
properties.displayName	True	string	Gebruiksvriendelijke weergavenaam van de evaluatie
properties.severity	True	severity	Het ernstniveau van de evaluatie
properties.categories		categories[]	De resourcecategorieën die risico lopen wanneer de evaluatie niet in orde is
properties.description		string	Door mensen leesbare beschrijving van de evaluatie
properties.implementationEffort		implementationEffort	De implementatie-inspanning die nodig is om deze evaluatie te herstellen
properties.partnerData		SecurityAssessmentMetadataPartnerData	Beschrijft de partner die de evaluatie heeft gemaakt
properties.preview		boolean	Waar als deze evaluatie de status van de preview-release heeft
properties.remediationDescription		string	Leesbare beschrijving van wat u moet doen om dit beveiligingsprobleem te verhelpen
properties.threats		threats[]	Bedreigingseffect van de evaluatie
properties.userImpact		userImpact	De gebruikersimpact van de evaluatie

Antwoorden

Name	Type	Description
200 OK	SecurityAssessmentMetadata	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name	Description
assessmentType	BuiltIn als de evaluatie is gebaseerd op ingebouwde Azure Policy definitie, Aangepast als de evaluatie is gebaseerd op aangepaste Azure Policy definitie
categories
CloudError	Algemene foutreactie voor alle Azure Resource Manager-API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de indeling van de OData-foutreactie.)
CloudErrorBody	De foutdetails.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
implementationEffort	De implementatie-inspanning die nodig is om deze evaluatie te herstellen
SecurityAssessmentMetadata	Metagegevens van beveiligingsevaluatie
SecurityAssessmentMetadataPartnerData	Beschrijft de partner die de evaluatie heeft gemaakt
severity	Het ernstniveau van de evaluatie
threats
userImpact	De gebruikersimpact van de evaluatie

assessmentType

BuiltIn als de evaluatie is gebaseerd op ingebouwde Azure Policy definitie, Aangepast als de evaluatie is gebaseerd op aangepaste Azure Policy definitie

Name	Type	Description
BuiltIn	string	Microsoft Defender voor door de cloud beheerde evaluaties
CustomPolicy	string	Door de gebruiker gedefinieerde beleidsregels die automatisch worden opgenomen van Azure Policy naar Microsoft Defender for Cloud
CustomerManaged	string	Gebruikersevaluaties die rechtstreeks door de gebruiker of een andere derde partij naar Microsoft Defender voor Cloud worden gepusht
VerifiedPartner	string	Een evaluatie die is gemaakt door een geverifieerde derde partij als de gebruiker deze heeft verbonden met ASC

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

CloudError

Algemene foutreactie voor alle Azure Resource Manager-API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de indeling van de OData-foutreactie.)

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
error.code	string	De foutcode.
error.details	CloudErrorBody[]	De foutdetails.
error.message	string	Het foutbericht.
error.target	string	Het foutdoel.

CloudErrorBody

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	CloudErrorBody[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

implementationEffort

De implementatie-inspanning die nodig is om deze evaluatie te herstellen

Name	Type	Description
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

Metagegevens van beveiligingsevaluatie

Name	Type	Description
id	string	Resource-id
name	string	Resourcenaam
properties.assessmentType	assessmentType	BuiltIn als de evaluatie is gebaseerd op ingebouwde Azure Policy definitie, Aangepast als de evaluatie is gebaseerd op aangepaste Azure Policy definitie
properties.categories	categories[]	De resourcecategorieën die risico lopen wanneer de evaluatie niet in orde is
properties.description	string	Door mensen leesbare beschrijving van de evaluatie
properties.displayName	string	Gebruiksvriendelijke weergavenaam van de evaluatie
properties.implementationEffort	implementationEffort	De implementatie-inspanning die nodig is om deze evaluatie te herstellen
properties.partnerData	SecurityAssessmentMetadataPartnerData	Beschrijft de partner die de evaluatie heeft gemaakt
properties.policyDefinitionId	string	Azure-resource-id van de beleidsdefinitie waarmee deze evaluatieberekening wordt ingeschakeld
properties.preview	boolean	Waar als deze evaluatie de status van de preview-release heeft
properties.remediationDescription	string	Leesbare beschrijving van wat u moet doen om dit beveiligingsprobleem te verhelpen
properties.severity	severity	Het ernstniveau van de evaluatie
properties.threats	threats[]	Bedreigingseffect van de evaluatie
properties.userImpact	userImpact	De gebruikersimpact van de evaluatie
type	string	Resourcetype

SecurityAssessmentMetadataPartnerData

Beschrijft de partner die de evaluatie heeft gemaakt

Name	Type	Description
partnerName	string	Naam van het bedrijf van de partner
productName	string	Naam van het product van de partner die de evaluatie heeft gemaakt
secret	string	Geheim om de partner te verifiëren en te controleren of deze de evaluatie heeft gemaakt - alleen schrijven

severity

Het ernstniveau van de evaluatie

Name	Type	Description
High	string
Low	string
Medium	string

threats

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

userImpact

De gebruikersimpact van de evaluatie

Name	Type	Description
High	string
Low	string
Moderate	string

Delen via

Assessments Metadata - Create In Subscription

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

Create security assessment metadata for subscription

Sample Request

Sample Response

Definities

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

Aanvullende resources