Assessments Metadata - Create In Subscription

Ссылка

Служба:: Defender for Cloud

Версия API:: 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 pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Идентификатор подписки Azure
api-version	query	True	string	Версия API для операции

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

Имя	Обязательно	Тип	Описание
properties.assessmentType	True	assessmentType	Встроенная оценка, основанная на встроенном определении политики 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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

Create security assessment metadata for subscription

Образец запроса

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

Пример ответа

Код состояния:: 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	Встроенная оценка, основанная на встроенном определении политики Azure, настраиваемая, если оценка основана на пользовательском определении политики Azure.
categories
CloudError	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
CloudErrorBody	Сведения об ошибке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
implementationEffort	Усилия по реализации, необходимые для устранения этой оценки
SecurityAssessmentMetadata	Метаданные оценки безопасности
SecurityAssessmentMetadataPartnerData	Описание партнера, создавшего оценку
severity	Уровень серьезности оценки
threats
userImpact	Влияние пользователя на оценку

assessmentType

Перечисление

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

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

Значение	Описание
Compute
Data
IdentityAndAccess
IoT
Networking

CloudError

Object

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

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

CloudErrorBody

Object

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

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

ErrorAdditionalInfo

Object

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

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

implementationEffort

Перечисление

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

Значение	Описание
High
Low
Moderate

SecurityAssessmentMetadata

Object

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

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.assessmentType	assessmentType	Встроенная оценка, основанная на встроенном определении политики 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

Object

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

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

severity

Перечисление

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

Значение	Описание
High
Low
Medium

threats

Перечисление

Значение	Описание
accountBreach
dataExfiltration
dataSpillage
denialOfService
elevationOfPrivilege
maliciousInsider
missingCoverage
threatResistance

userImpact

Перечисление

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

Значение	Описание
High
Low
Moderate

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

Assessments Metadata - Create In Subscription

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

Create security assessment metadata for subscription

Образец запроса

Пример ответа

Определения

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

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