Assets - Get Assets Export

Service:

Defender EASM (preview)

Version d'API:

2024-10-01-preview

Exportez une liste de ressources pour les paramètres de recherche fournis.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison hébergeant la ressource demandée. Par exemple, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
filter	query		string	Filtrez la liste des résultats à l’aide de l’expression donnée.
orderby	query		string	Liste d’expressions qui spécifient l’ordre des ressources retournées.

Corps de la demande

Nom	Obligatoire	Type	Description
columns	True	string[]	Colonnes à exporter.
fileName	True	string	Nom du fichier à exporter.

Réponses

Nom	Type	Description
200 OK	Task	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Assets_GetAssetsExport

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
AssetsExportRequest	Corps de demande utilisé pour exporter une ressource.
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	Phase dans laquelle la tâche se trouve.
TaskState	État dans lequel se trouve la tâche.

AssetsExportRequest

Objet

Corps de demande utilisé pour exporter une ressource.

Nom	Type	Description
columns	string[]	Colonnes à exporter.
fileName	string	Nom du fichier à exporter.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

Task

Objet

Nom	Type	Description
completedAt	string (date-time)	Heure à laquelle la tâche s’est terminée.
id	string	Identificateur unique de la tâche.
lastPolledAt	string (date-time)	Dernière fois que l’état de la tâche a été mis à jour.
metadata		Attributs uniques à la tâche. Cela diffère du type de tâche.
phase	TaskPhase	Phase dans laquelle la tâche se trouve.
reason	string	La raison pour laquelle la tâche a été déplacée dans son état actuel, si la tâche n’a pas été terminée.
startedAt	string (date-time)	Heure de démarrage de la tâche.
state	TaskState	État dans lequel se trouve la tâche.

TaskPhase

Énumération

Phase dans laquelle la tâche se trouve.

Valeur	Description
running
polling
complete

TaskState

Énumération

État dans lequel se trouve la tâche.

Valeur	Description
pending
running
paused
complete
incomplete
failed
warning