获取向新商务体验的迁移计划
适用于:合作伙伴中心 | 由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心
本文介绍如何获取新的商务迁移计划。
重要
此 API 目前仅在沙盒租户中可用。
先决条件
合作伙伴中心身份验证中所述的凭据。 此方案支持使用独立应用和 App+User 凭据进行身份验证。
客户 ID (
customer-tenant-id
)。 如果不知道客户的 ID,可以通过选择“客户”工作区,然后从客户列表中选择客户,然后选择“帐户”,在合作伙伴中心中查找该 ID。 在客户的“帐户”页上的“客户帐户信息”部分查找 Microsoft ID。 Microsoft ID 与客户 ID (customer-tenant-id
) 相同。当前订阅 ID
REST 请求
合作伙伴可以通过两种不同的方式进行查询。
- 合作伙伴可以查询以获取特定计划
- 合作伙伴可以查询以获取特定条件的计划列表
请求语法
方法 | 请求 URI |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID} |
URI 参数
下表列出了创建新的商业迁移所需的查询参数。
Name | 类型 | 必填 | 描述 |
---|---|---|---|
customer-tenant-id | string | 是 | 一个 GUID 格式的字符串,用于标识客户。 |
方法 | 请求 URI |
---|---|
GET | {baseURL}/v1/migrations/newcommerce/schedules?CustomerTenantId={customer-tenant-id} |
URI 参数
下表列出了创建新的商业迁移所需的查询参数。 可以使用查询参数的任何人。
Name | 类型 | 描述 |
---|---|---|
customerTenantId | string | 一个 GUID 格式的字符串,用于标识客户。 |
currentSubscriptionID | string | 标识当前订阅 ID 的 GUID 格式字符串 |
externalReferenceID | string | 标识迁移批处理的 GUID 格式字符串 |
请求标头
有关详细信息,请参阅合作伙伴中心 REST 标头。
响应正文
下表描述了 响应中的订阅 属性。
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
currentSubscriptionId | string | 是 | 一个订阅标识符,指示哪个订阅需要对迁移进行验证。 |
termDuration | string | 否 | 应用于迁移的术语持续时间。 |
billingCycle | string | 否 | 应用于迁移的计费周期。 |
purchaseFullTerm | 布尔 | 否 | 迁移是否启动新术语。 |
quantity | int | 否 | 迁移后,可以增加或减少订阅的许可证数量。 |
customTermEndDate | datetime | 否 | 可以将结束日期设置为与现有的非Trial OnlineServicesNCE 订阅或日历月保持一致。 此处提供了有关调整订阅结束日期的详细信息: 在合作伙伴中心对齐订阅结束日期 |
targetDate | datetime | 否 | 计划迁移的目标日期。 |
migrateOnRenewal | 布尔 | 否 | 指示计划是否需要在续订时发生 |
状态 | string | 否 | 计划迁移的状态 |
createdTime | datetime | 否 | 创建计划时 |
lastModifiedTime | datetime | 否 | 上次修改计划的时间 |
REST 响应
如果成功,此方法在响应正文中返回要迁移的 订阅 的详细信息(迁移对象)。
响应的成功和错误代码
每个响应都附带了一个 HTTP 状态代码,该代码指示成功或失败以及进一步调试信息。 使用网络跟踪工具读取此代码、错误类型和其他参数。 如需完整列表,请参阅合作伙伴中心 REST 错误代码。
响应示例
[
{
"id": "f016c025-a873-47af-8b52-2516fbef4c65",
"currentSubscriptionId": "c6105a9c-36cb-4f88-92ea-9573040725c4",
"subscriptionEndDate": "2023-07-19T00:00:00Z",
"status": "Created",
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"quantity": 25,
"termDuration": "P1Y",
"billingCycle": "Monthly",
"purchaseFullTerm": false,
"targetDate": "2022-10-30T00:00:00",
"createdTime": "2022-10-18T21:20:50.9668605+00:00",
"lastModifiedTime": "2022-10-18T21:29:32.8992819+00:00"
}
]