パートナー センター REST API を使用して新しいコマースの転送を作成する

  • [アーティクル]

パートナーは、トランザクション パートナー間で新しいコマース サブスクリプションを譲渡できます。 ターゲット パートナーが転送要求を作成します。 ソース パートナー 転送 明細の詳細を更新します。 このトピックでは、転送要求を作成するためにターゲット パートナーが呼び出す API について説明します。 このトピックは、Azure プランの予約、節約プラン、サブスクリプション、および新しいコマース ライセンス ベースのサブスクリプションにのみ関連します。 より貴重な情報については、 サブスクリプションの転送に関するドキュメントを参照してください。

前提条件

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

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

  • 対象のロール: 管理エージェント

REST 要求

要求の構文

認証方法 要求 URI
投稿 {baseURL}/v1/customers/{customer-ID}/transfers HTTP/1.1

URI パラメーター

次のパス パラメーターを使用して顧客を指定します。

名前 タイプ Required 説明
customer-id string はい 顧客を識別する GUID 形式の顧客 ID。

要求ヘッダー

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

要求本文

次の表では、新しいコマース転送要求を作成するための要求本文の TransferEntity プロパティについて説明します。

プロパティ タイプ Required 説明
sourcePartnerTenantId string はい 転送を開始するパートナーを識別する GUID 形式のパートナー ID。
sourcePartnerName string はい 譲渡を開始するパートナーの組織の名前。
customerEmailId string はい 転送の作成の通知を受信する顧客の文字列。
customerName string いいえ 省略可能。 サブスクリプションが譲渡される顧客の名前。
targetPartnerTenantId string いいえ 転送の対象となるパートナーを識別する GUID 形式のパートナー テナント ID。 省略すると、パートナー承認コンテキストはパートナー テナント ID に解決されます。
targetPartnerEmailId string いいえ 転送の対象となるパートナーを識別する GUID 形式のパートナー テナント ID。 省略すると、パートナー承認コンテキストはパートナー テナント ID に解決されます。
transferType string はい 転送の種類を定義する文字列。 3 は NewCommerce を表し、Azure プランと新しいコマース ライセンス ベースのサブスクリプションに使用する必要があります。

要求の例

{
    "id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
    "status": "InProgress",
    "transferType": 3,
    "customerEmailId": "",
    "createdTime": "2024-04-30T18:31:41.5133355Z",
    "lastModifiedTime": "2024-05-01T00:51:55Z",
    "expirationTime": "2024-05-31T00:00:00Z",
    "customerName": "ipdbtrans2",
    "customerTenantId": "a624f7f8-408b-49d0-9320-df79e56bed55",
    "partnertenantid": "a94dcde1-ecd7-wace-a6ef-ef73ba6b8ba5",
    "sourcePartnerName": "Test_Test_IP4_AG",
    "sourcePartnerTenantId": "a94dcde1-ecd7-4ace-a6ef-ef73ba6b8ba5",
    "targetPartnerName": "Test_Test_DB_AG",
    "targetPartnerTenantId": "817512dd-0689-47a0-bbf2-a7f11ae1fc11",
    "targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
    "transferDirection": 2,
    "ignoreEligibilityCheck": false,
    "lastModifiedUser": "1671774b-679f-4543-a152-1f8b14006c0e",
    "lineItems": [{
        "id": 0,
        "subscriptionId": "d0df8837-6db3-49d8-c2b3-1d94bc1ab42d",
        "billingCycle": "unknown",
        "quantity": 0,
        "productType": 5,
        "status": "InProgress"
    }],
    "links": {
        "self": {
            "uri": "/customers/a624f7f8-408b-49d0-9320-df79e56bed55/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
            "method": "GET",
            "headers": []
        }
    }
}

REST 応答

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

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

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

応答の例

HTTP/1.1 201 Created
Content-Length: 138
Content-Type: application/json; charset=utf-8
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: 0e93c70c-977c-4a88-9580-7cf084c73286
X-Locale: en-US,en-US

{
"id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
"status": "Pending",
"transferType": 3,
"customerEmailId": "",
"createdTime": "2024-04-30T18:31:41.5133355Z",
"lastModifiedTime": "2024-04-30T18:31:41Z",
"expirationTime": "2024-05-31T00:00:00Z",
"customerName": "ipdbtrans2",
"customerTenantId": "a624f7f8-408b-49d0-9320-df79e56bed55",
"partnertenantid": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"sourcePartnerName": "Test_Test_IP4_AG",
"sourcePartnerTenantId": "a94dcde1-ecd7-4ace-a6ef-ef73ba6b8ba5",
"targetPartnerName": "Test_Test_DB_AG",
"targetPartnerTenantId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"transferDirection": 1,
"ignoreEligibilityCheck": false,
"lastModifiedUser": "7ffdaa28-3b1c-4a61-b580-e1aa6ecf833c",
"links": {
    "self": {
        "uri": "/customers/a624f7f8-408b-49d0-9320-df79e56bed55/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
        "method": "GET",
        "headers": []
    }
}
}