顧客のサブスクリプション使用状況レコードを取得する

[アーティクル]
10/07/2024

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

SubscriptionMonthlyUsageRecord リソースコレクションを使用して、現在の請求期間中に特定の Azure サービスまたはリソースの顧客のサブスクリプション使用状況レコードを取得できます。このリソースは、顧客のすべてのサブスクリプションを表します。 Azure プランをお持ちのお客様の場合、このリソースはそれらのプランの一覧を返します (個々の Azure サブスクリプションではありません)。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。
顧客 ID です (customer-tenant-id)。顧客の ID がわからない場合は、パートナーセンターで [顧客] ワークスペースを選択し、 次に顧客 の一覧から [顧客]、[ アカウント] の順に選択して、その ID を検索できます。お客様のアカウントページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

C#

現在の請求期間中に特定の Azure サービスまたはリソースの顧客のサブスクリプション使用状況レコードを取得するには、次の手順を実行します。

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

次に、 Subscriptions プロパティと UsageRecords プロパティを呼び出します。 Get() メソッドまたは GetAsync() メソッドを呼び出して完了します。

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

var usageRecords = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.UsageRecords.Get();

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

サンプル: コンソールテストアプリ
プロジェクト: PartnerSDK.FeatureSamples
クラス: GetSubscriptionUsageRecords.cs

REST 要求

要求の構文

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

URI パラメーター

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

名前	Type	必須	説明
customer-tenant-id	guid	Y	顧客に対応する GUID。

要求ヘッダー

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

[要求本文]

なし。

要求の例

GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions/usagerecords HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

REST 応答

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

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

各応答には、成功または失敗を示す 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: aaaa0000-bb11-2222-33cc-444444dddddd
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": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
            "id": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
            "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 応答の例

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

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

currencyLocale は currencyCode に置き換えられます
usdTotalCost は新しいフィールドです

HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT

{
    "totalCount": 2,
    "items": [
        {
            "status": "active",
            "partnerOnRecord": "some-id",
            "offerId": "DZH318Z0BPS6:0001:DZH318Z0BML6",
            "resourceId": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
            "id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
            "resourceName": "Azure plan",
            "name": "Azure plan",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-18T17:09:26.16+00:00",
            "attributes": {
                "objectType": "SubscriptionMonthlyUsageRecord"
            }
        },
        {
            "status": "active",
            "partnerOnRecord": "some-id",
            "offerId": "DZH318Z0BPS6:0001:DZH318Z0BML6",
            "resourceId": "c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3",
            "id": "c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3",
            "resourceName": "Azure plan",
            "name": "Azure plan",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-18T17:09:26.16+00:00",
            "attributes": {
                "objectType": "SubscriptionMonthlyUsageRecord"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/<customer-tenant-id>/subscriptions/usagerecords",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

次の方法で共有