パートナー センター API を使用してリソースの種類別にインベントリを確認する

特定のリソースの種類でフィルター処理されたカタログ アイテムのインベントリを確認する方法。

前提条件

• Partner Center の認証で説明されている資格情報。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。

• 製品 ID（任意）。 SKU ID (省略可能)。

• 有効な resourceType 値 (必須)。 受け入れ可能な値の完全な一覧については、「 サポートされているリソースの種類 」を参照してください。

• 指定された製品/SKU ID によって参照される SKU のインベントリを検証するために必要な追加のコンテキスト。 これらの要件は、製品/SKU の種類によって異なる場合があり、 SKU のInventoryVariables プロパティから決定できます。

REST リクエスト

リクエスト構文

URI パラメーター

リソースの種類別にインベントリを確認するには、次のクエリ パラメーターを使用します。

サポートされているリソースの種類

リクエストヘッダー

詳細については、Partner Center REST ヘッダーを参照してください。

リクエスト本文

1 つ以上の InventoryItem リソースを含む InventoryCheckRequest リソースで構成されるインベントリ要求の詳細。

要求本文で指定されたAzure サブスクリプションが登録され、AZURE RI の購入が有効になっていることを確認します。 登録プロセスの詳細については、「 サブスクリプションの 登録」を参照してください。

TargetItems はオプションです。 これを除外するか、null または [] に設定すると、応答にはリソースタイプのすべての項目が含まれます。 これを含める場合、応答はこれらの製品 ID にフィルター処理されます。 各 TargetItems エントリには空白以外の ProductId が必要です。そうでない場合、リクエストは 400 を返します。

ベスト プラクティス: 応答をより小さく、より速く、関連性の高いものにするために、必要な製品 ID のみを指定して TargetItems を渡します。 それ以外の場合、VirtualMachines などの広範なリソースの種類は、何千もの項目を返すことができます。

要求の例

POST https://api.partnercenter.microsoft.com/v1/extensions/product/checkinventorybyresourcetype?country=US&resourceType=VirtualMachines HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: d1b1981a-e088-4610-870a-eebec96d6bcd
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Type: application/json

{"TargetItems":[{"ProductId":"DZH318Z0BQ3P"}],"InventoryContext":{"customerId":"d6bf25b7-e0a8-4f2d-a31b-97b55cfc774d","azureSubscriptionId":"3A231FBE-37FE-4410-93FD-730D3D5D4C75","armRegionName":"westeurope"}}

REST 応答

成功した場合、応答本文には、制限の詳細が設定された InventoryItem オブジェクトのコレクションが含まれます (該当する場合)。

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

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

応答の例

HTTP/1.1 200 OK
Content-Length: 1021
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: d1b1981a-e088-4610-870a-eebec96d6bcd
X-Locale: en-US
[
    {
        "productId": "DZH318Z0BQ3P",
        "skuId": "0039",
        "isRestricted": true,
        "restrictions": [
            {
                "reasonCode": "NotAvailableForSubscription",
                "description": "Restriction identified of type 'Location' with values 'japanwest'.",
                "properties": {
                    "type": "Location",
                    "values": "japanwest"
                }
            }
        ]
    },
    {
        "productId": "DZH318Z0BQ3P",
        "skuId": "0038",
        "isRestricted": false,
        "restrictions": []
    }
]

レスポンスに含まれない製品

指定したサブスクリプションとリージョンで製品または SKU を使用できるが、制限の対象となる場合、応答には、 isRestricted: true を含む製品と該当する制限の詳細が含まれます。

指定したサブスクリプションとリージョンで製品を使用できない場合、応答では製品が完全に省略されます。

関連するコンテンツ

• 製品リソース
• インベントリの確認
• サブスクリプションを登録する
• パートナー センター REST API リファレンス