Excedente de atualização

Aplica-se a

• Partner Center

Funções apropriadas

• Administrador global
• Agente administrativo

Observação

As novas experiências de comércio para serviços baseados em licença incluem muitos recursos novos e estão disponíveis para todos os CSPs (provedores de soluções em nuvem). Para obter mais informações, confira a visão geral das novas experiências de comércio.

Usado para definir o excedente de um determinado cliente para uma assinatura de consumo. Também pode ser usado para remover o excedente definindo-o como false. O excedente permite que um cliente continue usando serviços se usar o serviço além dos limites declarados. O excedente define que o excedente de assinatura de consumo pago conforme o uso será acumulado.

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á pesquisá-la no Partner Center selecionando o workspace 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).

• Pelo menos uma assinatura de excedente qualificada comprada para o cliente.

Solicitação REST

[PUT] /customers/{customer-tenant-id}/subscriptions/overage

Sintaxe da solicitação

Método	URI da solicitação
PUT	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/overage HTTP/1.1

Parâmetro do URI

Use os parâmetros de consulta a seguir para retornar o excedente de um cliente.

Nome	Type	Obrigatório	Descrição
customer-tenant-id	guid	Y	Um GUID correspondente ao locatário do cliente.

Cabeçalhos de solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nome	Type	Descrição
azureEntitlementId	guid	Um GUID que define a assinatura de consumo para excedente.
partnerId	guid	A PartnerID de um revendedor indireto. Aplicável somente a um modelo de duas camadas (Provedor Indireto).
overageEnabled	bool	Indique se o excedente deve ser habilitado para uma determinada assinatura de consumo.

Exemplo de solicitação

PUT https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions/overage HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
X-Locale: en-US

{
    "azureEntitlementId": "ea1c26b7-8c99-42bb-ba7d-c535831fae8e",
    "partnerId": "5357563",
    "overageEnabled": true
}

Resposta REST

Se tiver êxito, esse método retornará excedente para um cliente.

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.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT

{
    "azureEntitlementId": "ea1c26b7-8c99-42bb-ba7d-c535831fae8e",
    "partnerId": "5357563",
    "type": "PhoneServices",
    "overageEnabled": true,
    "links": {
        "overage": {
            "uri": "/customers/f62cf10b-8f76-4fc4-9774-c5291f8faf86/subscriptions/overage",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Overage"
    }
}