Generate Benefit Utilization Summaries Report - Generate By Billing Profile
指定された課金アカウントと課金プロファイルの特典使用率の概要レポートの生成をトリガーします。
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
billing
|
path | True |
string |
課金アカウント ID |
billing
|
path | True |
string |
課金プロファイル ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
endDate | True |
string |
レポートで提供されるサマリー データの終了日。 |
grain | True |
集計データがレポートで提供されるグレイン。 指定できる値は 、'Daily' または 'Monthly' です。 |
|
startDate | True |
string |
レポートで提供されるサマリー データの開始日。 |
benefitId |
string |
特典使用率の概要レポートの対象となる特典 ID。 特典 ID スコープに必要です。 特典注文または課金スコープではサポートされていません。 |
|
benefitOrderId |
string |
特典の注文 ID は、特典使用率の概要レポートの対象です。 特典の注文と特典 ID のスコープに必要です。 課金スコープではサポートされていません。 |
|
billingAccountId |
string |
特典使用率の概要レポートの対象となる課金アカウント。 課金アカウントと課金プロファイルのスコープに必要です。 特典スコープではサポートされていません。 |
|
billingProfileId |
string |
課金プロファイル ID は、特典使用率の概要レポートの対象です。 課金プロファイルのスコープに必要です。 課金アカウントまたは特典スコープではサポートされていません。 |
|
kind |
要求された特典データの種類。 課金アカウントと課金プロファイルのスコープに必要です。 暗黙的であり、特典スコープで渡されません。 サポートされている値は Reservation と SavingsPlan です |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
特典使用率の概要レポートの生成の状態。 これは進行中、失敗、または完了している可能性があります。 |
|
202 Accepted |
受け入れ られる。 要求が処理されます。 location ヘッダーを使用して状態を確認します。 ヘッダー
|
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
GenerateUtilizationSummariesReportByBillingProfile
要求のサンプル
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01
{
"kind": "Reservation",
"endDate": "2022-08-31T00:00:00Z",
"startDate": "2022-06-01T00:00:00Z",
"grain": "Daily"
}
応答のサンプル
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60
{
"input": {
"grain": "Daily",
"billingAccountId": "00000000-0000-0000-0000-000000000000",
"billingProfileId": "CZSFR-SDFXC-DSDF",
"kind": "Reservation",
"endDate": "2022-08-31T00:00:00Z",
"startDate": "2022-06-01T00:00:00Z"
},
"status": "Complete",
"properties": {
"reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
"secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
"validUntil": "2022-06-12T02:56:55.5021869Z"
}
}
定義
名前 | 説明 |
---|---|
Async |
レポート URL を表すオブジェクトで、非同期レポートが生成された日付まで有効です。 |
benefit |
Reservation または SavingsPlan。 |
Benefit |
特典使用率の概要レポートの状態。 非同期特典使用率の概要要求の入力、状態、およびレポート SAS URL を提供します。 |
Benefit |
非同期特典使用率の概要要求のプロパティ。 |
Benefit |
reportUrl と secondaryReportUrl BLOB リンクの CSV ファイルは、特典使用率データの次の列で構成されます。 UtilizedPercentage は、節約プラン レポートと非データ レンガ予約に 0 になります。 データ レンガ予約の使用率は 0 になります。 |
Error |
エラーの詳細。 |
Error |
エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。 いくつかのエラー応答:
|
grain |
使用状況の粒度。 サポートされている値: 'Hourly' |
Operation |
特典使用率の概要レポートの作成の状態。 |
AsyncOperationStatusProperties
レポート URL を表すオブジェクトで、非同期レポートが生成された日付まで有効です。
名前 | 型 | 説明 |
---|---|---|
reportUrl |
非同期特典使用率の概要レポートへの SAS URL。 レポートが実行中または失敗状態の場合は空になります。 |
|
secondaryReportUrl |
プライマリ障害が発生した場合のセカンダリ ストレージの非同期特典使用率の概要レポートへの SAS URL。 レポートが実行中または失敗状態の場合は空になります。 |
|
validUntil |
string |
reportUrl で指定された SAS URL の有効期限が切れる日付。 |
benefitKind
Reservation または SavingsPlan。
名前 | 型 | 説明 |
---|---|---|
IncludedQuantity |
string |
特典は IncludedQuantity です。 |
Reservation |
string |
特典は予約です。 |
SavingsPlan |
string |
利点は SavingsPlan です。 |
BenefitUtilizationSummariesOperationStatus
特典使用率の概要レポートの状態。 非同期特典使用率の概要要求の入力、状態、およびレポート SAS URL を提供します。
名前 | 型 | 説明 |
---|---|---|
input |
特典使用率の概要レポートを作成するための入力。 |
|
properties |
非同期特典使用率の概要レポートへの SAS URL と、URL が有効になるまでの日付が含まれます。 レポートが実行中または失敗状態の場合、これらの値は空になります |
|
status |
特典使用率の概要レポートの作成の状態。 |
BenefitUtilizationSummariesRequest
非同期特典使用率の概要要求のプロパティ。
名前 | 型 | 説明 |
---|---|---|
benefitId |
string |
特典使用率の概要レポートの対象となる特典 ID。 特典 ID スコープに必要です。 特典注文または課金スコープではサポートされていません。 |
benefitOrderId |
string |
特典の注文 ID は、特典使用率の概要レポートの対象です。 特典の注文と特典 ID のスコープに必要です。 課金スコープではサポートされていません。 |
billingAccountId |
string |
特典使用率の概要レポートの対象となる課金アカウント。 課金アカウントと課金プロファイルのスコープに必要です。 特典スコープではサポートされていません。 |
billingProfileId |
string |
課金プロファイル ID は、特典使用率の概要レポートの対象です。 課金プロファイルのスコープに必要です。 課金アカウントまたは特典スコープではサポートされていません。 |
endDate |
string |
レポートで提供されるサマリー データの終了日。 |
grain |
集計データがレポートで提供されるグレイン。 指定できる値は 、'Daily' または 'Monthly' です。 |
|
kind |
要求された特典データの種類。 課金アカウントと課金プロファイルのスコープに必要です。 暗黙的であり、特典スコープで渡されません。 サポートされている値は Reservation と SavingsPlan です |
|
startDate |
string |
レポートで提供されるサマリー データの開始日。 |
BenefitUtilizationSummaryReportSchema
reportUrl と secondaryReportUrl BLOB リンクの CSV ファイルは、特典使用率データの次の列で構成されます。 UtilizedPercentage は、節約プラン レポートと非データ レンガ予約に 0 になります。 データ レンガ予約の使用率は 0 になります。
名前 | 型 | 説明 |
---|---|---|
AvgUtilizationPercentage |
string |
|
BenefitId |
string |
|
BenefitOrderId |
string |
|
BenefitType |
string |
|
Kind |
string |
|
MaxUtilizationPercentage |
string |
|
MinUtilizationPercentage |
string |
|
UsageDate |
string |
|
UtilizedPercentage |
string |
ErrorDetails
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
操作が失敗した理由を示すエラー メッセージ。 |
ErrorResponse
エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。
いくつかのエラー応答:
429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時刻を待機した後に再試行します。
503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細。 |
grain
使用状況の粒度。 サポートされている値: 'Hourly'
名前 | 型 | 説明 |
---|---|---|
Daily |
string |
時間単位のグレインは、1 日あたりの値に対応します。 |
Hourly |
string |
時間単位グレインは、1 時間あたりの値に対応します。 |
Monthly |
string |
時間単位グレインは、1 か月あたりの値に対応します。 |
OperationStatusType
特典使用率の概要レポートの作成の状態。
名前 | 型 | 説明 |
---|---|---|
Complete |
string |
|
Failed |
string |
|
Running |
string |