Azure Consumption API の概要Azure consumption API overview

Azure Consumption API シリーズを使用すると、Azure リソースのコストおよび使用状況データにプログラムでアクセスできます。The Azure Consumption APIs give you programmatic access to cost and usage data for your Azure resources. これらの API は、現在、Enterprise 加入契約と Web Direct サブスクリプションのみをサポートしています (いくつかの例外があります)。These APIs currently only support Enterprise Enrollments and Web Direct Subscriptions (with a few exceptions). API は、他の種類の Azure サブスクリプションをサポートするために継続的に更新されます。The APIs are continually updated to support other types of Azure subscriptions.

Azure Consumption API シリーズでは、以下にアクセスできます。Azure Consumption APIs provide access to:

  • Enterprise および Web Direct のお客様Enterprise and Web Direct Customers
    • Usage DetailsUsage Details
    • Marketplace ChargesMarketplace Charges
    • Reservation RecommendationsReservation Recommendations
    • Reservation DetailsReservation Details
    • Reservation SummariesReservation Summaries
  • Enterprise のお客様のみEnterprise Customers Only
    • Price SheetPrice sheet
    • BudgetsBudgets
    • BalancesBalances

Usage Details APIUsage Details API

Usage Details API を使用して、すべての Azure ファースト パーティ リソースの料金および使用状況データを取得します。Use the Usage Details API to get charge and usage data for all Azure 1st party resources. 情報は、現在 1 日あたりリソースあたり測定あたり 1 回発行される使用状況詳細レコード形式で提供されます。Information is in the form of usage detail records which are currently emitted once per meter per resource per day. この情報を使用すると、すべてのリソースのコストを合算したり、特定のリソースのコスト/使用状況を調査したりすることができます。Information can be used to add up the costs across all resources or investigate costs / usage on specific resource(s).

この API には次の要素が含まれています。The API includes:

  • 測定レベルの消費データ - 使用コスト、料金の元となる測定、および料金が関係する Azure リソースを含むデータを表示します。Meter Level Consumption Data - See data including usage cost, the meter emitting the charge, and what Azure resource the charge pertains to. すべての使用状況詳細レコードは、日単位のバケットにマップされます。All usage detail records map to a daily bucket.
  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • フィルタリング - 次のフィルターを使用して、API 結果セットをより小さな使用状況詳細レコードのセットにトリミングします。Filtering - Trim your API result set down to a smaller set of usage detail records using the following filters: - 使用終了/使用開始Usage end / usage start - リソース グループResource Group - リソース名Resource Name
  • データ集計 - OData を使用して式を適用して、タグまたはフィルター プロパティで使用状況詳細を集計しますData Aggregation - Use OData to apply expressions to aggregate usage details by tags or filter properties
  • 別の種類のオファーの使用状況 - 使用状況詳細情報は、現在、Enterprise および Web Direct のお客様が利用できます。Usage for different offer types - Usage detail information is currently available for Enterprise and Web Direct customers.

詳細については、Usage Details API の技術仕様を参照してください。For more information, see the technical specification for the Usage Details API.

Marketplace Charges APIMarketplace Charges API

Marketplace Charges API を使用して、Marketplace のすべてのリソース (Azure サード パーティ製ソリューション) に関する料金および使用状況データを取得します。Use the Marketplace Charges API to get charge and usage data on all Marketplace resources (Azure 3rd party offerings). このデータを使用すると、すべての Marketplace リソースのコストを合算したり、特定のリソースのコスト/使用状況を調査したりすることができます。This data can be used to add up costs across all Marketplace resources or investigate costs / usage on specific resource(s).

この API には次の要素が含まれています。The API includes:

  • 測定レベルの消費データ - マーケットプレースの使用コスト、料金の元となる測定、および料金が関係するリソースを含むデータを表示します。Meter Level Consumption Data - See data including marketplace usage cost, the meter emitting the charge, and what resource the charge pertains to. すべての使用状況詳細レコードは、日単位のバケットにマップされます。All usage detail records map to a daily bucket.
  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • フィルタリング - 次のフィルターを使用して、API 結果セットをより小さなマーケットプレース レコードのセットにトリミングします。Filtering - Trim your API result set down to a smaller set of marketplace records using the following filters: - 使用開始/使用終了Usage start / usage end - リソース グループResource Group - リソース名Resource Name
  • 別の種類のオファーの使用状況 - Marketplace 情報は、現在、Enterprise および Web Direct のお客様が利用できます。Usage for different offer types - Marketplace information is currently available for Enterprise and Web Direct customers.

詳細については、Marketplace Charges API の技術仕様を参照してください。For more information, see the technical specification for the Marketplace Charges API.

Balances APIBalances API

Enterprise のお客様は、Balances API を使用して、残高、新規購入、Azure Marketplace サービス料金、調整、および超過料金に関する情報の月別サマリーを取得できます。Enterprise customers can use the Balances API to get a monthly summary of information on balances, new purchases, Azure Marketplace service charges, adjustments, and overage charges. この情報は、現在の請求期間または過去の任意の期間について取得できます。You can get this information for the current billing period or any period in the past. 企業はこのデータを使用して、手動で計算された集計料金との比較を実行することができます。Enterprises can use this data to perform a comparison with manually calculated summary charges. この API では、リソースに固有の情報およびコストの集計ビューは提供されません。This API does not provide resource-specific information and an aggregate view of costs.

この API には次の要素が含まれています。The API includes:

  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Enterprise のお客様のみ - この API は、EA のお客様のみが使用できます。Enterprise Customers Only This API is only available EA customers. - この API を呼び出すには、エンタープライズ管理者のアクセス許可が必要ですCustomers must have Enterprise Admin permissions to call this API

詳細については、Balances API の技術仕様を参照してください。For more information, see the technical specification for the Balances API.

Budgets APIBudgets API

Enterprise のお客様は、この API を使用して、リソース、リソース グループ、または課金測定のコストまたは使用予算を作成できます。Enterprise customers can use this API to create either cost or usage budgets for resources, resource groups, or billing meters. この情報が決定された後は、ユーザーが定義した予算のしきい値を超えたときに通知するよう警告を構成できます。Once this information has been determined, alerting can be configured to notify when user-defined budget thresholds are exceeded.

この API には次の要素が含まれています。The API includes:

  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Enterprise のお客様のみ - この API は、EA のお客様のみが使用できます。Enterprise Customers Only - This API is only available EA customers.
  • 構成可能な通知 - 予算に達したときに通知されるユーザーを指定します。Configurable Notifications - Specify user(s) to be notified when the budget is tripped.
  • 使用状況またはコストベースの予算 - シナリオでの必要性に応じて消費またはコストのいずれかに基づいて予算を作成します。Usage or Cost Based Budgets - Create your budget based on either consumption or cost as needed by your scenario.
  • フィルタリング - 次の構成可能なフィルターを使用して、予算をより小さなリソースのサブセットにフィルター処理しますFiltering - Filter your budget to a smaller subset of resources using the following configurable filters - リソース グループResource Group - リソース名Resource Name - 測定Meter
  • 構成可能な予算期間 - 予算をリセットする頻度と予算の有効期間を指定します。Configurable budget time periods - Specify how often the budget should reset and how long the budget is valid for.

詳細については、Budgets API の技術仕様を参照してください。For more information, see the technical specification for the Budgets API.

Reservation Recommendations APIReservation Recommendations API

この API を使用して、予約 VM インスタンスの購入に関する推奨事項を取得します。Use this API to get recommendations for purchasing Reserved VM Instances. 推奨事項は、お客様が予想されるコスト削減と購入額を分析できるように設計されています。Recommendations are designed to allows customers to analyze expected cost savings and purchase amounts.

この API には次の要素が含まれています。The API includes:

  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • フィルタリング - 次のフィルターを使用して、推奨の結果を調整します。Filtering - Tailor your recommendation results using the following filters: - スコープScope - ルックバック期間Lookback period
  • 別の種類のオファーの予約情報 - 予約情報は、現在、Enterprise および Web Direct のお客様が利用できます。Reservation info for different offer types - Reservation information is currently available for Enterprise and Web Direct customers.

詳細については、Reservation Recommendations API の技術仕様を参照してください。For more information, see the technical specification for the Reservation Recommendations API.

Reservation Details APIReservation Details API

Reservation Details API を使用して、予約された消費と実際に使用された量の比較など、以前に購入した VM 予約に関する情報を表示します。Use the Reservation Details API to see info on previously purchased VM reservations such as how much consumption has been reserved versus how much is actually being used. データは、VM 単位の詳細度で表示することができます。You can see data at a per VM level detail.

この API には次の要素が含まれています。The API includes:

  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • フィルタリング - 次のフィルターを使用して、API 結果セットをより小さな予約のセットにトリミングします。Filtering - Trim your API result set down to a smaller set of reservations using the following filter: - 期間Date range
  • 別の種類のオファーの予約情報 - 予約情報は、現在、Enterprise および Web Direct のお客様が利用できます。Reservation info for different offer types - Reservation information is currently available for Enterprise and Web Direct customers.

詳細については、Reservation Details API の技術仕様を参照してください。For more information, see the technical specification for the Reservation Details API.

Reservation Summaries APIReservation Summaries API

この API を使用して、予約された消費と実際に使用された合計の量の比較など、以前に購入した VM 予約に関する集計情報を表示します。Use this API to see aggregate information on previously purchased VM reservations such as how much consumption has been reserved versus how much is actually being used in the aggregate.

この API には次の要素が含まれています。The API includes:

  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • フィルタリング - 次のフィルターを使用して、日単位の粒度を使用する場合の結果を調整します。Filtering - Tailor your results when using the daily grain with the following filter: - 使用日Usage Date
  • 別の種類のオファーの予約情報 - 予約情報は、現在、Enterprise および Web Direct のお客様が利用できます。Reservation info for different offer types - Reservation information is currently available for Enterprise and Web Direct customers.
  • 日単位または月単位の集計 - 呼び出し元は、予約概要データの粒度として日単位または月単位を指定することができます。Daily or monthly aggregations – Callers can specify whether they want their reservation summary data in the daily or monthly grain.

詳細については、Reservation Summaries API の技術仕様を参照してください。For more information, see the technical specification for the Reservation Summaries API.

Price Sheet APIPrice Sheet API

Enterprise のお客様は、この API を使用して、すべての測定のカスタム価格を取得できます。Enterprise customer can use this API to retrieve their custom pricing for all meters. 企業は、これを使用状況の詳細とマーケットプレースの使用状況情報と共に使用して、使用状況およびマーケットプレース データを使用してコストの計算を実行することができます。Enterprises can use this in combination with usage details and marketplaces usage info to perform cost calculations using usage and marketplace data.

この API には次の要素が含まれています。The API includes:

  • Azure ロールベースのアクセス制御 (Azure RBAC) - Azure portalAzure CLI、または Azure PowerShell コマンドレットを使用して、アクセス ポリシーを構成し、サブスクリプションの使用状況データにアクセスできるユーザーやアプリケーションを指定できます。Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. 呼び出し元は、認証に Azure Active Directory トークンを使用する必要があります。Callers must use standard Azure Active Directory tokens for authentication. また、呼び出し元が特定の Azure サブスクリプションの使用状況データにアクセスするには、請求閲覧者、閲覧者、所有者、共同作成者のいずれかのロールに呼び出し元を追加します。Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Enterprise のお客様のみ - この API は、EA のお客様のみが使用できます。Enterprise Customers Only - This API is only available EA customers. Web Direct のお客様は、RateCard API を使用して価格を取得する必要があります。Web Direct customers should use the RateCard API to get pricing.

詳細については、Price Sheet API の技術仕様を参照してください。For more information, see the technical specification for the Price Sheet API.

シナリオScenarios

Consumption API シリーズを使用して可能になるシナリオのいくつかを次に示します。Here are some of the scenarios that are made possible via the consumption APIs:

  • 請求書の調整 - Microsoft からの請求金額が正しいか。Invoice Reconciliation - Did Microsoft charge me the right amount? 請求書の内容はどうなっているか。自分で料金を計算できるか。What is my bill and can I calculate it myself?
  • クロス請求 - 請求金額がわかったところで、組織の誰がその料金を支払う必要があるか。Cross Charges - Now that I know how much I'm being charged, who in my org needs to pay?
  • コストの最適化 - 請求金額がわかったところで、Cost Optimization - I know how much I've been charged… Azure に関する支出からどのように利益を得ることができるか。how can I get more out of the money I am spending on Azure?
  • コスト管理 - Azure に関する支出と使用状況を時間の経過に沿って確認したい。Cost Tracking - I want to see how much I am spending and using Azure over time. どのような傾向があるか。What are the trends? どのようにすればよりうまくできるか。How could I be doing better?
  • Azure の月間の支出 - 当月の今日までの支出はいくらか。Azure spend during the month - How much is my current month's spend to date? Azure に関する支出と使用状況に何か調整を加える必要があるか。Do I need to make any adjustments in my spending and/or usage of Azure? Azure を最も消費しているのは月内のいつか。When during the month am I consuming Azure the most?
  • 警告の設定 - 予算に基づいてリソースベースの消費または通貨ベースの警告を設定したい。Set up alerts - I would like to set up resource-based consumption or monetary-based alerting based on a budget.

次の手順Next Steps

  • REST API を使用してすべての Azure サービスの価格を取得する方法については、「Azure 小売価格の概要」を参照してください。For information about using REST APIs retrieve prices for all Azure services, see Azure Retail Prices overview.