顧客のすべてのサブスクリプションの使用状況の概要を取得する

  • [アーティクル]

適用対象: パートナー センター | Microsoft Cloud for US Government のパートナー センター

CustomerUsageSummary リソースを使用して、現在の請求期間中に特定の Azure サービスまたはリソースの顧客の使用状況を取得できます。

Note

一般に、毎日評価された未請求の使用状況データは、24 時間後に API またはパートナー センター ポータルから入手できます。 場所やメーターが使用状況を報告するタイミングによっては、追加の遅延が発生する可能性があります。

月の初めから前月の請求済み使用状況データが配信されるまで、最新の未請求の使用状況データが表示されない場合があります。 これは、請求された使用状況データが SLA 内で効率的に配信されるようにするためです。 課金された使用状況データを受け取ったら、月の初めから更新された未請求の使用状況データの取得を開始できます。

前提条件

  • パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。

  • 顧客 ID です (customer-tenant-id)。 顧客の ID がわからない場合は、[顧客] ワークスペースを選択し、顧客の一覧から顧客を選択し、[アカウント] を選択して、パートナー センターで検索できます。 顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

C#

顧客のすべてのサブスクリプションの使用状況の概要を取得するには:

  1. ById() メソッドを 呼び出すには、IAggregatePartner.Customers コレクションを 使用 します。

  2. UsageSummary プロパティを呼び出し、その後に Get() メソッドまたは GetAsync() メソッドを呼び出します。

    // IAggregatePartner partnerOperations;
// var selectedCustomerId as string;

var usageSummary = partnerOperations.Customers.ById(selectedCustomerId).UsageSummary.Get();

例については、次を参照してください。

REST 要求

要求の構文

認証方法 要求 URI
GET {baseURL}/v1/customers/{customer-tenant-id}/usagesummary HTTP/1.1

URI パラメーター

次の表に、顧客の評価された使用状況情報を取得するために必要なクエリ パラメーターを示します。

名前 タイプ Required 説明
customer-tenant-id guid 年 顧客に対応する GUID。

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。

要求本文

なし。

要求の例

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

REST 応答

成功した場合、このメソッドは応答本文で CustomerUsageSummary リソースを返します。

応答の成功とエラーのコード

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、「エラー コード」を参照してください。

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

この例では、顧客は 145P Azure PayG オファーを購入しました。

Microsoft Azure (MS-AZR-0145P) サブスクリプションをお持ちのお客様の場合、API 応答に変更はありません。

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

{
    "budget":{
        "ammount":300.000000,
        "attributes":{
            "objectType":"SpendingBudget"
        }
    },
    "id":"65726577-C208-40FD-9735-8C85AC9CAC68",
    "name":"600 test",
    "billingStartDate":"2016-02-06T00:00:00-08:00",
    "billingEndDate":"2016-03-05T00:00:00-08:00",
    "totalCost":0.0,
    "currencyLocale":"en-US",
    "lastModifiedDate":"2016-02-26T09:42:54.5130558+00:00",
    "links":{
        "self":{
            "uri":"/customers/{customer-tenant-id}/usagesummary",
            "method":"GET",
            "headers":[]
        }
    },
    "attributes":{
        "objectType":"CustomerUsageSummary"
    }
}

Azure プランの応答の例

この例では、顧客が Azure プランを購入しました。

Azure プランをお持ちのお客様の場合、API 応答には次の変更があります。

  • currencyLocale は currencyCode に 置き換えられます
  • usdTotalCost は新しいフィールドです
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

{
    "budget": {
        "amount": 97,
        "attributes": {
            "objectType": "SpendingBudget"
        }
    },
    "resourceId": "44908a11-641b-4c53-b7fc-0f2bfca8a581",
    "resourceName": "Modern Azure Customer UK",
    "billingStartDate": "2019-09-01T00:00:00+00:00",
    "billingEndDate": "2019-10-01T00:00:00+00:00",
    "totalCost": 28.82860766744404945074,
    "currencyCode": "GBP",
    "usdTotalCost": 35.23000000000000362337,
    "lastModifiedDate": "2019-09-18T17:09:26.16+00:00",
    "attributes": {
        "objectType": "CustomerUsageSummary"
    }
}