Obter um resumo de utilização para todas as subscrições de um cliente
Aplica-se a: Partner Center | Partner Center para a Nuvem Microsoft para o Governo dos EUA
Você pode usar o recurso CustomerUsageSummary para obter o uso de um serviço ou recurso específico do Azure por um cliente durante o período de cobrança atual.
Observação
Geralmente, os dados de uso não faturados com classificação diária estão disponíveis via API ou no portal do Partner Center após 24 horas. Dependendo da sua localização e quando os medidores relatam o uso, podem ocorrer atrasos adicionais.
Às vezes, você pode não ver os dados de uso não faturados mais recentes desde o início do mês até que os dados de uso faturados do mês anterior sejam entregues. Isso é para garantir que os dados de uso faturados sejam entregues de forma eficiente dentro do SLA. Depois de receber os dados de uso faturados, você pode começar a recuperar todos os dados de uso não faturados atualizados desde o início do mês.
Pré-requisitos
Credenciais conforme descrito em autenticação do Partner Center. Este cenário suporta autenticação apenas com credenciais App+User.
Um ID de cliente (
customer-tenant-id
). Se não souber o ID do cliente, pode procurá-lo no do Partner Center selecionando espaço de trabalho Clientes, depois o cliente da lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure o ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é a mesma que a ID do cliente (customer-tenant-id
).
C#
Para obter um resumo de uso para todas as assinaturas de um cliente:
Use a sua coleção IAggregatePartner.Customers para chamar o método ById().
Chame a propriedade UsageSummary, seguida dos métodos Get() ou GetAsync():
// IAggregatePartner partnerOperations; // var selectedCustomerId as string; var usageSummary = partnerOperations.Customers.ById(selectedCustomerId).UsageSummary.Get();
Para obter um exemplo, consulte o seguinte:
- Exemplo: aplicativo de teste de console
- Projeto: PartnerSDK.FeatureSamples
- Classe: GetCustomerUsageSummary.cs
Pedido REST
Sintaxe da solicitação
Método | Solicitar URI |
---|---|
OBTER | {baseURL}/v1/customers/{customer-tenant-id}/usagesummary HTTP/1.1 |
Parâmetro URI
Esta tabela lista o parâmetro de consulta necessário para obter as informações de uso avaliado do cliente.
Nome | Tipo | Necessário | Descrição |
---|---|---|---|
ID do cliente-locatário | guid | Y | um GUID (Identificador Globalmente Único) correspondente ao cliente. |
Cabeçalhos de solicitação
Para obter mais informações, consulte cabeçalhos do Partner Center REST.
Corpo do pedido
Nenhuma.
Exemplo de solicitação
GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/usagesummary HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Resposta REST
Se bem-sucedido, esse método retorna um recurso CustomerUsageSummary no corpo da resposta.
Códigos de sucesso e erro de resposta
Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações adicionais de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e parâmetros adicionais. Para obter uma lista completa, consulte Códigos de erro.
Exemplo de resposta para assinatura do Microsoft Azure (MS-AZR-0145P)
Neste exemplo, o cliente comprou uma oferta 145P Azure PayG.
Para clientes com assinaturas do Microsoft Azure (MS-AZR-0145P), não haverá alteração na resposta da API.
HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT
{
"budget":{
"ammount":300.000000,
"attributes":{
"objectType":"SpendingBudget"
}
},
"id":"65726577-C208-40FD-9735-8C85AC9CAC68",
"name":"600 test",
"billingStartDate":"2016-02-06T00:00:00-08:00",
"billingEndDate":"2016-03-05T00:00:00-08:00",
"totalCost":0.0,
"currencyLocale":"en-US",
"lastModifiedDate":"2016-02-26T09:42:54.5130558+00:00",
"links":{
"self":{
"uri":"/customers/{customer-tenant-id}/usagesummary",
"method":"GET",
"headers":[]
}
},
"attributes":{
"objectType":"CustomerUsageSummary"
}
}
Exemplo de resposta para o plano do Azure
Neste exemplo, o cliente comprou um plano do Azure.
Para clientes com planos do Azure, há as seguintes alterações na resposta da API:
- currencyLocale é substituído por currencyCode
- usdTotalCost é um novo campo
HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT
{
"budget": {
"amount": 97,
"attributes": {
"objectType": "SpendingBudget"
}
},
"resourceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
"resourceName": "Modern Azure Customer UK",
"billingStartDate": "2019-09-01T00:00:00+00:00",
"billingEndDate": "2019-10-01T00:00:00+00:00",
"totalCost": 28.82860766744404945074,
"currencyCode": "GBP",
"usdTotalCost": 35.23000000000000362337,
"lastModifiedDate": "2019-09-18T17:09:26.16+00:00",
"attributes": {
"objectType": "CustomerUsageSummary"
}
}