API del computer offboardOffboard machine API

Si applica a:Applies to:

Vuoi provare Defender per Endpoint?Want to experience Defender for Endpoint? Iscriversi per una versione di valutazione gratuita.Sign up for a free trial.

Nota

Se sei un cliente us government, usa gli URI elencati in Microsoft Defender for Endpoint per i clienti del governo statunitense.If you are a US Government customer, please use the URIs listed in Microsoft Defender for Endpoint for US Government customers.

Suggerimento

Per ottenere prestazioni migliori, è possibile utilizzare il server più vicino alla posizione geografica: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

Descrizione APIAPI description

Dispositivo offboard da Defender per Endpoint.Offboard device from Defender for Endpoint.

LimitazioniLimitations

  • I limiti di frequenza per questa API sono 100 chiamate al minuto e 1500 chiamate all'ora.Rate limitations for this API are 100 calls per minute and 1500 calls per hour.

Nota

Questa pagina è incentrata sull'esecuzione di un'azione del computer tramite API.This page focuses on performing a machine action via API. Vedi eseguire azioni di risposta in un computer per altre informazioni sulla funzionalità delle azioni di risposta tramite Microsoft Defender per Endpoint.See take response actions on a machine for more information about response actions functionality via Microsoft Defender for Endpoint.

Nota

Questa API è supportata Windows 10 versione 1703 e successive o Windows Server 2019 e versioni successive.This API is supported on Windows 10, version 1703 and later, or Windows Server 2019 and later. Questa API non è supportata nei dispositivi MacOS o Linux.This API is not supported on MacOS or Linux devices.

AutorizzazioniPermissions

Per chiamare questa API è necessaria una delle autorizzazioni seguenti.One of the following permissions is required to call this API. Per altre informazioni, incluso come scegliere le autorizzazioni, vedi Usare Defender per le API endpointTo learn more, including how to choose permissions, see Use Defender for Endpoint APIs

Tipo di autorizzazionePermission type AutorizzazionePermission Nome visualizzato autorizzazionePermission display name
ApplicazioneApplication Machine.OffboardMachine.Offboard "Computer offboard"'Offboard machine'
Delegato (account aziendale o dell'istituto di istruzione)Delegated (work or school account) Machine.OffboardMachine.Offboard "Computer offboard"'Offboard machine'

Nota

Quando si ottiene un token utilizzando le credenziali utente:When obtaining a token using user credentials:

  • L'utente deve avere il ruolo AD "Amministratore globale"The user needs to 'Global Admin' AD role
  • L'utente deve avere accesso al dispositivo in base alle impostazioni del gruppo di dispositivi (per ulteriori informazioni, vedere Creare e gestire gruppi di dispositivi)The user needs to have access to the device, based on device group settings (See Create and manage device groups for more information)

Richiesta HTTPHTTP request

POST https://api.securitycenter.microsoft.com/api/machines/{id}/offboard

Intestazioni di richiestaRequest headers

NameName TipoType DescrizioneDescription
AutorizzazioneAuthorization StringaString Bearer {token}.Bearer {token}. Obbligatorio.Required.
Content-TypeContent-Type stringastring application/json.application/json. Obbligatorio.Required.

Corpo della richiestaRequest body

Nel corpo della richiesta, fornire un oggetto JSON con i parametri seguenti:In the request body, supply a JSON object with the following parameters:

ParametroParameter TipoType DescrizioneDescription
CommentComment StringaString Commento da associare all'azione.Comment to associate with the action. Obbligatorio.Required.

RispostaResponse

Se ha esito positivo, questo metodo restituisce 201 - Codice di risposta creato e Azione del computer nel corpo della risposta.If successful, this method returns 201 - Created response code and Machine Action in the response body.

EsempioExample

RichiestaRequest

Ecco un esempio della richiesta.Here is an example of the request.

POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
  "Comment": "Offboard machine by automation"
}