サブスクリプションの使用状況データをメーターごとに取得するGet usage data for subscription by meter

適用対象:Applies to:

  • パートナー センターPartner Center
  • Microsoft Cloud ドイツのパートナー センターPartner Center for Microsoft Cloud Germany
  • 米国政府機関向け Microsoft Cloud のパートナー センターPartner Center for Microsoft Cloud for US Government

MeterUsageRecordリソースコレクションを使用すると、現在の請求期間中に特定の Azure サービスまたはリソースの顧客の使用状況レコードを取得できます。You can use the MeterUsageRecord resource collection to get meter usage records of a customer for specific Azure services or resources during the current billing period. このリソースコレクションは、Azure プラン全体にわたる、現在の請求サイクルにおける各メーターの集計合計を表します。This resource collection represents an aggregated total for each meter for the current billing cycle, across your entire Azure plan.

前提条件Prerequisites

  • パートナー センターの認証に関するページで説明している資格情報。Credentials as described in Partner Center authentication. このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。This scenario supports authentication with App+User credentials only.

  • 顧客 ID です (customer-tenant-id)。A customer ID (customer-tenant-id). お客様の ID がわからない場合は、パートナー センターのダッシュボードで検索できます。If you don't know the customer's ID, you can look it up in the Partner Center dashboard. パートナー センター メニューの [CSP] を選択し、 [顧客] を選択します。Select CSP from the Partner Center menu, followed by Customers. 顧客一覧からお客様を選び、 [アカウント] を選択します。Select the customer from the customer list, then select Account. お客様のアカウント ページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • サブスクリプション IDA subscription ID

この新しいルートはに相当します。これは subscriptions/{subscription-id}/usagerecords/resources 、Microsoft Azure (0145P) サブスクリプションに対してのみ機能し続けます。This new route is equivalent to subscriptions/{subscription-id}/usagerecords/resources, which will continue to function only for Microsoft Azure (MS-AZR-0145P) subscriptions. この新しいルートでは、Microsoft Azure (0145P) サブスクリプションと Azure プランの両方がサポートされます。This new route will support both Microsoft Azure (MS-AZR-0145P) subscriptions and Azure plans. Azure プランのこの情報を取得するには、この新しいルートに切り替える必要があります。In order to get this information for your Azure plan, you need to switch to this new route. 次のセクションで説明するプロパティ以外の応答は、古いルートと同じです。Other than the properties mentioned in the following sections, the response is the same as the old route.

C#C#

現在の請求期間中に特定の Azure サービスまたはリソースの顧客のメータリングされた使用状況レコードを取得するには、次のようにします。To get meter usage records of a customer for a specific Azure service or resource during the current billing period:

  1. Iaggregatepartner.customersコレクションを使用して、 ById () メソッドを呼び出します。Use your IAggregatePartner.Customers collection to call the ById() method.

  2. サブスクリプションプロパティUsageRecordsを呼び出し、次にメータープロパティを呼び出します。Call the Subscriptions property, and UsageRecords, then the Meters property. Get () または GetAsync () メソッドを呼び出して終了します。Finish by calling the Get() or GetAsync() methods.

    // IAggregatePartner partnerOperations;
    // var selectedCustomerId as string;
    // var selectedSubscriptionId as string;
    
    var usageRecords = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscriptionId).UsageRecords.Meters.Get();
    

例については、次のサンプルを参照してください。For an example, see the following sample:

REST 要求REST request

要求の構文Request syntax

認証方法Method 要求 URIRequest URI
GETGET {baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/meterusagerecords HTTP/1.1{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/meterusagerecords HTTP/1.1

URI パラメーターURI parameters

次の表に、顧客の評価された使用状況情報を取得するために必要なクエリパラメーターを示します。This table lists the required query parameters to get the customer's rated usage information.

名前Name TypeType 必須Required 説明Description
customer-tenant-idcustomer-tenant-id guidguid YY 顧客に対応する GUID。A GUID corresponding to the customer.
サブスクリプション idsubscription-id guidguid YY パートナーセンターのサブスクリプションリソースの識別子に対応する GUID。これは、Microsoft Azure (0145P) サブスクリプションまたは Azure プランを表します。A GUID corresponding to the identifier of a Partner Center subscription resource, which represents a Microsoft Azure (MS-AZR-0145P) subscription or an Azure plan. Azure プランのサブスクリプションリソースについては、このルートのサブスクリプション idとしてプラン idを指定します。For Azure plan subscription resources, provide the plan-id as the subscription-id in this route.

要求ヘッダーRequest headers

詳細については、「パートナー センター REST ヘッダー」を参照してください。For more information, see Partner Center REST headers.

[要求本文]Request body

[なし] :None.

要求の例Request example

GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/meterusagerecords HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4

REST 応答REST response

成功した場合、このメソッドは応答本文で**PagedResourceCollection <MeterUsageRecord> **リソースを返します。If successful, this method returns a PagedResourceCollection<MeterUsageRecord> resource in the response body.

応答の成功とエラーのコードResponse success and error codes

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。Each response comes with an HTTP status code that indicates success or failure and additional debugging information. このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。Use a network trace tool to read this code, the error type, and additional parameters. 完全な一覧については、「エラーコード」を参照してください。For a full list, see Error Codes.

Microsoft Azure (0145P) サブスクリプションの応答の例Response example for Microsoft Azure (MS-AZR-0145P) subscriptions

この例では、顧客が145P Azure PayGを購入しています。In this example, the customer purchased 145P Azure PayG.

Microsoft Azure (0145P) サブスクリプションをお持ちのお客様の場合、API 応答に変更はありません。For customers with a Microsoft Azure (MS-AZR-0145P) subscription, there will be no change to API response.

HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT

{
    "totalCount": 1,
    "items": [
        {
            "status": "active",
            "offerId": "MS-AZR-0145P",
            "resourceId": "11111111-F347-41B6-B02C-187B1B778A43",
            "id": "11111111-F347-41B6-B02C-187B1B778A43",
            "resourceName": "Microsoft Azure",
            "name": "Microsoft Azure",
            "totalCost": 22.861172,
            "currencyLocale": "fr-FR",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-01T23:04:41.193+00:00",
            "attributes": {
                "objectType": "SubscriptionMonthlyUsageRecord"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/{customer-tenant-id}/subscriptions/usagerecords/",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

Azure プランの REST 応答の例REST response example for Azure plan

この例では、顧客が Azure プランを購入しています。In this example, the customer purchased an Azure plan.

Azure プランをご利用のお客様には、API 応答に次のような変更が加えられています。For customers with Azure plans, there are the following changes in the API response:

  • currencyLocalecurrencyCodeに置き換えられます。currencyLocale is replaced with currencyCode
  • usdTotalCostは新しいフィールドです。usdTotalCost is a new field
HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Fri, 26 Feb 2016 20:31:45 GMT

{
    "totalCount": 4,
    "items": [
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNVX-005J-Data Transfer In (GB)",
            "meterName": "Data Transfer In",
            "category": "Bandwidth",
            "subcategory": "Bandwidth",
            "quantityUsed": 0.01129,
            "unit": "1 GB",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        },
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNVX-005J-Data Transfer Out (GB)",
            "meterName": "Data Transfer Out",
            "category": "Bandwidth",
            "subcategory": "Bandwidth",
            "quantityUsed": 0.000224,
            "unit": "1 GB",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        },
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNZ5-006G-10K Batch Write Operations",
            "meterName": "Batch Write Operations",
            "category": "Storage",
            "subcategory": "Tables",
            "quantityUsed": 0.2462,
            "unit": "10K",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        },
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNZ5-006G-Data Stored (GB/Month)",
            "meterName": "LRS Data Stored",
            "category": "Storage",
            "subcategory": "Tables",
            "quantityUsed": 0.002632,
            "unit": "1 GB/Month",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/<customer-tenant-id>/subscriptions/<subscription-id>/meterusagerecords",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}