Exports - Get Execution History
取得已定義範圍和匯出名稱之匯出執行歷程記錄的作業。
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory?api-version=2023-11-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
export
|
path | True |
string |
匯出名稱。 |
scope
|
path | True |
string |
與導出作業相關聯的範圍。 這包括訂用帳戶範圍的 '/subscriptions/{subscriptionId}/' '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{EnrollmentAccount 範圍、'/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope 的 enrollmentAccountId}' '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfileId}/{invoiceSections/{invoiceSectionId}' 和 '/providers/Microsoft'。Billing/billingAccounts/{billingAccountId}/customers/{customerId}' 專屬的合作夥伴。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
正常。 要求成功。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
ExportRunHistoryGetByBillingAccount
範例要求
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
範例回覆
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByDepartment
範例要求
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
範例回覆
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByEnrollmentAccount
範例要求
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
範例回覆
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByManagementGroup
範例要求
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
範例回覆
{
"value": [
{
"id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByResourceGroup
範例要求
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
範例回覆
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetBySubscription
範例要求
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
範例回覆
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
定義
名稱 | Description |
---|---|
Common |
導出的通用屬性。 |
Error |
錯誤的詳細數據。 |
Error |
錯誤回應表示服務無法處理傳入要求。 錯誤訊息中提供了原因。 某些錯誤回應:
|
Execution |
匯出執行的最後一個已知狀態。 |
Execution |
匯出執行的型別。 |
Export |
匯出中數據的定義。 |
Export |
匯出數據集組態。 允許選取匯出的數據行。 如果未提供,匯出將會包含所有可用的數據行。 |
Export |
匯出的定義。 |
Export |
這代表將傳遞成本導出的 Blob 記憶體帳戶位置。 有兩種方式可以設定目的地。 大部分客戶建議的方法是指定記憶體帳戶的 resourceId。 這需要向 Microsoft.CostManagementExports 資源提供者註冊帳戶的一次性註冊,才能讓成本管理服務存取記憶體。 在 Azure 入口網站 中建立匯出時,會自動執行此註冊,但 API 使用者可能需要明確地 (註冊訂用帳戶,以取得詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ) 。 另一種設定目的地的方法僅適用於具有其計費帳戶全域系統管理員之 Microsoft 合作夥伴合約 方案的合作夥伴。 這些合作夥伴可以指定記憶體帳戶名稱以及帳戶的 SAS 令牌,而不是指定記憶體帳戶的 resourceId。 這允許將成本匯出至任何租使用者中的記憶體帳戶。 您應該使用 Service/Container/Object 資源類型和讀取/寫入/刪除/清單/新增/建立許可權來為 Blob 服務建立 SAS 令牌 (,以取得詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ) 。 |
Export |
與導出相關聯的傳遞資訊。 |
Export |
列出導出的執行歷程記錄的結果。 |
Export |
匯出執行。 |
Export |
匯出中數據的日期範圍。 這應該只指定 timeFrame 設定為 『Custom』。 日期範圍上限為 3 個月。 |
Export |
匯出的類型。 請注意,『Usage』 相當於 『ActualCost』,而且適用於尚未針對服務保留提供費用或分攤數據的匯出。 |
Format |
要傳遞的導出格式。 目前僅支援 『Csv』。 |
Granularity |
匯出中數據列的數據粒度。 目前僅支援 「每日」。 |
Timeframe |
提取匯出數據的時間範圍。 如果為自定義,則必須提供特定的時間週期。 |
CommonExportProperties
導出的通用屬性。
名稱 | 類型 | Description |
---|---|---|
definition |
具有導出的定義。 |
|
deliveryInfo |
具有導出的傳遞資訊。 |
|
format |
要傳遞的導出格式。 目前僅支援 『Csv』。 |
|
nextRunTimeEstimate |
string |
如果導出具有作用中的排程,請提供下一個運行時間的估計值。 |
partitionData |
boolean |
如果設定為 true,匯出的數據會依大小分割,並放在 Blob 目錄中,以及指令清單檔。 注意:此選項目前僅適用於 Microsoft 客戶合約 商務範圍。 |
runHistory |
如果已要求,則具有匯出的最新執行歷程記錄。 |
ErrorDetails
錯誤的詳細數據。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
指出作業失敗原因的錯誤訊息。 |
ErrorResponse
錯誤回應表示服務無法處理傳入要求。 錯誤訊息中提供了原因。
某些錯誤回應:
429 TooManyRequests - 要求已節流。 等候 「x-ms-ratelimit-microsoft.consumption-retry-after」 標頭中指定的時間後重試。
503 ServiceUnavailable - 服務暫時無法使用。 請在等候「Retry-After」標頭中指定的時間之後重試。
名稱 | 類型 | Description |
---|---|---|
error |
錯誤的詳細數據。 |
ExecutionStatus
匯出執行的最後一個已知狀態。
名稱 | 類型 | Description |
---|---|---|
Completed |
string |
|
DataNotAvailable |
string |
|
Failed |
string |
|
InProgress |
string |
|
NewDataNotAvailable |
string |
|
Queued |
string |
|
Timeout |
string |
ExecutionType
匯出執行的型別。
名稱 | 類型 | Description |
---|---|---|
OnDemand |
string |
|
Scheduled |
string |
ExportDataset
匯出中數據的定義。
名稱 | 類型 | Description |
---|---|---|
configuration |
匯出數據集組態。 |
|
granularity |
匯出中數據列的數據粒度。 目前僅支援 「每日」。 |
ExportDatasetConfiguration
匯出數據集組態。 允許選取匯出的數據行。 如果未提供,匯出將會包含所有可用的數據行。
名稱 | 類型 | Description |
---|---|---|
columns |
string[] |
要包含在匯出中的數據行名稱陣列。 如果未提供,匯出將會包含所有可用的數據行。 可用的數據行可能會因客戶通道而有所不同, (請參閱範例) 。 |
ExportDefinition
匯出的定義。
名稱 | 類型 | Description |
---|---|---|
dataSet |
匯出中數據的定義。 |
|
timePeriod |
具有提取匯出數據的時間週期。 |
|
timeframe |
提取匯出數據的時間範圍。 如果為自定義,則必須提供特定的時間週期。 |
|
type |
匯出的類型。 請注意,『Usage』 相當於 『ActualCost』,而且適用於尚未針對服務保留提供費用或分攤數據的匯出。 |
ExportDeliveryDestination
這代表將傳遞成本導出的 Blob 記憶體帳戶位置。 有兩種方式可以設定目的地。 大部分客戶建議的方法是指定記憶體帳戶的 resourceId。 這需要向 Microsoft.CostManagementExports 資源提供者註冊帳戶的一次性註冊,才能讓成本管理服務存取記憶體。 在 Azure 入口網站 中建立匯出時,會自動執行此註冊,但 API 使用者可能需要明確地 (註冊訂用帳戶,以取得詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ) 。 另一種設定目的地的方法僅適用於具有其計費帳戶全域系統管理員之 Microsoft 合作夥伴合約 方案的合作夥伴。 這些合作夥伴可以指定記憶體帳戶名稱以及帳戶的 SAS 令牌,而不是指定記憶體帳戶的 resourceId。 這允許將成本匯出至任何租使用者中的記憶體帳戶。 您應該使用 Service/Container/Object 資源類型和讀取/寫入/刪除/清單/新增/建立許可權來為 Blob 服務建立 SAS 令牌 (,以取得詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ) 。
名稱 | 類型 | Description |
---|---|---|
container |
string |
將上傳導出的容器名稱。 如果容器不存在,則會建立它。 |
resourceId |
string |
將傳遞導出之記憶體帳戶的資源標識碼。 如果指定 sasToken 和 storageAccount,則不需要這樣做。 |
rootFolderPath |
string |
將上傳導出的目錄名稱。 |
sasToken |
string |
記憶體帳戶的SAS令牌。 針對一組受限的 Azure 客戶,您可以指定此集合與 storageAccount,而不是 resourceId。 注意:這個屬性的 API 傳回的值一律會模糊化。 傳回這個相同的模糊值不會造成 SAS 令牌更新。 若要更新此值,必須指定新的SAS令牌。 |
storageAccount |
string |
將上傳導出的記憶體帳戶。 對於一組受限的 Azure 客戶,您可以指定 sasToken,而不是 resourceId。 |
ExportDeliveryInfo
與導出相關聯的傳遞資訊。
名稱 | 類型 | Description |
---|---|---|
destination |
具有要傳遞之導出的目的地。 |
ExportExecutionListResult
列出導出的執行歷程記錄的結果。
名稱 | 類型 | Description |
---|---|---|
value |
匯出執行的清單。 |
ExportRun
匯出執行。
名稱 | 類型 | Description |
---|---|---|
eTag |
string |
資源的 eTag。 若要處理並行更新案例,此字段將用來判斷使用者是否要更新最新版本。 |
id |
string |
資源標識碼。 |
name |
string |
資源名稱。 |
properties.error |
任何錯誤的詳細數據。 |
|
properties.executionType |
匯出執行的型別。 |
|
properties.fileName |
string |
匯出檔案的名稱。 |
properties.processingEndTime |
string |
匯出執行完成的時間。 |
properties.processingStartTime |
string |
匯出開始執行的時間。 |
properties.runSettings |
此執行生效的導出設定。 |
|
properties.status |
匯出執行的最後一個已知狀態。 |
|
properties.submittedBy |
string |
觸發匯出之實體的標識碼。 針對隨選執行,它是用戶電子郵件。 針對排程的執行,其為 「系統」。 |
properties.submittedTime |
string |
匯出排入佇列以執行的時間。 |
type |
string |
資源類型。 |
ExportTimePeriod
匯出中數據的日期範圍。 這應該只指定 timeFrame 設定為 『Custom』。 日期範圍上限為 3 個月。
名稱 | 類型 | Description |
---|---|---|
from |
string |
匯出數據的開始日期。 |
to |
string |
匯出數據的結束日期。 |
ExportType
匯出的類型。 請注意,『Usage』 相當於 『ActualCost』,而且適用於尚未針對服務保留提供費用或分攤數據的匯出。
名稱 | 類型 | Description |
---|---|---|
ActualCost |
string |
|
AmortizedCost |
string |
|
Usage |
string |
FormatType
要傳遞的導出格式。 目前僅支援 『Csv』。
名稱 | 類型 | Description |
---|---|---|
Csv |
string |
GranularityType
匯出中數據列的數據粒度。 目前僅支援 「每日」。
名稱 | 類型 | Description |
---|---|---|
Daily |
string |
TimeframeType
提取匯出數據的時間範圍。 如果為自定義,則必須提供特定的時間週期。
名稱 | 類型 | Description |
---|---|---|
BillingMonthToDate |
string |
|
Custom |
string |
|
MonthToDate |
string |
|
TheLastBillingMonth |
string |
|
TheLastMonth |
string |
|
WeekToDate |
string |