Assets - Get Assets Export

Usługa:

Defender EASM (preview)

Wersja interfejsu API:

2024-10-01-preview

Wyeksportuj listę zasobów dla podanych parametrów wyszukiwania.

POST {endpoint}/assets:export?api-version=2024-10-01-preview

Z parametrami opcjonalnymi:

POST {endpoint}/assets:export?api-version=2024-10-01-preview&filter={filter}&orderby={orderby}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy hostowany żądany zasób. Na przykład https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
filter	query		string	Filtruj listę wyników przy użyciu podanego wyrażenia.
orderby	query		string	Lista wyrażeń określających kolejność zwracanych zasobów.

Treść żądania

Nazwa	Wymagane	Typ	Opis
columns	True	string[]	Kolumny do wyeksportowania.
fileName	True	string	Nazwa pliku do wyeksportowania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Task	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://easm.defender.microsoft.com/.default

Przykłady

Assets_GetAssetsExport

Przykładowe żądanie

HTTP

POST {endpoint}/assets:export?api-version=2024-10-01-preview&filter=state%20%3D%20%22confirmed%22

{
  "fileName": "ThisisaFileName",
  "columns": [
    "asset",
    "name"
  ]
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "ThisisaTaskId",
  "startedAt": "2022-05-02T19:30:14.432+00:00",
  "completedAt": "2022-05-02T19:30:54.432+00:00",
  "lastPolledAt": "2022-05-02T19:30:19.432+00:00",
  "state": "complete",
  "phase": "complete",
  "reason": "This is a Task id"
}

Definicje

Nazwa	Opis
AssetsExportRequest	Treść żądania używana do eksportowania elementu zawartości.
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	Faza, w ramach których znajduje się zadanie.
TaskState	Stan, w który znajduje się zadanie.

AssetsExportRequest

Objekt

Treść żądania używana do eksportowania elementu zawartości.

Nazwa	Typ	Opis
columns	string[]	Kolumny do wyeksportowania.
fileName	string	Nazwa pliku do wyeksportowania.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

Task

Objekt

Nazwa	Typ	Opis
completedAt	string (date-time)	Czas ukończenia zadania.
id	string	Unikatowy identyfikator zadania.
lastPolledAt	string (date-time)	Ostatni raz stan zadania został zaktualizowany.
metadata		Atrybuty unikatowe dla zadania. Różni się to od typu zadania.
phase	TaskPhase	Faza, w ramach których znajduje się zadanie.
reason	string	Przyczyna przeniesienia zadania do bieżącego stanu, jeśli zadanie nie zostało ukończone.
startedAt	string (date-time)	Czas rozpoczęcia zadania.
state	TaskState	Stan, w który znajduje się zadanie.

TaskPhase

Wyliczenie

Faza, w ramach których znajduje się zadanie.

Wartość	Opis
running
polling
complete

TaskState

Wyliczenie

Stan, w który znajduje się zadanie.

Wartość	Opis
pending
running
paused
complete
incomplete
failed
warning