Generate Cost Details Report - Get Operation Results
指定した操作の結果を取得します。 このリンクは、CostDetails 作成要求応答の場所ヘッダーで提供されます。
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}?api-version=2023-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
operation
|
path | True |
string |
ターゲット操作 ID。 |
scope
|
path | True |
string |
サブスクリプション、課金アカウント、またはその他の課金スコープの ARM リソース ID。現在、リソース グループと管理グループはサポートされていません。 詳細については、「https://aka.ms/costmgmt/scopes」を参照してください。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK です。 要求は成功しました。 |
|
202 Accepted |
受理されました。 操作は進行中です。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Get details of the operation result
要求のサンプル
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
応答のサンプル
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
定義
名前 | 説明 |
---|---|
Blob |
この操作によって生成された BLOB 情報。 |
Cost |
レポートのデータ形式 |
Cost |
詳細レポートの種類。 既定では ActualCost が提供されます |
Cost |
コスト詳細 Api の実行時間の長い操作の結果。 |
Cost |
コスト詳細操作の状態 |
Cost |
コスト詳細レポートのデータをプルするための開始日と終了日。 API では、1 か月以下のデータのみをプルでき、13 か月以下のデータをプルできます。 |
Error |
エラーの詳細。 |
Error |
エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。 いくつかのエラー応答:
|
Generate |
コスト詳細レポートの定義。 |
BlobInfo
この操作によって生成された BLOB 情報。
名前 | 型 | 説明 |
---|---|---|
blobLink |
string |
BLOB にリンクしてファイルをダウンロードします。 |
byteCount |
integer |
BLOB 内のバイト数。 |
CostDetailsDataFormat
レポートのデータ形式
名前 | 型 | 説明 |
---|---|---|
Csv |
string |
Csv データ形式。 |
CostDetailsMetricType
詳細レポートの種類。 既定では ActualCost が提供されます
名前 | 型 | 説明 |
---|---|---|
ActualCost |
string |
実績コスト データ。 |
AmortizedCost |
string |
償却コスト データ。 |
CostDetailsOperationResults
コスト詳細 Api の実行時間の長い操作の結果。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細。 |
|
id |
string |
実行時間の長い操作の ID。 |
manifest.blobCount |
integer |
BLOB の合計数。 |
manifest.blobs |
Blob |
この操作によって生成された BLOB 情報の一覧。 |
manifest.byteCount |
integer |
すべての BLOB の合計バイト数。 |
manifest.compressData |
boolean |
圧縮形式のデータです。 |
manifest.dataFormat |
レポートのデータ形式 |
|
manifest.manifestVersion |
string |
マニフェストのバージョン。 |
manifest.requestContext.requestBody |
Cost Details 呼び出しで提供される要求ペイロード本文 |
|
manifest.requestContext.requestScope |
string |
要求の要求スコープ。 |
name |
string |
実行時間の長い操作の名前。 |
status |
コスト詳細操作の状態 |
|
type |
string |
実行時間の長い操作の種類。 |
validTill |
string |
レポート URL が無効になるか、UTC で期限切れになる時刻 (例: 2020-12-08T05:55:59.4394737Z)。 |
CostDetailsStatusType
コスト詳細操作の状態
名前 | 型 | 説明 |
---|---|---|
Completed |
string |
操作は完了です。 |
Failed |
string |
操作に失敗しました。 |
NoDataFound |
string |
操作が完了し、コスト データが見つかりません。 |
CostDetailsTimePeriod
コスト詳細レポートのデータをプルするための開始日と終了日。 API では、1 か月以下のデータのみをプルでき、13 か月以下のデータをプルできます。
名前 | 型 | 説明 |
---|---|---|
end |
string |
データをプルする終了日。形式 2020-03-15 の例 |
start |
string |
データをプルする開始日。 形式 2020-03-15 の例 |
ErrorDetails
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
操作が失敗した理由を示すエラー メッセージ。 |
ErrorResponse
エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。
いくつかのエラー応答:
429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。
503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細。 |
GenerateCostDetailsReportRequestDefinition
コスト詳細レポートの定義。
名前 | 型 | 説明 |
---|---|---|
billingPeriod |
string |
このパラメーターは、Enterprise Agreement のお客様のみが使用できます。 YearMonth(例: 202008) 形式を使用します。 このパラメーターは、invoiceId パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。 |
invoiceId |
string |
このパラメーターは、Microsoft 顧客契約のお客様のみが使用できます。 さらに、課金プロファイルまたは顧客スコープでのみ使用できます。 このパラメーターは、billingPeriod パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。 |
metric |
詳細レポートの種類。 既定では ActualCost が提供されます |
|
timePeriod |
レポートに対して要求されたコストの詳細の特定の日付範囲。 このパラメーターは、invoiceId パラメーターまたは billingPeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。 API では、1 か月以下のデータのみをプルでき、13 か月以下のデータをプルできます。 timePeriod または billingPeriod または invoiceId が指定されていない場合、API は既定でオープン月の期間に設定されます |