共用方式為


Exports - Get

依匯出名稱取得所定義範圍導出的作業。

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2024-08-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2024-08-01&$expand={$expand}

URI 參數

名稱 位於 必要 類型 Description
exportName
path True

string

匯出名稱。

scope
path True

string

與導出作業相關聯的範圍。 這包括訂用帳戶範圍的 '/subscriptions/{subscriptionId}/' 、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 資源群組範圍、 計費帳戶範圍的 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' 和 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{EnrollmentAccount 範圍的 enrollmentAccount 範圍,'/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, billingProfile 範圍的 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'、'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfileId}/{billingProfileId}/invoiceSections/{invoiceSectionId}' 和 '/providers/Microsoft。Billing/billingAccounts/{billingAccountId}/customers/{customerId}' 特定合作夥伴。

api-version
query True

string

要用於這項作業的 API 版本。

$expand
query

string

可用來展開導出內的屬性。 目前僅支援 『runHistory』,且會傳回匯出最後 10 次執行的資訊。

回應

名稱 類型 Description
200 OK

Export

還行。 要求已成功。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ExportGetByBillingAccount
ExportGetByDepartment
ExportGetByEnrollmentAccount
ExportGetByManagementGroup
ExportGetByResourceGroup
ExportGetBySubscription

ExportGetByBillingAccount

範例要求

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-01

範例回覆

{
  "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-05-01T00:00:00Z",
        "to": "2020-05-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByDepartment

範例要求

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-01

範例回覆

{
  "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByEnrollmentAccount

範例要求

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-01

範例回覆

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2019-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByManagementGroup

範例要求

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-01

範例回覆

{
  "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "UsageDate",
            "MeterId",
            "InstanceId",
            "ResourceLocation",
            "UsageQuantity"
          ]
        }
      }
    }
  }
}

ExportGetByResourceGroup

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-01

範例回覆

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetBySubscription

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-01

範例回覆

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-06-01T00:00:00Z",
        "to": "2019-07-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

定義

名稱 Description
CommonExportProperties

導出的通用屬性。

ErrorDetails

錯誤的詳細數據。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。 錯誤訊息中會提供原因。

某些錯誤回應:

  • 429 TooManyRequests - 要求已節流。 等候 「x-ms-ratelimit-microsoft.consumption-retry-after」 標頭中指定的時間後重試。

  • 503 ServiceUnavailable - 服務暫時無法使用。 等候 「Retry-After」 標頭中指定的時間後重試。

ExecutionStatus

匯出執行的最後一個已知狀態。

ExecutionType

匯出執行的型別。

Export

匯出資源。

ExportDataset

匯出中數據的定義。

ExportDatasetConfiguration

匯出數據集組態。 允許選取匯出的數據行。 如果未提供,匯出將會包含所有可用的數據行。

ExportDefinition

匯出的定義。

ExportDeliveryDestination

這代表將傳遞成本導出的 Blob 記憶體帳戶位置。 有兩種方式可以設定目的地。 大部分客戶建議的方法是指定記憶體帳戶的 resourceId。 這需要向 Microsoft.CostManagementExports 資源提供者註冊帳戶的一次性註冊,才能讓成本管理服務存取記憶體。 在 Azure 入口網站中建立匯出時,會自動執行這項註冊,但 API 使用者可能需要明確地註冊訂用帳戶(如需詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services )。 另一種設定目的地的方式僅適用於具有Microsoft合作夥伴合約方案的合作夥伴,而合作夥伴是其計費帳戶的全域管理員。 這些合作夥伴,而不是指定記憶體帳戶的 resourceId,可以指定記憶體帳戶名稱以及帳戶的 SAS 令牌。 這可讓成本導出至任何租使用者中的記憶體帳戶。 應為具有 Service/Container/Object 資源類型的 Blob 服務建立 SAS 令牌,以及具有讀取/寫入/刪除/清單/新增/建立許可權(如需詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key )。

ExportDeliveryInfo

與導出相關聯的傳遞資訊。

ExportExecutionListResult

列出導出的執行歷程記錄結果。

ExportRecurrencePeriod

週期排程的開始和結束日期。

ExportRun

匯出執行。

ExportSchedule

與導出相關聯的排程。

ExportTimePeriod

匯出中數據的日期範圍。 這應該只指定時間框架設定為 『Custom』。 日期範圍上限為 3 個月。

ExportType

匯出的類型。 請注意,『Usage』 相當於 『ActualCost』,而且適用於尚未提供服務保留費用或攤銷數據的導出。

FormatType

要傳遞之導出的格式。 目前僅支援 『Csv』。

GranularityType

匯出中的數據列粒度。 目前僅支援「每日」。

RecurrenceType

排程週期。

StatusType

匯出排程的狀態。 如果為 「非使用中」,則會暫停導出的排程。

SystemAssignedServiceIdentity

受控服務識別(已指派系統或無)

SystemAssignedServiceIdentityType

受控服務識別的類型(已指派系統或無)。

TimeframeType

提取匯出數據的時間範圍。 如果為 custom,則必須提供特定的時間週期。

CommonExportProperties

導出的通用屬性。

名稱 類型 Description
definition

ExportDefinition

具有導出的定義。

deliveryInfo

ExportDeliveryInfo

具有導出的傳遞資訊。

format

FormatType

要傳遞之導出的格式。 目前僅支援 『Csv』。

nextRunTimeEstimate

string

如果導出具有作用中的排程,請提供下一個運行時間的估計值。

partitionData

boolean

如果設定為 true,匯出的數據將會依大小分割,並將數據放在 Blob 目錄中,以及指令清單檔。 注意:此選項目前僅適用於Microsoft客戶合約商務範圍。

runHistory

ExportExecutionListResult

如果要求,則具有匯出的最新執行歷程記錄。

ErrorDetails

錯誤的詳細數據。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤訊息,指出作業失敗的原因。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。 錯誤訊息中會提供原因。

某些錯誤回應:

  • 429 TooManyRequests - 要求已節流。 等候 「x-ms-ratelimit-microsoft.consumption-retry-after」 標頭中指定的時間後重試。

  • 503 ServiceUnavailable - 服務暫時無法使用。 等候 「Retry-After」 標頭中指定的時間後重試。

名稱 類型 Description
error

ErrorDetails

錯誤的詳細數據。

ExecutionStatus

匯出執行的最後一個已知狀態。

名稱 類型 Description
Completed

string

DataNotAvailable

string

Failed

string

InProgress

string

NewDataNotAvailable

string

Queued

string

Timeout

string

ExecutionType

匯出執行的型別。

名稱 類型 Description
OnDemand

string

Scheduled

string

Export

匯出資源。

名稱 類型 Description
eTag

string

資源的 eTag。 若要處理並行更新案例,此字段將用來判斷使用者是否要更新最新版本。

id

string

資源標識碼。

identity

SystemAssignedServiceIdentity

與 Export 相關聯的受控識別

location

string

匯出受控識別的位置。 只有在使用受控識別時才需要。

name

string

資源名稱。

properties.definition

ExportDefinition

具有導出的定義。

properties.deliveryInfo

ExportDeliveryInfo

具有導出的傳遞資訊。

properties.format

FormatType

要傳遞之導出的格式。 目前僅支援 『Csv』。

properties.nextRunTimeEstimate

string

如果導出具有作用中的排程,請提供下一個運行時間的估計值。

properties.partitionData

boolean

如果設定為 true,匯出的數據將會依大小分割,並將數據放在 Blob 目錄中,以及指令清單檔。 注意:此選項目前僅適用於Microsoft客戶合約商務範圍。

properties.runHistory

ExportExecutionListResult

如果要求,則具有匯出的最新執行歷程記錄。

properties.schedule

ExportSchedule

具有導出的排程資訊。

type

string

資源類型。

ExportDataset

匯出中數據的定義。

名稱 類型 Description
configuration

ExportDatasetConfiguration

匯出數據集組態。

granularity

GranularityType

匯出中的數據列粒度。 目前僅支援「每日」。

ExportDatasetConfiguration

匯出數據集組態。 允許選取匯出的數據行。 如果未提供,匯出將會包含所有可用的數據行。

名稱 類型 Description
columns

string[]

要包含在匯出中的數據行名稱陣列。 如果未提供,匯出將會包含所有可用的數據行。 可用的數據行可能會因客戶通道而有所不同(請參閱範例)。

ExportDefinition

匯出的定義。

名稱 類型 Description
dataSet

ExportDataset

匯出中數據的定義。

timePeriod

ExportTimePeriod

有提取匯出數據的時間週期。

timeframe

TimeframeType

提取匯出數據的時間範圍。 如果為 custom,則必須提供特定的時間週期。

type

ExportType

匯出的類型。 請注意,『Usage』 相當於 『ActualCost』,而且適用於尚未提供服務保留費用或攤銷數據的導出。

ExportDeliveryDestination

這代表將傳遞成本導出的 Blob 記憶體帳戶位置。 有兩種方式可以設定目的地。 大部分客戶建議的方法是指定記憶體帳戶的 resourceId。 這需要向 Microsoft.CostManagementExports 資源提供者註冊帳戶的一次性註冊,才能讓成本管理服務存取記憶體。 在 Azure 入口網站中建立匯出時,會自動執行這項註冊,但 API 使用者可能需要明確地註冊訂用帳戶(如需詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services )。 另一種設定目的地的方式僅適用於具有Microsoft合作夥伴合約方案的合作夥伴,而合作夥伴是其計費帳戶的全域管理員。 這些合作夥伴,而不是指定記憶體帳戶的 resourceId,可以指定記憶體帳戶名稱以及帳戶的 SAS 令牌。 這可讓成本導出至任何租使用者中的記憶體帳戶。 應為具有 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

ExportDeliveryDestination

具有要傳遞之導出的目的地。

ExportExecutionListResult

列出導出的執行歷程記錄結果。

名稱 類型 Description
value

ExportRun[]

匯出執行的清單。

ExportRecurrencePeriod

週期排程的開始和結束日期。

名稱 類型 Description
from

string

週期的開始日期。

to

string

週期的結束日期。

ExportRun

匯出執行。

名稱 類型 Description
eTag

string

資源的 eTag。 若要處理並行更新案例,此字段將用來判斷使用者是否要更新最新版本。

id

string

資源標識碼。

name

string

資源名稱。

properties.error

ErrorDetails

任何錯誤的詳細數據。

properties.executionType

ExecutionType

匯出執行的型別。

properties.fileName

string

匯出的檔名。

properties.processingEndTime

string

匯出執行完成的時間。

properties.processingStartTime

string

匯出開始執行的時間。

properties.runSettings

CommonExportProperties

此執行生效的導出設定。

properties.status

ExecutionStatus

匯出執行的最後一個已知狀態。

properties.submittedBy

string

觸發匯出之實體的標識碼。 針對隨選執行,它是用戶電子郵件。 針對排程的執行,它是「系統」。

properties.submittedTime

string

匯出排入佇列執行的時間。

type

string

資源類型。

ExportSchedule

與導出相關聯的排程。

名稱 類型 Description
recurrence

RecurrenceType

排程週期。

recurrencePeriod

ExportRecurrencePeriod

具有周期的開始和結束日期。 開始日期必須在未來。 如果存在,結束日期必須大於開始日期。

status

StatusType

匯出排程的狀態。 如果為 「非使用中」,則會暫停導出的排程。

ExportTimePeriod

匯出中數據的日期範圍。 這應該只指定時間框架設定為 『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

RecurrenceType

排程週期。

名稱 類型 Description
Annually

string

Daily

string

Monthly

string

Weekly

string

StatusType

匯出排程的狀態。 如果為 「非使用中」,則會暫停導出的排程。

名稱 類型 Description
Active

string

Inactive

string

SystemAssignedServiceIdentity

受控服務識別(已指派系統或無)

名稱 類型 Description
principalId

string

系統指派身分識別的服務主體標識碼。 此屬性只會針對系統指派的身分識別提供。

tenantId

string

系統指派身分識別的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。

type

SystemAssignedServiceIdentityType

受控服務識別的類型(已指派系統或無)。

SystemAssignedServiceIdentityType

受控服務識別的類型(已指派系統或無)。

名稱 類型 Description
None

string

SystemAssigned

string

TimeframeType

提取匯出數據的時間範圍。 如果為 custom,則必須提供特定的時間週期。

名稱 類型 Description
BillingMonthToDate

string

Custom

string

MonthToDate

string

TheLastBillingMonth

string

TheLastMonth

string

WeekToDate

string