Assets - Get Assets Export

Tjänst:

Defender EASM (preview)

API-version:

2024-10-01-preview

Exportera en lista över tillgångar för de angivna sökparametrarna.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkten som är värd för den begärda resursen. Till exempel https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
filter	query		string	Filtrera resultatlistan med det angivna uttrycket.
orderby	query		string	En lista med uttryck som anger ordningen på de returnerade resurserna.

Begärandetext

Name	Obligatorisk	Typ	Description
columns	True	string[]	De kolumner som ska exporteras.
fileName	True	string	Namnet på filen som ska exporteras.

Svar

Name	Typ	Description
200 OK	Task	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

Assets_GetAssetsExport

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AssetsExportRequest	En begärandetext som används för att exportera en tillgång.
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	Fasen som aktiviteten befinner sig i.
TaskState	Tillståndet som aktiviteten är i.

AssetsExportRequest

Objekt

En begärandetext som används för att exportera en tillgång.

Name	Typ	Description
columns	string[]	De kolumner som ska exporteras.
fileName	string	Namnet på filen som ska exporteras.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

Task

Objekt

Name	Typ	Description
completedAt	string (date-time)	Den tid då aktiviteten slutfördes.
id	string	Den unika identifieraren för uppgiften.
lastPolledAt	string (date-time)	Senast aktivitetens status uppdaterades.
metadata		Attribut som är unika för aktiviteten. Detta skiljer sig åt beroende på aktivitetstyp.
phase	TaskPhase	Fasen som aktiviteten befinner sig i.
reason	string	Anledningen till att aktiviteten flyttades till dess aktuella tillstånd, om aktiviteten inte slutfördes.
startedAt	string (date-time)	Den tid då aktiviteten startades.
state	TaskState	Tillståndet som aktiviteten är i.

TaskPhase

Uppräkning

Fasen som aktiviteten befinner sig i.

Värde	Description
running
polling
complete

TaskState

Uppräkning

Tillståndet som aktiviteten är i.

Värde	Description
pending
running
paused
complete
incomplete
failed
warning