Obter um agendamento de migração para o novo comércio
Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government
Este artigo descreve como obter uma nova agenda de migração de comércio.
Importante
No momento, essa API só está disponível no locatário Sandbox.
Pré-requisitos
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Uma ID do cliente (
customer-tenant-id
). Se você não souber a ID do cliente, poderá procurá-la no Partner Center selecionando o espaço de trabalho Clientes, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é igual à ID do cliente (customer-tenant-id
).Um ID de assinatura atual
Solicitação REST
Há duas maneiras diferentes de os parceiros consultarem.
- Para consultar uma agenda específica
- Obter a lista de horários para um determinado critério
Sintaxe da solicitação
Método | URI da solicitação |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID} |
Parâmetro do URI
Esta tabela lista os parâmetros de consulta necessários para criar uma nova migração de comércio.
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
id de locatário do cliente | string | Sim | Uma cadeia com formato de GUID que identifica o cliente. |
Método | URI da solicitação |
---|---|
GET | {baseURL}/v1/migrações/newcommerce/agendas? CustomerTenantId={customer-tenant-id} |
Parâmetro do URI
Esta tabela lista os parâmetros de consulta necessários para criar uma nova migração de comércio. Qualquer um dos parâmetros de consulta pode ser usado.
Nome | Tipo | Descrição |
---|---|---|
customerTenantId | string | Uma cadeia com formato de GUID que identifica o cliente. |
currentSubscriptionID | string | Uma cadeia de caracteres formatada em GUID que identifica a ID de assinatura atual |
externalReferenceID | string | Uma cadeia de caracteres formatada em GUID que identifica o lote de migração |
Cabeçalhos da solicitação
Para obter mais informações, confira Cabeçalhos REST do Partner Center.
Corpo da resposta
Esta tabela descreve as propriedades de assinatura na resposta.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
currentSubscriptionId | string | Sim | Um identificador de assinatura que indica qual assinatura requer validação para migração. |
prazoDuração | string | Não | A duração do prazo pode ser especificada para ser alterada após a migração. |
billingCycle | string | Não | O ciclo de faturamento pode ser especificado para ser alterado após a migração. |
compraFullTerm | bool | Não | Um novo termo pode ser iniciado no NCE após a migração. |
quantity | int | Não | A quantidade de licença para uma assinatura pode ser aumentada ou diminuída após a migração. |
customTermEndDate | datetime | Não | Uma data de término pode ser definida para se alinhar a uma assinatura OnlineServicesNCE não experimental existente ou a um mês de calendário. Há mais informações sobre como alinhar datas de término de assinatura aqui: Alinhar datas de término de assinatura no Partner Center |
targetDate | datetime | Não | Data de destino quando agendar a migração. |
migrateOnRenewal | bool | Não | Indica se o agendamento precisa acontecer na renovação |
status | string | Não | Status da migração de agendamento |
createdTime | datetime | Não | Quando a agenda foi criada |
lastModifiedTime | datetime | Não | Quando o cronograma foi modificado pela última vez |
Resposta REST
Se bem-sucedido, esse método retorna detalhes das assinaturas que estão sendo migradas (objeto de migração) no corpo da resposta.
Códigos de êxito e de erro de resposta
Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de erro REST do Partner Center.
Exemplos de respostas
[
{
"id": "f016c025-a873-47af-8b52-2516fbef4c65",
"currentSubscriptionId": "c6105a9c-36cb-4f88-92ea-9573040725c4",
"subscriptionEndDate": "2023-07-19T00:00:00Z",
"status": "Created",
"customerTenantId": "6f297517-16e6-4313-8c6d-4e10496d2871",
"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"
}
]