Assets - Get Assets Export

Служба:

Defender EASM (preview)

Версия API:

2024-10-01-preview

Экспортируйте список ресурсов для предоставленных параметров поиска.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка, на котором размещен запрошенный ресурс. Например, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
filter	query		string	Отфильтруйте список результатов с помощью заданного выражения.
orderby	query		string	Список выражений, определяющих порядок возвращаемых ресурсов.

Текст запроса

Имя	Обязательно	Тип	Описание
columns	True	string[]	Столбцы для экспорта.
fileName	True	string	Имя файла для экспорта.

Ответы

Имя	Тип	Описание
200 OK	Task	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://easm.defender.microsoft.com/.default

Примеры

Assets_GetAssetsExport

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
AssetsExportRequest	Текст запроса, используемый для экспорта ресурса.
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	Этап, в который выполняется задача.
TaskState	Состояние, в которое находится задача.

AssetsExportRequest

Объект

Текст запроса, используемый для экспорта ресурса.

Имя	Тип	Описание
columns	string[]	Столбцы для экспорта.
fileName	string	Имя файла для экспорта.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

Task

Объект

Имя	Тип	Описание
completedAt	string (date-time)	Время завершения задачи.
id	string	Уникальный идентификатор задачи.
lastPolledAt	string (date-time)	При последнем обновлении состояния задачи.
metadata		Атрибуты, уникальные для задачи. Это отличается по типу задачи.
phase	TaskPhase	Этап, в который выполняется задача.
reason	string	Причина перемещения задачи в текущее состояние, если задача не была завершена.
startedAt	string (date-time)	Время запуска задачи.
state	TaskState	Состояние, в которое находится задача.

TaskPhase

Перечисление

Этап, в который выполняется задача.

Значение	Описание
running
polling
complete

TaskState

Перечисление

Состояние, в которое находится задача.

Значение	Описание
pending
running
paused
complete
incomplete
failed
warning