Assets - Get Assets Export

Servicio:

Defender EASM (preview)

Versión de la API:

2024-10-01-preview

Exporte una lista de recursos para los parámetros de búsqueda proporcionados.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Punto de conexión que hospeda el recurso solicitado. Por ejemplo, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
filter	query		string	Filtre la lista de resultados mediante la expresión especificada.
orderby	query		string	Lista de expresiones que especifican el orden de los recursos devueltos.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
columns	True	string[]	Columnas que se van a exportar.
fileName	True	string	Nombre del archivo que se va a exportar.

Respuestas

Nombre	Tipo	Description
200 OK	Task	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Assets_GetAssetsExport

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
AssetsExportRequest	Cuerpo de la solicitud usado para exportar un recurso.
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	Fase en la que se encuentra la tarea.
TaskState	El estado en el que se encuentra la tarea.

AssetsExportRequest

Objeto

Cuerpo de la solicitud usado para exportar un recurso.

Nombre	Tipo	Description
columns	string[]	Columnas que se van a exportar.
fileName	string	Nombre del archivo que se va a exportar.

Azure.Core.Foundations.Error

Objeto

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Objeto

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto

Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

Task

Objeto

Nombre	Tipo	Description
completedAt	string (date-time)	Hora en que se completó la tarea.
id	string	Identificador único de la tarea.
lastPolledAt	string (date-time)	La última vez que se actualizó el estado de la tarea.
metadata		Atributos únicos de la tarea. Esto difiere según el tipo de tarea.
phase	TaskPhase	Fase en la que se encuentra la tarea.
reason	string	Motivo por el que la tarea se movió a su estado actual, si la tarea no se completó.
startedAt	string (date-time)	Hora en que se inició la tarea.
state	TaskState	El estado en el que se encuentra la tarea.

TaskPhase

Enumeración

Fase en la que se encuentra la tarea.

Valor	Description
running
polling
complete

TaskState

Enumeración

El estado en el que se encuentra la tarea.

Valor	Description
pending
running
paused
complete
incomplete
failed
warning