Obter uma nova agenda de migração comercial
Aplica-se a: Centro de Parceiros | Centro de Parceiros operado pela 21Vianet | Centro de Parceiros para Microsoft Cloud for US Government
Este artigo descreve como obter uma nova agenda de migração para o comércio.
Importante
Atualmente, esta API só está disponível no inquilino do Sandbox.
Pré-requisitos
Credenciais conforme descrito na autenticação do Centro de Parceiros. Este cenário suporta a autenticação com credenciais de Aplicação e Aplicação+Utilizador autónomas.
Um ID de cliente (
customer-tenant-id
). Se não souber o ID do cliente, pode procurá-lo no Centro de Parceiros ao selecionar a área de trabalho Clientes e, em seguida, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure o ID Microsoft na secção Informações da Conta de Cliente . O ID da Microsoft é o mesmo que o ID do cliente (customer-tenant-id
).Um ID de subscrição atual
Pedido REST
Existem duas formas diferentes de os parceiros consultarem.
- Para Consultar uma agenda específica
- Obter a lista de agendas de um determinado critério
Sintaxe do pedido
Método | URI do pedido |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID} |
Parâmetro URI
Esta tabela lista os parâmetros de consulta necessários para criar uma nova migração comercial.
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
customer-tenant-id | string | Yes | Uma cadeia formatada por GUID que identifica o cliente. |
Método | URI do pedido |
---|---|
GET | {baseURL}/v1/migrations/newcommerce/schedules? CustomerTenantId={customer-tenant-id} |
Parâmetro URI
Esta tabela lista os parâmetros de consulta necessários para criar uma nova migração comercial. Qualquer pessoa do parâmetro de consulta pode ser utilizada.
Nome | Tipo | Descrição |
---|---|---|
customerTenantId | string | Uma cadeia formatada por GUID que identifica o cliente. |
currentSubscriptionID | string | Uma cadeia formatada por GUID que identifica o ID de Subscrição atual |
externalReferenceID | string | Uma cadeia formatada por GUID que identifica o lote de migração |
Cabeçalhos do pedido
Para obter mais informações, veja Cabeçalhos REST do Centro de Parceiros.
Corpo da resposta
Esta tabela descreve as propriedades da subscrição na resposta.
Propriedade | Tipo | Obrigatório | Descrição |
---|---|---|---|
currentSubscriptionId | string | Yes | Um identificador de subscrição que indica que subscrição requer validação para migração. |
termDuration | cadeia (de carateres) | No | A duração do termo pode ser especificada para ser alterada após a migração. |
ciclo de faturação | cadeia (de carateres) | No | O ciclo de faturação pode ser especificado para ser alterado após a migração. |
purchaseFullTerm | bool | Não | Um novo termo pode ser iniciado no NCE após a migração. |
quantidade | int | No | A quantidade de licenças de uma subscrição pode ser aumentada ou diminuída após a migração. |
customTermEndDate | datetime | Não | Uma data de fim pode ser definida para ser alinhada com uma subscrição OnlineServicesNCE ou mês de calendário não experimental existente. Existem mais informações sobre como alinhar as datas de fim da subscrição aqui: Alinhar as datas de fim da subscrição no Centro de Parceiros |
targetDate | datetime | Não | Data de Destino quando agendar a migração. |
migrateOnRenewal | bool | Não | Indica se o agendamento tem de ocorrer durante a renovação |
status | cadeia (de carateres) | No | Estado da migração agendada |
createdTime | datetime | Não | Quando a agenda foi criada |
lastModifiedTime | datetime | Não | Quando a agenda foi modificada pela última vez |
Resposta do REST
Se for bem-sucedido, este método devolve detalhes das subscrições que estão a ser migradas (objeto de migração) no corpo da resposta.
Códigos de erro e êxito da resposta
Cada resposta inclui um código de estado HTTP que indica êxito ou falha e informações adicionais de depuração. Utilize uma ferramenta de rastreio de rede para ler este código, tipo de erro e parâmetros adicionais. Para obter a lista completa, veja Códigos de erro REST do Centro de Parceiros.
Exemplos de resposta
[
{
"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"
}
]
Ver também
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários