New-AzCostManagementDetailReport
この API は、以前にリリースされたすべての Usage Details API に代わるものです。 指定された日付範囲、請求期間 (エンタープライズ顧客のみ) または請求書 ID のコスト詳細レポートを特定のスコープで非同期的に生成するように要求します。 レポートを要求する最初の呼び出しでは、"Location" ヘッダーと "Retry-After" ヘッダーを含む 202 が返されます。 "Location" ヘッダーは、レポート生成の結果を取得するためにポーリングするエンドポイントを提供します。 "Retry-After" は、生成されたレポートをポーリングするまでの待機時間を提供します。 レポート操作をポーリングする呼び出しでは、操作がまだ進行中の場合は、"Location" ヘッダーを含む 202 応答が提供されます。 レポート生成操作が完了すると、ポーリング エンドポイントは、ダウンロード可能なレポート BLOB の詳細と共に 200 応答を提供します。 ダウンロード可能なファイルの詳細については、ポーリング応答本文で確認できます。
構文
New-AzCostManagementDetailReport
-Scope <String>
[-BillingPeriod <String>]
[-InvoiceId <String>]
[-Metric <CostDetailsMetricType>]
[-TimePeriodEnd <String>]
[-TimePeriodStart <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
この API は、以前にリリースされたすべての Usage Details API に代わるものです。 指定された日付範囲、請求期間 (エンタープライズ顧客のみ) または請求書 ID のコスト詳細レポートを特定のスコープで非同期的に生成するように要求します。 レポートを要求する最初の呼び出しでは、"Location" ヘッダーと "Retry-After" ヘッダーを含む 202 が返されます。 "Location" ヘッダーは、レポート生成の結果を取得するためにポーリングするエンドポイントを提供します。 "Retry-After" は、生成されたレポートをポーリングするまでの待機時間を提供します。 レポート操作をポーリングする呼び出しでは、操作がまだ進行中の場合は、"Location" ヘッダーを含む 202 応答が提供されます。 レポート生成操作が完了すると、ポーリング エンドポイントは、ダウンロード可能なレポート BLOB の詳細と共に 200 応答を提供します。 ダウンロード可能なファイルの詳細については、ポーリング応答本文で確認できます。
例
例 1: 指定された日付範囲、請求期間 (エンタープライズ顧客のみ) または請求書 ID に対して、特定のスコープで非同期的にコスト詳細レポートを生成するように要求する
New-AzCostManagementDetailReport -Scope "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f" -Metric 'ActualCost' -TimePeriodStart "2022-10-01" -TimePeriodEnd "2022-10-20"
このコマンドは、指定された日付範囲、請求期間 (エンタープライズ顧客のみ) または請求書 ID に対して、特定のスコープで非同期的にコスト詳細レポートを生成するように要求します。
パラメーター
-AsJob
コマンドをジョブとして実行する
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-BillingPeriod
このパラメーターは、Enterprise Agreement のお客様のみが使用できます。 YearMonth (例: 202008) 形式を使用します。 このパラメーターは、invoiceId パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
型: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InvoiceId
このパラメーターは、Microsoft 顧客契約のお客様のみが使用できます。 さらに、課金プロファイルまたは顧客スコープでのみ使用できます。 このパラメーターは、billingPeriod パラメーターまたは timePeriod パラメーターと共に使用することはできません。 要求本文に timePeriod、invoiceId、または billingPeriod パラメーターが指定されていない場合、API は現在の月のコストを返します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Metric
詳細レポートの種類。 既定では ActualCost が提供されます
型: | CostDetailsMetricType |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-NoWait
コマンドを非同期的に実行する
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Scope
使用状況の詳細操作に関連付けられているスコープ。 これには、サブスクリプション スコープの '/subscriptions/{subscriptionId}/'、課金アカウント スコープの場合は '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'、Department スコープの場合は '/providers/Microsoft.Billing/departments/{departmentId}'、EnrollmentAccount スコープの場合は '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' が含まれます。 また、Modern Commerce アカウントのスコープは、billingAccount スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' です。 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TimePeriodEnd
データをプルする終了日。形式 2020-03-15 の例
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TimePeriodStart
データをプルする開始日。 形式 2020-03-15 の例
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
出力
Azure PowerShell