Azure レポート API は Azure コストの確認や管理に役立ちます。
フィルターを使用すると、ニーズに合わせて結果をカスタマイズできます。
ここでは、REST API を使用して、特定の日付範囲のサブスクリプションの課金詳細情報を返す方法を説明します。
GET https://management.azure.com/subscriptions/${subscriptionID}/providers/Microsoft.Billing/billingPeriods/${billingPeriod}/providers/Microsoft.Consumption/usageDetails?$filter=properties/usageEnd ge '${startDate}' AND properties/usageEnd le '${endDate}'
Content-Type: application/json
Authorization: Bearer
要求を作成する
{subscriptionID} パラメーターが必須です。これでターゲット サブスクリプションを指定します。
{billingPeriod} パラメーターは必須であり、現在の請求期間を指定します。 billingPeriod パラメーターはダッシュなしの形式にする必要があります。 たとえば、「 202112 」のように入力します。 月の日付を billingPeriod に追加しても無視されます。
この例では ${startDate} パラメーターおよび ${endDate} パラメーターが必須ですが、エンドポイントでは省略可能です。 日付範囲を文字列として YYYY-MM-DD の形式で指定します。 たとえば、2018-05-01 や 2018-06-15す。 startDate と endDate にはダッシュが必要です。
次のヘッダーは必須です｡
| 要求ヘッダー | 説明 |
|---|---|
| Content-Type: | 必須。
application/json を設定します。 |
| Authorization: | 必須。 有効な Bearerアクセス トークンを設定します。 |
Response
応答に成功すると､状態コード 200 (OK) が返されます｡内容は､アカウントの詳しいコストの一覧です｡
{
"value": [
{
"id": "/subscriptions/{$subscriptionID}/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/{$detailsID}",
"name": "{$detailsID}",
"type": "Microsoft.Consumption/usageDetails",
"properties": {
"billingPeriodId": "/subscriptions/${subscriptionID}/providers/Microsoft.Billing/billingPeriods/${billingPeriod}",
"invoiceId": "/subscriptions/${subscriptionID}/providers/Microsoft.Billing/invoices/${invoiceID}",
"usageStart": "${startDate}}",
"usageEnd": "${endDate}",
"currency": "USD",
"usageQuantity": "${usageQuantity}",
"billableQuantity": "${billableQuantity}",
"pretaxCost": "${cost}",
"meterId": "${meterID}",
"meterDetails": "${meterDetails}"
}
}
],
"nextLink": "${nextLinkURL}"
}
value の各項目は、サービスの使用状況に案する詳細を表します。
| Response プロパティ | 説明 |
|---|---|
| subscriptionGuid | サブスクリプションのグローバルに一意の ID。 |
| startDate | 使用開始の日付。 |
| endDate | 使用終了の日付。 |
| usageQuantity | 使用量。 |
| billableQuantity | 実際に課金される量。 |
| pretaxCost | 請求額 (外税)。 |
| meterDetails | 使用に関する詳細情報。 |
| nextLink | 設定時には、詳細の次のページの URL が指定されます。 ページが最終ページの場合は空白です。 |
この例は省略されたものです。response の各フィールドの詳しい説明については、使用状況の詳細の一覧をご覧ください。
その他の状態コードは､エラー状態を示します｡ そのような場合､response オブジェクトによって､要求が失敗した理由が説明されます。
{
"error": [
{
"code": "Error type.",
"message": "Error response describing why the operation failed."
}
]
}