Obter registros de uso de assinatura para um clienteGet subscription usage records for a customer

Aplica-se a:Applies to:

  • Partner CenterPartner Center
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany
  • Partner Center do Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Você pode usar a coleção de recursos SubscriptionMonthlyUsageRecord para obter registros de uso de assinatura para um cliente de um serviço ou recurso específico do Azure durante o período de cobrança atual.You can use the SubscriptionMonthlyUsageRecord resource collection to get subscription usage records for a customer of a specific Azure service or resource during the current billing period. Esse recurso representa todas as assinaturas para o cliente.This resource represents all subscriptions for the customer. Para um cliente com um plano do Azure, esse recurso retorna uma lista desses planos (não assinaturas individuais do Azure).For a customer with an Azure plan, this resource returns a list of those plans (not individual Azure subscriptions).

Pré-requisitosPrerequisites

  • Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Este cenário dá suporte somente à autenticação com credenciais de aplicativo + de usuário.This scenario supports authentication with App+User credentials only.

  • Uma ID do cliente (customer-tenant-id).A customer ID (customer-tenant-id). Se você não souber a ID do cliente, poderá procurar no painel do Partner Center.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecione CSP no menu do Partner Center e, em seguida, Clientes.Select CSP from the Partner Center menu, followed by Customers. Selecione o cliente na lista de clientes e selecione Conta.Select the customer from the customer list, then select Account. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

C#C#

Para obter registros de uso de assinatura para um cliente de um serviço ou recurso específico do Azure durante o período de cobrança atual.:To get subscription usage records for a customer of a specific Azure service or resource during the current billing period.:

  1. Use sua coleção IAggregatePartner. Customers para chamar o método ById () .Use your IAggregatePartner.Customers collection to call the ById() method.

  2. Em seguida, chame a propriedade subscriptions , bem como a propriedade UsageRecords .Then call the Subscriptions property, as well as UsageRecords property. Conclua chamando os métodos get () ou getasync ().Finish by calling the Get() or GetAsync() methods.

    // IAggregatePartner partnerOperations;
    // var selectedCustomerId as string;
    
    var usageRecords = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.UsageRecords.Get();
    

Para obter um exemplo, consulte o seguinte:For an example, see the following:

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET {baseURL}/v1/Customers/{Customer-Tenant-ID}/subscriptions/usagerecords http/1.1{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/usagerecords HTTP/1.1

Parâmetro do URIURI parameter

Esta tabela lista o parâmetro de consulta necessário para obter as informações de uso classificadas pelo cliente.This table lists the required query parameter to get the customer's rated usage information.

NomeName TipoType ObrigatórioRequired DescriçãoDescription
customer-tenant-idcustomer-tenant-id guidguid SY Um GUID correspondente ao cliente.A GUID corresponding to the customer.

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

Nenhum.None.

Exemplo de solicitaçãoRequest example

GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions/usagerecords HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4

Resposta RESTREST response

Se for bem-sucedido, esse método retornará um recurso SubscriptionMonthlyUsageRecord no corpo da resposta.If successful, this method returns a SubscriptionMonthlyUsageRecord resource in the response body.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, the error type, and additional parameters. Para obter uma lista completa, consulte códigos de erro.For a full list, see Error Codes.

Exemplo de resposta para assinaturas do Microsoft Azure (MS-AZR-0145P)Response example for Microsoft Azure (MS-AZR-0145P) subscriptions

Neste exemplo, o cliente comprou uma oferta 145P do Azure PayG .In this example, the customer purchased a 145P Azure PayG offer.

Para clientes com assinaturas Microsoft Azure (MS-AZR-0145P), não haverá nenhuma alteração na resposta da API.For customers with Microsoft Azure (MS-AZR-0145P) subscriptions, there will be no change to the API response.

HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT

{
    "totalCount": 1,
    "items": [
        {
            "status": "active",
            "offerId": "MS-AZR-0145P",
            "resourceId": "11111111-F347-41B6-B02C-187B1B778A43",
            "id": "11111111-F347-41B6-B02C-187B1B778A43",
            "resourceName": "Microsoft Azure",
            "name": "Microsoft Azure",
            "totalCost": 22.861172,
            "currencyLocale": "fr-FR",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-01T23:04:41.193+00:00",
            "attributes": {
                "objectType": "SubscriptionMonthlyUsageRecord"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/<customer-tenant-id>/subscriptions/usagerecords/",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

Exemplo de resposta REST para o plano do AzureREST response example for Azure plan

Neste exemplo, o cliente comprou um plano do Azure.In this example, the customer purchased an Azure plan.

Para clientes com planos do Azure, há as seguintes alterações na resposta da API:For customers with Azure plans, there are the following changes in the API response:

  • currencyLocale é substituído por currencyCodecurrencyLocale is replaced with currencyCode
  • usdTotalCost é um novo campousdTotalCost is a new field
HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac4
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT

{
    "totalCount": 2,
    "items": [
        {
            "status": "active",
            "partnerOnRecord": "some-id",
            "offerId": "DZH318Z0BPS6:0001:DZH318Z0BML6",
            "resourceId": "11111111-7d58-6654-69fa-0797198155d3",
            "id": "11111111-7d58-6654-69fa-0797198155d3",
            "resourceName": "Azure plan",
            "name": "Azure plan",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-18T17:09:26.16+00:00",
            "attributes": {
                "objectType": "SubscriptionMonthlyUsageRecord"
            }
        },
        {
            "status": "active",
            "partnerOnRecord": "some-id",
            "offerId": "DZH318Z0BPS6:0001:DZH318Z0BML6",
            "resourceId": "11111111-25aa-ebb8-2bb4-fb406307babd",
            "id": "11111111-25aa-ebb8-2bb4-fb406307babd",
            "resourceName": "Azure plan",
            "name": "Azure plan",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-18T17:09:26.16+00:00",
            "attributes": {
                "objectType": "SubscriptionMonthlyUsageRecord"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/<customer-tenant-id>/subscriptions/usagerecords",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}