Obter datas de término de termo personalizadas

Artigo
02/21/2024

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government

Os parceiros podem ver as datas de término de prazo personalizadas permitidas para assinaturas baseadas em licença NCE que estão comprando para seus clientes. Os parceiros podem exibir as datas de término que se alinham com o final do mês do calendário ou esse período de co-vigência com as assinaturas de clientes existentes.

As APIs oferecem suporte apenas ao cálculo de datas de término de prazo personalizadas para a compra de novas assinaturas e não para a renovação de assinaturas existentes.

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.
Um CustomerTenantId. 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 é a mesma que a ID do cliente.

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
GET	{baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates

Consultar cadeia de caracteres

Esta tabela lista as cadeias de caracteres de consulta necessárias para filtrar e recuperar datas de término de termo personalizadas.

Nome:	Necessário:	Descrição:
term_duration	Sim	Uma representação ISO 8601 da duração do termo. Os valores atuais suportados são P1M (1 mês), P1Y (1 ano) e P3Y (3 anos).
term_start_date	Não	A data pretendida de compra. Isso não pode ficar no passado.
target_coterm_subscription_id	Não	Uma cadeia de caracteres formatada em GUID que identifica a assinatura do coterm com.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center. A resposta da API retorna um máximo de 300 registros de página. Se mais de 300 registros forem retornados em uma consulta inserida, um token de continuação será fornecido no cabeçalho da resposta. O token de continuação pode ser inserido no cabeçalho de uma solicitação a seguir para retornar registros de página adicionais consultados.

Corpo da solicitação

Nenhum.

Resposta REST

Se bem-sucedido, esse método retorna detalhes das assinaturas que foram migradas (objeto de migração) no corpo da resposta. Isso inclui a ID de migração.

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 URL de solicitação

baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M

Exemplos de respostas

 {
    "totalCount": 2,
    "items": [
        {
            "allowedCustomTermEndDateType": "calendarMonthAligned",
            "allowedCustomTermEndDate": "2023-07-31T00:00:00"
        },
        {
            "allowedCustomTermEndDateType": "subscriptionAligned",
            "cotermSubscriptionIds": [
               "5fcf618b-1daa-4604-da99-cc3e1c9ee422",
               "d30a9ff9-713e-4546-c97e-f06b9dcf6ef6"
            ],
            "allowedCustomTermEndDate": "2023-08-01T00:00:00"
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
 }

Compartilhar via