使用合作伙伴中心 REST API 为新商业创建转移

项目
09/20/2024

合作伙伴可以将新的商业订阅从一个交易合作伙伴转移到另一个交易合作伙伴。目标合作伙伴创建转移请求。源合作伙伴使用行项详细信息更新传输。本主题介绍目标合作伙伴将调用以创建传输请求的 API。本主题仅适用于 Azure 计划预留、节省计划和订阅以及基于商业许可证的新订阅。可以在订阅转移文档中找到更有价值的信息。

先决条件

合作伙伴中心身份验证中所述的凭据。此方案支持使用独立应用和 App+User 凭据进行身份验证。
客户 ID (customer-tenant-ID)。如果不知道客户的 ID，可以通过选择“客户”工作区，然后从客户列表中选择客户，然后选择“帐户”，在合作伙伴中心中查找该 ID。在客户的“帐户”页上的“客户帐户信息”部分查找 Microsoft ID。 Microsoft ID 与客户 ID (customer-tenant-ID) 相同。
相应的角色：管理员代理

REST 请求

请求语法

方法	请求 URI
POST	{baseURL}/v1/customers/{customer-ID}/transfers HTTP/1.1

URI 参数

请使用以下路径参数来标识客户。

名称	类型	必需	说明
customer-id	string	是	标识客户的 GUID 格式的客户 ID。

请求标头

有关详细信息，请参阅合作伙伴中心 REST 标头。

请求正文

下表描述了请求正文中用于创建新的商业转移请求的 TransferEntity 属性。

properties	类型	必需	说明
sourcePartnerTenantId	string	是	一个 GUID 格式的合作伙伴 ID，用于标识发起传输的合作伙伴。
sourcePartnerName	string	是	正在发起转移的合作伙伴组织的名称。
customerEmailId	string	是	一个客户字符串，用于接收传输创建通知。
customerName	string	否	可选。要转移其订阅的客户的名称。
targetPartnerTenantId	string	否	一个 GUID 格式的合作伙伴租户 ID，用于标识要向其发起转移的合作伙伴。如果省略合作伙伴租户 ID，合作伙伴授权上下文将解析为合作伙伴租户 ID。
targetPartnerEmailId	string	否	一个 GUID 格式的合作伙伴租户 ID，用于标识要向其发起转移的合作伙伴。如果省略合作伙伴租户 ID，合作伙伴授权上下文将解析为合作伙伴租户 ID。
transferType	string	是	定义传输类型的字符串。 3 表示 New Commerce ，应用于 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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "partnertenantid": "a94dcde1-ecd7-wace-a6ef-ef73ba6b8ba5",
    "sourcePartnerName": "Test_Test_IP4_AG",
    "sourcePartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "targetPartnerName": "Test_Test_DB_AG",
    "targetPartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
    "transferDirection": 2,
    "ignoreEligibilityCheck": false,
    "lastModifiedUser": "1671774b-679f-4543-a152-1f8b14006c0e",
    "lineItems": [{
        "id": 0,
        "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
        "billingCycle": "unknown",
        "quantity": 0,
        "productType": 5,
        "status": "InProgress"
    }],
    "links": {
        "self": {
            "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/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: aaaa0000-bb11-2222-33cc-444444dddddd
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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"partnertenantid": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"sourcePartnerName": "Test_Test_IP4_AG",
"sourcePartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"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/aaaabbbb-0000-cccc-1111-dddd2222eeee/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
        "method": "GET",
        "headers": []
    }
}
}

通过