Assets - Get Assets Export

Dienst:

Defender EASM (preview)

API-Version:

2024-10-01-preview

Exportieren Sie eine Liste der Ressourcen für die bereitgestellten Suchparameter.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Endpunkt, der die angeforderte Ressource hosten soll. Beispiel: https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
filter	query		string	Filtern Sie die Ergebnisliste mithilfe des angegebenen Ausdrucks.
orderby	query		string	Eine Liste von Ausdrücken, die die Reihenfolge der zurückgegebenen Ressourcen angeben.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
columns	True	string[]	Die zu exportierenden Spalten.
fileName	True	string	Der Name der zu exportierenden Datei.

Antworten

Name	Typ	Beschreibung
200 OK	Task	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://easm.defender.microsoft.com/.default

Beispiele

Assets_GetAssetsExport

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AssetsExportRequest	Ein Anforderungstext, der zum Exportieren einer Ressource verwendet wird.
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors
Task
TaskPhase	Die Phase, in der sich der Vorgang befindet.
TaskState	Der Zustand, in dem sich der Vorgang befindet.

AssetsExportRequest

Objekt

Ein Anforderungstext, der zum Exportieren einer Ressource verwendet wird.

Name	Typ	Beschreibung
columns	string[]	Die zu exportierenden Spalten.
fileName	string	Der Name der zu exportierenden Datei.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

Task

Objekt

Name	Typ	Beschreibung
completedAt	string (date-time)	Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde.
id	string	Der eindeutige Bezeichner des Vorgangs.
lastPolledAt	string (date-time)	Das letzte Mal, wenn der Status der Aufgabe aktualisiert wurde.
metadata		Attribute, die für die Aufgabe eindeutig sind. Dies unterscheidet sich je nach Aufgabentyp.
phase	TaskPhase	Die Phase, in der sich der Vorgang befindet.
reason	string	Der Grund, warum der Vorgang in den aktuellen Zustand verschoben wurde, wenn der Vorgang nicht abgeschlossen wurde.
startedAt	string (date-time)	Der Zeitpunkt, zu dem die Aufgabe gestartet wurde.
state	TaskState	Der Zustand, in dem sich der Vorgang befindet.

TaskPhase

Enumeration

Die Phase, in der sich der Vorgang befindet.

Wert	Beschreibung
running
polling
complete

TaskState

Enumeration

Der Zustand, in dem sich der Vorgang befindet.

Wert	Beschreibung
pending
running
paused
complete
incomplete
failed
warning