Generate Cost Details Report - Create Operation

  • リファレンス
Service:
Cost Management
API Version:
2023-11-01

この API は、以前にリリースされたすべての Usage Details API に代わるものです。 特定のスコープで、指定された日付範囲、請求期間 (エンタープライズ顧客のみ) または請求書 ID のコスト詳細レポートを非同期的に生成するように要求します。 レポートを要求する最初の呼び出しでは、'Location' ヘッダーと 'Retry-After' ヘッダーを含む 202 が返されます。 "Location" ヘッダーは、レポート生成の結果を取得するためにポーリングするエンドポイントを提供します。 "Retry-After" は、生成されたレポートのポーリング前に待機する期間を提供します。 レポート操作をポーリングする呼び出しでは、操作がまだ進行中の場合は、"Location" ヘッダーを含む 202 応答が提供されます。 レポート生成操作が完了すると、ポーリング エンドポイントは、ダウンロード可能なレポート BLOB の詳細と共に 200 応答を提供します。 ダウンロード可能なファイルの詳細は、ポーリング応答本文で確認できます。 ファイルで見つかったコストの詳細 (旧称使用状況の詳細) フィールドを理解するには、次を参照してください。 https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

URI パラメーター

名前 / 必須 型 説明
scope
 path True

string

サブスクリプション、課金アカウント、またはその他の課金スコープの ARM リソース ID。現在、リソース グループと管理グループはサポートされていません。 詳細については、「https://aka.ms/costmgmt/scopes」を参照してください。
api-version
 query True

string

この操作に使用する API バージョン。

要求本文

名前 型 説明
billingPeriod

string

このパラメーターは、Enterprise Agreement のお客様のみが使用できます。 YearMonth(例: 202008) 形式を使用します。 このパラメーターは、invoiceId パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。
invoiceId

string

このパラメーターは、Microsoft 顧客契約のお客様のみが使用できます。 さらに、課金プロファイルまたは顧客スコープでのみ使用できます。 このパラメーターは、billingPeriod パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。
metric

CostDetailsMetricType

詳細レポートの種類。 既定では ActualCost が提供されます
timePeriod

CostDetailsTimePeriod

レポートに対して要求されたコストの詳細の特定の日付範囲。 このパラメーターは、invoiceId パラメーターまたは billingPeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。 API では、1 か月以下のデータのみをプルでき、13 か月以下のデータをプルできます。 timePeriod または billingPeriod または invoiceId が指定されていない場合、API は既定でオープン月の期間に設定されます

応答

名前 型 説明
200 OK

CostDetailsOperationResults

要求処理が完了しました。
202 Accepted

受理されました。 要求が処理されます。 Location ヘッダーを使用して、状態をチェックします。

Headers

  • Location: string
  • Retry-After: integer
204 No Content

コンテンツなし。 要求は成功しましたが、結果は返されていません。
Other Status Codes

GenerateCostDetailsReportErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "billingPeriod": "202205"
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345/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": "providers/Microsoft.Billing/billingAccounts/12345",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceId

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567"
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/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": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567"
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/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": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByCustomerAndTimePeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/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": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByDepartmentsAndTimePeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/departments/12345/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": "providers/Microsoft.Billing/departments/12345",
      "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/enrollmentAccounts/1234/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": "providers/Microsoft.Billing/enrollmentAccounts/1234",
      "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportBySubscriptionAndTimePeriod

Sample Request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
200 
{
  "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"
}
Status code:
202 
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
Status code:
204

定義

名前 説明
BlobInfo

この操作によって生成された BLOB 情報。
CostDetailsDataFormat

レポートのデータ形式
CostDetailsMetricType

詳細レポートの種類。 既定では ActualCost が提供されます
CostDetailsOperationResults

コスト詳細 Api の実行時間の長い操作の結果。
CostDetailsStatusType

コスト詳細操作の状態
CostDetailsTimePeriod

コスト詳細レポートのデータをプルするための開始日と終了日。 API では、1 か月以下のデータのみをプルでき、13 か月以下のデータをプルできます。
ErrorDetails

エラーの詳細。
GenerateCostDetailsReportErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

いくつかのエラー応答:

  • 400 無効な要求 - 要求ペイロードが無効です。 指定された要求ペイロードが json 形式ではないか、要求ペイロードで無効なメンバーが受け入れられない。

  • 400 無効な要求 - 無効な要求ペイロード: timePeriod または invoiceId または billingPeriod のみを持つことができます。 API では、timePeriod または invoiceId または billingPeriod のデータのみをプルできます。 お客様は、これらのパラメーターの 1 つだけを指定する必要があります。

  • 400 無効な要求 - 開始日は の後にする必要があります。 API では、13 か月以上前にデータをプルすることはできません。

  • 400 Bad Request - 許容される最大日付範囲は 1 か月です。 API では、1 か月以下のデータのみをプルできます。

  • 429 TooManyRequests - 要求が調整されました。 "retry-after" ヘッダーで指定された時間を待ってから再試行します。

  • 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。
GenerateCostDetailsReportRequestDefinition

コスト詳細レポートの定義。

BlobInfo

この操作によって生成された BLOB 情報。

名前 型 説明
blobLink

string

BLOB にリンクしてファイルをダウンロードします。
byteCount

integer

BLOB 内のバイト数。

CostDetailsDataFormat

レポートのデータ形式

名前 型 説明
Csv

string

Csv データ形式。

CostDetailsMetricType

詳細レポートの種類。 既定では ActualCost が提供されます

名前 型 説明
ActualCost

string

実績コスト データ。
AmortizedCost

string

償却コスト データ。

CostDetailsOperationResults

コスト詳細 Api の実行時間の長い操作の結果。

名前 型 説明
error

ErrorDetails

エラーの詳細。
id

string

実行時間の長い操作の ID。
manifest.blobCount

integer

BLOB の合計数。
manifest.blobs

BlobInfo[]

この操作によって生成された BLOB 情報の一覧。
manifest.byteCount

integer

すべての BLOB の合計バイト数。
manifest.compressData

boolean

圧縮形式のデータです。
manifest.dataFormat

CostDetailsDataFormat

レポートのデータ形式
manifest.manifestVersion

string

マニフェストのバージョン。
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

Cost Details 呼び出しで提供される要求ペイロード本文
manifest.requestContext.requestScope

string

要求の要求スコープ。
name

string

実行時間の長い操作の名前。
status

CostDetailsStatusType

コスト詳細操作の状態
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

操作が失敗した理由を示すエラー メッセージ。

GenerateCostDetailsReportErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

いくつかのエラー応答:

  • 400 無効な要求 - 要求ペイロードが無効です。 指定された要求ペイロードが json 形式ではないか、要求ペイロードで無効なメンバーが受け入れられない。

  • 400 無効な要求 - 無効な要求ペイロード: timePeriod または invoiceId または billingPeriod のみを持つことができます。 API では、timePeriod または invoiceId または billingPeriod のデータのみをプルできます。 お客様は、これらのパラメーターの 1 つだけを指定する必要があります。

  • 400 無効な要求 - 開始日は の後にする必要があります。 API では、13 か月以上前にデータをプルすることはできません。

  • 400 Bad Request - 許容される最大日付範囲は 1 か月です。 API では、1 か月以下のデータのみをプルできます。

  • 429 TooManyRequests - 要求が調整されました。 "retry-after" ヘッダーで指定された時間を待ってから再試行します。

  • 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。

名前 型 説明
error

ErrorDetails

エラーの詳細。

GenerateCostDetailsReportRequestDefinition

コスト詳細レポートの定義。

名前 型 説明
billingPeriod

string

このパラメーターは、Enterprise Agreement のお客様のみが使用できます。 YearMonth(例: 202008) 形式を使用します。 このパラメーターは、invoiceId パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。
invoiceId

string

このパラメーターは、Microsoft 顧客契約のお客様のみが使用できます。 さらに、課金プロファイルまたは顧客スコープでのみ使用できます。 このパラメーターは、billingPeriod パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。
metric

CostDetailsMetricType

詳細レポートの種類。 既定では ActualCost が提供されます
timePeriod

CostDetailsTimePeriod

レポートに対して要求されたコストの詳細の特定の日付範囲。 このパラメーターは、invoiceId パラメーターまたは billingPeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。 API では、1 か月以下のデータのみをプルでき、13 か月以下のデータをプルできます。 timePeriod または billingPeriod または invoiceId が指定されていない場合、API は既定でオープン月の期間に設定されます