Набор API значения устройстваSet device value API

Область применения:Applies to:

Применяется к: Microsoft Defender для конечной точкиApplies to: Microsoft Defender for Endpoint

Примечание

Если вы клиент правительства США, используйте URL-адреса, указанные в Microsoft Defender для конечных точек для государственных клиентов США.If you are a US Government customer, please use the URIs listed in Microsoft Defender for Endpoint for US Government customers.

Совет

Для улучшения производительности можно использовать сервер ближе к географическому расположению:For better performance, you can use server closer to your geo location:

  • api-us.securitycenter.microsoft.comapi-us.securitycenter.microsoft.com
  • api-eu.securitycenter.microsoft.comapi-eu.securitycenter.microsoft.com
  • api-uk.securitycenter.microsoft.comapi-uk.securitycenter.microsoft.com

Описание APIAPI description

Установите значение устройства определенной машины.Set the device value of a specific Machine.
Дополнительные сведения см. в добавлении значений устройства.See assign device values for more information.

ОграниченияLimitations

  1. Вы можете размещать на устройствах последний раз в соответствии с настроенным периодом хранения.You can post on devices last seen according to your configured retention period.

  2. Ограничения скорости для этого API : 100 вызовов в минуту и 1500 вызовов в час.Rate limitations for this API are 100 calls per minute and 1500 calls per hour.

РазрешенияPermissions

Для вызова этого API требуется одно из следующих разрешений.One of the following permissions is required to call this API. Дополнительные дополнительные информации, в том числе о выборе разрешений, см. в этой ссылке: Использование API endpoint Defender для Microsoft DefenderTo learn more, including how to choose permissions, see Use Microsoft Defender for Endpoint APIs

Тип разрешенияPermission type РазрешениеPermission Имя отображения разрешенийPermission display name
ПриложениеApplication Machine.ReadWrite.AllMachine.ReadWrite.All 'Read and write all machine information''Read and write all machine information'
Делегированные (рабочая или учебная учетная запись)Delegated (work or school account) Machine.ReadWriteMachine.ReadWrite 'Read and write machine information''Read and write machine information'

Примечание

При получении маркера с помощью учетных данных пользователей:When obtaining a token using user credentials:

  • У пользователя должно быть по крайней мере следующее разрешение на роль: "Управление параметром безопасности".The user needs to have at least the following role permission: 'Manage security setting'. Дополнительные сведения (см. дополнительные сведения о создании ролей и управлении ими)For more (See Create and manage roles for more information)
  • Пользователь должен иметь доступ к машине на основе параметров группы машин (см. дополнительные сведения о создании и управлении группами машин).User needs to have access to the machine, based on machine group settings (See Create and manage machine groups for more information)

HTTP-запросHTTP request

POST https://api.securitycenter.microsoft.com/api/machines/{machineId}/setDeviceValue

Заголовки запросовRequest headers

ИмяName ТипType ОписаниеDescription
АвторизацияAuthorization StringString Bearer {token}.Bearer {token}. Обязательное поле.Required.
Content-TypeContent-Type stringstring application/json.application/json. Обязательное поле.Required.

Тело запросаRequest body

В теле запроса поставляем объект JSON со следующими параметрами:In the request body, supply a JSON object with the following parameters:

ПараметрParameter ТипType ОписаниеDescription
DeviceValueDeviceValue ПеречислениеEnum Значение устройства.Device value. Допустимые значения: "Нормальный", "Низкий" и "Высокий".Allowed values are: 'Normal', 'Low' and 'High'. Обязательное поле.Required.

ОткликResponse

В случае успешной работы этот метод возвращает код ответа 200 — Ok и обновленный компьютер в тексте отклика.If successful, this method returns 200 - Ok response code and the updated Machine in the response body.

ПримерExample

ЗапросRequest

Вот пример запроса, который добавляет тег машины.Here is an example of a request that adds machine tag.

POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/setDeviceValue
{
  "DeviceValue" : "High"
}