Assets - Get Assets Export

Služba:

Defender EASM (preview)

Verze rozhraní API:

2024-10-01-preview

Exportujte seznam prostředků pro zadané parametry hledání.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod hostující požadovaný prostředek. Například https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
filter	query		string	Filtrujte seznam výsledků pomocí daného výrazu.
orderby	query		string	Seznam výrazů, které určují pořadí vrácených prostředků.

Text požadavku

Name	Vyžadováno	Typ	Description
columns	True	string[]	Sloupce, které chcete exportovat.
fileName	True	string	Název souboru, který chcete exportovat.

Odpovědi

Name	Typ	Description
200 OK	Task	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Assets_GetAssetsExport

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AssetsExportRequest	Text požadavku použitý k exportu prostředku.
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	Fáze, ve které je úkol.
TaskState	Stav, ve který je úkol.

AssetsExportRequest

Objekt

Text požadavku použitý k exportu prostředku.

Name	Typ	Description
columns	string[]	Sloupce, které chcete exportovat.
fileName	string	Název souboru, který chcete exportovat.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

Task

Objekt

Name	Typ	Description
completedAt	string (date-time)	Čas dokončení úkolu.
id	string	Jedinečný identifikátor úkolu.
lastPolledAt	string (date-time)	Čas poslední aktualizace stavu úkolu
metadata		Atributy jsou jedinečné pro úkol. Liší se podle typu úkolu.
phase	TaskPhase	Fáze, ve které je úkol.
reason	string	Důvod, proč byl úkol přesunut do aktuálního stavu, pokud nebyl úkol dokončen.
startedAt	string (date-time)	Čas zahájení úkolu.
state	TaskState	Stav, ve který je úkol.

TaskPhase

Výčet

Fáze, ve které je úkol.

Hodnota	Description
running
polling
complete

TaskState

Výčet

Stav, ve který je úkol.

Hodnota	Description
pending
running
paused
complete
incomplete
failed
warning