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 um novo agendamento de migração de comércio.
Importante
No momento, essa API só está disponível no locatário do Sandbox.
Pré-requisitos
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá 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 workspace Clientes, o cliente da 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
).Uma ID de assinatura atual
Solicitação REST
Há duas maneiras diferentes de os parceiros consultarem.
- Os parceiros podem consultar para obter um agendamento específico
- Os parceiros podem consultar para obter a lista de agendamentos para critérios específicos
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 comercial.
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/migrations/newcommerce/schedules? CustomerTenantId={id do locatário do cliente} |
Parâmetro do URI
Esta tabela lista os parâmetros de consulta necessários para criar uma nova migração comercial. 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. |
ID da assinatura atual | string | Uma cadeia de caracteres formatada em GUID que identifica a ID de assinatura atual |
ID de referência externa | 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. |
termDuration | string | Não | Duração do prazo aplicada à migração. |
billingCycle | string | Não | Ciclo de faturamento aplicado à migração. |
purchaseFullTerm | bool | Não | Se a migração inicia um novo período ou não. |
quantity | int | Não | A quantidade de licenças de 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 ou mês de calendário existente do OnlineServicesNCE sem avaliação. Há mais informações sobre como alinhar as datas de término da assinatura aqui: Alinhar datas de término da assinatura no Partner Center |
targetDate | datetime | Não | Data de destino para 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 o agendamento foi criado |
lastModifiedTime | datetime | Não | Quando o agendamento foi modificado pela última vez |
Resposta REST
Se for bem-sucedido, esse método retornará 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 com mais informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e mais parâmetros. 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": "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"
}
]