課金対象および未請求の日単位の使用状況調整 API v2 (GA)

適用対象: パートナー センター (Azure Government または Azure China 21Vianet では使用できません)。

非同期 API は、Azure BLOB を介して課金および調整データにアクセスするための、より迅速かつ管理しやすい方法を提供します。 これらの API を使用すると、接続を何時間も開いたままにしておく必要も、2,000 行の項目のバッチをループ処理する必要もなくなります。

valet キーとasynchronous request-reply パターンを使用して、新しいコマースの日単位の使用状況調整 API を最適化しました。 これらの API を使用すると、すべての属性または日単位の使用状況調整データのサブセットにアクセスするために使用できるトークンを受け取ります。

現在、これらの API を使用できるのは、MS Graph のパブリックとグローバル クラウドのみです。 Azure Government または Azure China 21Vianet ではまだ使用できません。

API の概要

新しいコマース 取得するには 毎日評価される使用状況の行項目を非同期的に取得するには、2 つの API エンドポイントを使用します。 そのプロセスを次に示します。

使用状況の行項目エンドポイント

この API を使用して、請求済みまたは未請求の日単位の使用状況の明細項目を取得します。 202の HTTP 状態と場所ヘッダーの URL が表示されます。 マニフェスト URL で成功状態が得られるまで、この URL を定期的にポーリングします。

操作状態エンドポイント

成功状態を取得するには、この API を一定の間隔で呼び出し続けます。 データの準備ができていない場合、API 応答には Retry-After ヘッダーが含まれており、再試行するまでの待機時間を示します。 操作が完了すると、使用状況データをダウンロードできるストレージ フォルダーを含むマニフェスト リソースが取得されます。 応答により、スループットと I/O 並列処理を最適化するために、ファイルがより小さな部分に分割されます。

シーケンス図

調整データをダウンロードする手順を示すシーケンス図を次に示します。

ユーザー アクション シーケンス

新しいコマース 取得するには 毎日評価される使用状況調整の明細項目を次の手順に従います。

手順 1: 要求を送信する

API エンドポイントに POST 要求を送信します。

1 日ごとの課金対象の使用状況の明細項目を取得する

現在 または最後のカレンダー月または請求期間 新しいコマース未請求の日単位の使用状況の明細項目を取得します。

API 要求

POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/unbilled/export

Accept: application/json

Content-Type: application/json

{

"currencyCode": "USD",

"billingPeriod": "current",

"attributeSet": "basic"

}

要求本文

要求ヘッダー

API のヘッダーを要求するには、「 責任とサポートを参照してください。

API 応答

HTTP/1.1 202 Accepted  
Location: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

API を使用すると、通常は HTTP 202 状態が返されます。 要求に基づいて他の可能な状態を確認するには、 Standard API 応答の状態を参照してください。

請求日単位の使用状況の明細項目を取得する

新しいコマースを取得支払い済みの請求期間の請求書に対して毎日評価される使用状況の明細項目が課金されます。

API 要求

POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/billed/export

{  
"invoiceId": "G00012345",  
"attributeSet": "full"  
}

クエリ パラメーター

該当なし

要求本文

要求ヘッダー

API の要求ヘッダー。 詳細については、 責任とサポートを参照してください。

API 応答

HTTP/1.1 202 Accepted
場所: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

API を使用すると、通常は HTTP 202 状態が返されます。 要求に基づくその他の状態については、「 Statuses」を参照してください。

手順 2: 要求の状態を確認する

要求の状態を確認するには、"成功" または "失敗" のいずれかの状態の HTTP 200 応答を待ちます。要求が成功した場合、マニフェスト URL は "resourceLocation" 属性に指定されます。

操作の状態を取得する

要求の状態を取得します。

API 要求

GET https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

要求パラメーター

要求ヘッダー

API のヘッダーを要求するには、「 責任とサポートを参照してください。

要求本文

該当なし。

応答の状態

標準の HTTP 状態に加えて API は次の HTTP 状態を返すことができます。

応答ペイロード

API 応答ペイロードには、次の属性が含まれています。

リソースの場所オブジェクト

API 要求

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

API 応答

応答では、データの処理時に再試行する前に 10 秒間待機することをお勧めします。

HTTP/1.1 200 OK  
Retry-After: 10  
{  
"id": "9ab9cb54-d07f-4f52-9ea6-a09d7de52c14",  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime": "2022-06-1T10-01-05Z",  
"status": "running"  
}

API 要求

(前の要求の 10 秒後。..)

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

API 応答

API は、"成功" 状態と "resourceLocation" の URI を返します。

HTTP/1.1 200 OK  
Content-Type: application/json  
{

    "@odata.context": "https://graph.microsoft.com/v1.0/\$metadata#reports/partners/billing/operations/\$entity",

    "@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation",

    "id": "f2170b13-6a8e-47d6-b481-6988490dc0cb",

    "createdDateTime": "2023-12-05T21:17:29Z",

    "lastActionDateTime": "2023-12-05T21:18:00.8897902Z",

    "status": "succeeded",

    "resourceLocation": {

        "id": "44e8500b-ab92-490e-8ac3-90500a1d3427",

        "createdDateTime": "2023-11-06T19:58:47.513Z",

        "schemaVersion": "2",

        "dataFormat": "compressedJSON",

        "partitionType": "default",

        "eTag": "RwDrn7fbiTXy6UULE",

        "partnerTenantId": "0e195b37-4574-4539-bc42-0e539b9684c0",

        "rootDirectory": "https://adlsreconbuprodeastus201.blob.core.windows.net/path_id",

        "sasToken": "{token}",

        "blobCount": 1,

        "blobs": \[

            {

                "name": "part-00123-5a93fa5d-749f-48bc-a372-9b021d93c3fa.c000.json.gz",

                "partitionValue": "default"

            }

        \]

    }

}

手順 3: Azure BLOB ストレージから毎日評価される使用状況調整の行項目をダウンロードする

マニフェスト ペイロード API 応答の "sasToken" プロパティと "rootDirectory" プロパティから、Shared Access Signature (SAS) トークンと BLOB ストレージの場所を取得します。 Azure Storage SDK/ツールを使用して、BLOB ファイルをダウンロードして解凍します。 JSONLines 形式です。

標準 API 応答の状態

API 応答から次の HTTP 状態を受け取る場合があります。

ベータ版と GA バージョンを比較する

ベータ版と一般公開 (GA) バージョンの違いについては、比較表を参照してください。 ベータ版を使用している場合は、GA バージョンに簡単に切り替える必要があります。

日単位の使用状況調整明細属性

"full" または "basic" 属性セットについて、日単位の使用状況調整 API によって返される属性を比較するには、次の情報を参照してください。

サンプル コード

詳細については、「 Partner Center API サンプル: 課金の調整データを取得するを参照してください。