Uruchamianie poleceń odpowiedzi na żywo na urządzeniu
Dotyczy:
Ważna
Niektóre informacje zawarte w tym artykule odnoszą się do wersji wstępnej produktu, który może zostać znacznie zmodyfikowany do czasu wydania wersji komercyjnej. Firma Microsoft nie udziela żadnych gwarancji, wyrażonych ani dorozumianych, w odniesieniu do informacji podanych tutaj.
Chcesz poznać usługę ochrony punktu końcowego w usłudze Microsoft Defender? Utwórz konto, aby skorzystać z bezpłatnej wersji próbnej.
Uwaga
Jeśli jesteś klientem rządowym USA, użyj identyfikatorów URI wymienionych w usłudze Microsoft Defender for Endpoint dla klientów rządowych USA.
Porada
Aby uzyskać lepszą wydajność, możesz użyć serwera bliżej lokalizacji geograficznej:
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
Opis interfejsu API
Uruchamia sekwencję poleceń odpowiedzi na żywo na urządzeniu
Ograniczenia
Ograniczenia szybkości dla tego interfejsu API to 10 wywołań na minutę (dodatkowe żądania są odbierane przy użyciu protokołu HTTP 429).
25 współbieżnie uruchomionych sesji (żądania przekraczające limit ograniczania przepustowości otrzymują odpowiedź "429 — zbyt wiele żądań").
Jeśli maszyna nie jest dostępna, sesja jest umieszczana w kolejce przez maksymalnie trzy dni.
Limity czasu poleceń w języku RunScript po 10 minutach.
Polecenia odpowiedzi na żywo nie mogą być umieszczane w kolejce i mogą być wykonywane tylko jeden raz.
Jeśli maszyna, na której próbujesz uruchomić to wywołanie interfejsu API, znajduje się w grupie urządzeń RBAC, która nie ma przypisanego poziomu automatycznego korygowania, musisz przynajmniej włączyć minimalny poziom korygowania dla danej grupy urządzeń.
Uwaga
Tworzenie grupy urządzeń jest obsługiwane w usłudze Defender for Endpoint Plan 1 i Plan 2.
Wiele poleceń odpowiedzi na żywo można uruchomić w jednym wywołaniu interfejsu API. Jeśli jednak polecenie odpowiedzi na żywo zakończy się niepowodzeniem, wszystkie kolejne akcje nie zostaną wykonane.
Nie można wykonać wielu sesji odpowiedzi na żywo na tej samej maszynie (jeśli akcja odpowiedzi na żywo jest już uruchomiona, kolejne żądania są odpowiadane za pomocą protokołu HTTP 400 — ActiveRequestAlreadyExists).
Uwaga
Akcje odpowiedzi na żywo zainicjowane na stronie Urządzenie nie są dostępne w interfejsie API machineactions.
Minimalne wymagania
Przed zainicjowaniem sesji na urządzeniu upewnij się, że spełniasz następujące wymagania:
Sprawdź, czy używasz obsługiwanej wersji systemu Windows, macOS lub Linux.
Na urządzeniach musi działać jeden z następujących elementów:
Windows 11
Windows 10
Windows Server 2019 — dotyczy tylko publicznej wersji zapoznawczej
Windows Server 2022
macOS(wymaga dodatkowych profilów konfiguracji)
- 13 (Ventura)
- 12 (Monterey)
- 11 (Big Sur)
Linux
Uprawnienia
Do wywołania tego interfejsu API jest wymagane jedno z następujących uprawnień. Aby dowiedzieć się więcej, w tym jak wybrać uprawnienia, zobacz Wprowadzenie.
Typ uprawnień | Uprawnienie | Nazwa wyświetlana uprawnień |
---|---|---|
Aplikacja | Machine.LiveResponse | Uruchamianie odpowiedzi na żywo na określonej maszynie |
Delegowane (konto służbowe) | Machine.LiveResponse | Uruchamianie odpowiedzi na żywo na określonej maszynie |
Żądanie HTTP
POST https://api.securitycenter.microsoft.com/API/machines/{machine_id}/runliveresponse
Nagłówki żądań
Name (Nazwa) | Wpisać | Opis |
---|---|---|
Autoryzacja | Ciąg | Token> elementu nośnego<. Wymagane. |
Typ zawartości | ciąg | application/json. Wymagane. |
Treść żądania
Parametr | Wpisać | Opis |
---|---|---|
Komentowanie | Ciąg | Komentarz do skojarzenia z akcją. |
Polecenia | Tablica | Polecenia do uruchomienia. Dozwolone wartości to PutFile, RunScript, GetFile (muszą być w tej kolejności bez limitu powtórzeń). |
Polecenia
Typ polecenia | Parametry | Opis |
---|---|---|
PutFile | Klucz: Nazwa pliku Wartość: <nazwa pliku> |
Umieszcza plik z biblioteki na urządzeniu. Pliki są zapisywane w folderze roboczym i są usuwane po domyślnym ponownym uruchomieniu urządzenia. UWAGA: Nie ma wyniku odpowiedzi. |
RunScript | Klucz: ScriptName Wartość: <skrypt z biblioteki> Klucz: Args |
Uruchamia skrypt z biblioteki na urządzeniu. Parametr Args jest przekazywany do skryptu. Limity czasu po 10 minutach. |
GetFile | Klucz: ścieżka Wartość: <Ścieżka pliku> |
Zbierz plik z urządzenia. UWAGA: Ukośnienia odwrotne w ścieżce muszą być blokami ucieczki. |
Odpowiedź
Jeśli to się powiedzie, ta metoda zwróci wartość 201 Utworzono.
Jednostka akcji. Jeśli nie znaleziono maszyny o określonym identyfikatorze — nie znaleziono 404.
Przykład
Przykład żądania
Oto przykład żądania.
POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runliveresponse
```JSON
{
"Commands":[
{
"type":"RunScript",
"params":[
{
"key":"ScriptName",
"value":"minidump.ps1"
},
{
"key":"Args",
"value":"OfficeClickToRun"
}
]
},
{
"type":"GetFile",
"params":[
{
"key":"Path",
"value":"C:\\windows\\TEMP\\OfficeClickToRun.dmp.zip"
}
]
}
],
"Comment":"Testing Live Response API"
}
Przykład odpowiedzi
Oto przykład odpowiedzi.
Możliwe wartości dla każdego stanu polecenia to "Utworzono", "Ukończono" i "Niepowodzenie".
HTTP/1.1 200 Ok
Typ zawartości: application/json
{
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#MachineActions/$entity",
"id": "{machine_action_id}",
"type": "LiveResponse",
"requestor": "analyst@microsoft.com",
"requestorComment": "Testing Live Response API",
"status": "Pending",
"machineId": "{machine_id}",
"computerDnsName": "hostname",
"creationDateTimeUtc": "2021-02-04T15:36:52.7788848Z",
"lastUpdateDateTimeUtc": "2021-02-04T15:36:52.7788848Z",
"errorHResult": 0,
"commands": [
{
"index": 0,
"startTime": null,
"endTime": null,
"commandStatus": "Created",
"errors": [],
"command": {
"type": "RunScript",
"params": [
{
"key": "ScriptName",
"value": "minidump.ps1"
},{
"key": "Args",
"value": "OfficeClickToRun"
}
]
}
}, {
"index": 1,
"startTime": null,
"endTime": null,
"commandStatus": "Created",
"errors": [],
"command": {
"type": "GetFile",
"params": [{
"key": "Path", "value": "C:\\windows\\TEMP\\OfficeClickToRun.dmp.zip"
}
]
}
}
]
}
Tematy pokrewne
- Uzyskiwanie interfejsu API akcji maszyny
- Pobierz wynik reagowania w czasie rzeczywistym
- Anuluj akcję komputera
Porada
Chcesz dowiedzieć się więcej? Skontaktuj się ze społecznością zabezpieczeń firmy Microsoft w naszej społeczności technicznej: Microsoft Defender for Endpoint Tech Community.