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 參數

名稱	位於	必要	類型	Description
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	指定傳回資源順序的表達式清單。

要求本文

名稱	必要	類型	Description
columns	True	string[]	要匯出的數據行。
fileName	True	string	要匯出的檔名。

回應

名稱	類型	Description
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

範圍

名稱	Description
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"
}

定義

名稱	Description
AssetsExportRequest	用來導出資產的要求本文。
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
Task
TaskPhase	工作處於中的階段。
TaskState	工作的狀態。

AssetsExportRequest

Object

用來導出資產的要求本文。

名稱	類型	Description
columns	string[]	要匯出的數據行。
fileName	string	要匯出的檔名。

Azure.Core.Foundations.Error

Object

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

Object

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

Object

物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

Task

Object

名稱	類型	Description
completedAt	string (date-time)	工作完成的時間。
id	string	工作的唯一標識碼。
lastPolledAt	string (date-time)	上次更新工作狀態的時間。
metadata		工作的唯一屬性。 這與工作類型不同。
phase	TaskPhase	工作處於中的階段。
reason	string	如果工作未完成，工作已移至其目前狀態的原因。
startedAt	string (date-time)	工作開始的時間。
state	TaskState	工作的狀態。

TaskPhase

列舉型別

工作處於中的階段。

值	Description
running
polling
complete

TaskState

列舉型別

工作的狀態。

值	Description
pending
running
paused
complete
incomplete
failed
warning