Assets - Get Assets Export

Servizio:

Defender EASM (preview)

Versione API:

2024-10-01-preview

Esportare un elenco di asset per i parametri di ricerca forniti.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Endpoint che ospita la risorsa richiesta. Ad esempio, https://{area}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
filter	query		string	Filtrare l'elenco dei risultati usando l'espressione specificata.
orderby	query		string	Elenco di espressioni che specificano l'ordine delle risorse restituite.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
columns	True	string[]	Colonne da esportare.
fileName	True	string	Nome del file da esportare.

Risposte

Nome	Tipo	Descrizione
200 OK	Task	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://easm.defender.microsoft.com/.default

Esempio

Assets_GetAssetsExport

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
AssetsExportRequest	Corpo della richiesta utilizzato per esportare un asset.
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	Fase in cui si trova l'attività.
TaskState	Stato in cui si trova l'attività.

AssetsExportRequest

Oggetto

Corpo della richiesta utilizzato per esportare un asset.

Nome	Tipo	Descrizione
columns	string[]	Colonne da esportare.
fileName	string	Nome del file da esportare.

Azure.Core.Foundations.Error

Oggetto

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Oggetto

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

Task

Oggetto

Nome	Tipo	Descrizione
completedAt	string (date-time)	Ora di completamento dell'attività.
id	string	Identificatore univoco dell'attività.
lastPolledAt	string (date-time)	Ora dell'ultimo aggiornamento dello stato dell'attività.
metadata		Attributi univoci per l'attività. Questo comportamento è diverso dal tipo di attività.
phase	TaskPhase	Fase in cui si trova l'attività.
reason	string	Motivo per cui l'attività è stata spostata nello stato corrente, se l'attività non è stata completata.
startedAt	string (date-time)	Ora di avvio dell'attività.
state	TaskState	Stato in cui si trova l'attività.

TaskPhase

Enumerazione

Fase in cui si trova l'attività.

Valore	Descrizione
running
polling
complete

TaskState

Enumerazione

Stato in cui si trova l'attività.

Valore	Descrizione
pending
running
paused
complete
incomplete
failed
warning