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
流向: 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