Assessments Metadata - Create In Subscription

Ссылка

Service:: Defender for Cloud

API Version:: 2020-01-01

Создание сведений о метаданных для типа оценки в определенной подписке

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

Параметры URI

Имя В Обязательно Тип Описание

Имя	В	Обязательно	Тип	Описание
assessmentMetadataName	path	True	string	Ключ оценки — уникальный ключ для типа оценки
subscriptionId	path	True	string	Идентификатор подписки Azure. Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Версия API для операции

assessmentMetadataName

path

True

string

Ключ оценки — уникальный ключ для типа оценки

subscriptionId

path

True

string

Идентификатор подписки Azure.

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

api-version

query

True

string

Версия API для операции

Текст запроса

Имя	Обязательно	Тип	Описание
properties.assessmentType	True	assessmentType	BuiltIn , если оценка основана на встроенном определении Политика Azure, настраиваемая, если оценка основана на пользовательском определении Политика Azure
properties.displayName	True	string	Понятное отображаемое имя оценки
properties.severity	True	severity	Уровень серьезности оценки
properties.categories		categories[]	Категории ресурсов, которые подвергаются риску при неработоспособности оценки
properties.description		string	Понятное описание оценки
properties.implementationEffort		implementationEffort	Усилия по реализации, необходимые для исправления этой оценки
properties.partnerData		SecurityAssessmentMetadataPartnerData	Описание партнера, создавшего оценку.
properties.preview		boolean	True, если эта оценка находится в состоянии предварительной версии
properties.remediationDescription		string	Понятное описание действий для устранения этой проблемы безопасности
properties.threats		threats[]	Влияние оценки на угрозы
properties.userImpact		userImpact	Влияние оценки на пользователей

Ответы

Имя	Тип	Описание
200 OK	SecurityAssessmentMetadata	ОК
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
assessmentType	BuiltIn , если оценка основана на встроенном определении Политика Azure, настраиваемая, если оценка основана на пользовательском определении Политика Azure
categories
CloudError	Общие ответы об ошибках для всех API-интерфейсов Azure Resource Manager возвращать сведения об ошибках для неудачных операций. (Это также соответствует формату ответа об ошибке OData.)
CloudErrorBody	Сведения об ошибке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
implementationEffort	Усилия по реализации, необходимые для исправления этой оценки
SecurityAssessmentMetadata	Метаданные оценки безопасности
SecurityAssessmentMetadataPartnerData	Описание партнера, создавшего оценку.
severity	Уровень серьезности оценки
threats
userImpact	Влияние оценки на пользователей

assessmentType

BuiltIn , если оценка основана на встроенном определении Политика Azure, настраиваемая, если оценка основана на пользовательском определении Политика Azure

Имя	Тип	Описание
BuiltIn	string	Microsoft Defender для облачных оценок
CustomPolicy	string	Определяемые пользователем политики, автоматически поступающие из Политика Azure в Microsoft Defender для облака
CustomerManaged	string	Оценки пользователей, отправленные непосредственно пользователем или другим третьим лицом в Microsoft Defender для облака
VerifiedPartner	string	Оценка, созданная проверенной стороной, если пользователь подключил ее к ASC

Имя	Тип	Описание
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

Общие ответы об ошибках для всех API-интерфейсов Azure Resource Manager возвращать сведения об ошибках для неудачных операций. (Это также соответствует формату ответа об ошибке OData.)

Имя	Тип	Описание
error.additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Сведения об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект ошибки.

CloudErrorBody

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CloudErrorBody[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

implementationEffort

Усилия по реализации, необходимые для исправления этой оценки

Имя	Тип	Описание
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

Метаданные оценки безопасности

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.assessmentType	assessmentType	BuiltIn , если оценка основана на встроенном определении Политика Azure, настраиваемая, если оценка основана на пользовательском определении Политика Azure
properties.categories	categories[]	Категории ресурсов, которые подвергаются риску при неработоспособности оценки
properties.description	string	Понятное описание оценки
properties.displayName	string	Понятное отображаемое имя оценки
properties.implementationEffort	implementationEffort	Усилия по реализации, необходимые для исправления этой оценки
properties.partnerData	SecurityAssessmentMetadataPartnerData	Описание партнера, создавшего оценку.
properties.policyDefinitionId	string	Идентификатор ресурса Azure для определения политики, которая включает вычисление этой оценки
properties.preview	boolean	True, если эта оценка находится в состоянии предварительной версии
properties.remediationDescription	string	Понятное описание действий для устранения этой проблемы безопасности
properties.severity	severity	Уровень серьезности оценки
properties.threats	threats[]	Влияние оценки на угрозы
properties.userImpact	userImpact	Влияние оценки на пользователей
type	string	Тип ресурса

SecurityAssessmentMetadataPartnerData

Описание партнера, создавшего оценку.

Имя	Тип	Описание
partnerName	string	Название компании партнера
productName	string	Имя продукта партнера, создавшего оценку
secret	string	Секрет для проверки подлинности партнера и проверки того, что он создал оценку — только запись

severity

Уровень серьезности оценки

Имя	Тип	Описание
High	string
Low	string
Medium	string

threats

Имя	Тип	Описание
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Влияние оценки на пользователей

Имя	Тип	Описание
High	string
Low	string
Moderate	string

Поделиться через

Assessments Metadata - Create In Subscription

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Scopes

Примеры

Create security assessment metadata for subscription

Sample Request

Sample Response

Определения

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

Дополнительные ресурсы