Assets - Get Assets Export

Service:

Defender EASM (preview)

API-versie:

2024-10-01-preview

Exporteer een lijst met assets voor de opgegeven zoekparameters.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Het eindpunt dat als host fungeert voor de aangevraagde resource. Bijvoorbeeld https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
filter	query		string	Filter de resultatenlijst met behulp van de opgegeven expressie.
orderby	query		string	Een lijst met expressies die de volgorde van de geretourneerde resources opgeven.

Aanvraagbody

Name	Vereist	Type	Description
columns	True	string[]	De kolommen die moeten worden geëxporteerd.
fileName	True	string	De naam van het te exporteren bestand.

Antwoorden

Name	Type	Description
200 OK	Task	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

Assets_GetAssetsExport

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

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

Definities

Name	Description
AssetsExportRequest	Een aanvraagbody die wordt gebruikt om een asset te exporteren.
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors
Task
TaskPhase	De fase waarin de taak zich bevindt.
TaskState	De status waarin de taak zich bevindt.

AssetsExportRequest

Object

Een aanvraagbody die wordt gebruikt om een asset te exporteren.

Name	Type	Description
columns	string[]	De kolommen die moeten worden geëxporteerd.
fileName	string	De naam van het te exporteren bestand.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

Task

Object

Name	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de taak is voltooid.
id	string	De unieke id van de taak.
lastPolledAt	string (date-time)	De laatste keer dat de status van de taak is bijgewerkt.
metadata		Kenmerken die uniek zijn voor de taak. Dit verschilt per taaktype.
phase	TaskPhase	De fase waarin de taak zich bevindt.
reason	string	De reden waarom de taak is verplaatst naar de huidige status, als de taak niet is voltooid.
startedAt	string (date-time)	Het tijdstip waarop de taak is gestart.
state	TaskState	De status waarin de taak zich bevindt.

TaskPhase

Opsomming

De fase waarin de taak zich bevindt.

Waarde	Description
running
polling
complete

TaskState

Opsomming

De status waarin de taak zich bevindt.

Waarde	Description
pending
running
paused
complete
incomplete
failed
warning