Obter os dados de uso da assinatura por medidorGet usage data for subscription by meter

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 MeterUsageRecord para obter registros de uso de medidor de um cliente para serviços ou recursos específicos do Azure durante o período de cobrança atual.You can use the MeterUsageRecord resource collection to get meter usage records of a customer for specific Azure services or resources during the current billing period. Essa coleção de recursos representa um total agregado para cada medidor para o ciclo de cobrança atual, em todo o plano do Azure.This resource collection represents an aggregated total for each meter for the current billing cycle, across your entire Azure plan.

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).

  • Uma ID de assinaturaA subscription ID

Essa nova rota é equivalente a subscriptions/{subscription-id}/usagerecords/resources , que continuará a funcionar somente para assinaturas Microsoft Azure (MS-AZR-0145P).This new route is equivalent to subscriptions/{subscription-id}/usagerecords/resources, which will continue to function only for Microsoft Azure (MS-AZR-0145P) subscriptions. Essa nova rota dará suporte a assinaturas Microsoft Azure (MS-AZR-0145P) e planos do Azure.This new route will support both Microsoft Azure (MS-AZR-0145P) subscriptions and Azure plans. Para obter essas informações para o plano do Azure, você precisa alternar para essa nova rota.In order to get this information for your Azure plan, you need to switch to this new route. Além das propriedades mencionadas nas seções a seguir, a resposta é a mesma do caminho antigo.Other than the properties mentioned in the following sections, the response is the same as the old route.

C#C#

Para obter registros de uso de medidor de um cliente para um serviço ou recurso específico do Azure durante o período de cobrança atual:To get meter usage records of a customer for 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. Chame a propriedade subscriptions e UsageRecords, em seguida, a propriedade medidores .Call the Subscriptions property, and UsageRecords, then the Meters property. Conclua chamando os métodos get () ou getasync ().Finish by calling the Get() or GetAsync() methods.

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

Para obter um exemplo, consulte o exemplo a seguir:For an example, see the following sample:

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

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

Parâmetros do URIURI parameters

Esta tabela lista os parâmetros de consulta necessários para obter as informações de uso classificadas pelo cliente.This table lists the required query parameters 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.
ID da assinaturasubscription-id guidguid SY Um GUID correspondente ao identificador de um recurso de assinaturado Partner Center, que representa uma assinatura Microsoft Azure (MS-AZR-0145P) ou um plano do Azure.A GUID corresponding to the identifier of a Partner Center subscription resource, which represents a Microsoft Azure (MS-AZR-0145P) subscription or an Azure plan. Para recursos de assinatura do plano do Azure, forneça a ID do plano como a ID da assinatura nesta rota.For Azure plan subscription resources, provide the plan-id as the subscription-id in this route.

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/{subscription-id}/meterusagerecords 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 **PagedResourceCollection <MeterUsageRecord> ** no corpo da resposta.If successful, this method returns a PagedResourceCollection<MeterUsageRecord> 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 o 145P Azure PayG.In this example, the customer purchased 145P Azure PayG.

Para clientes com uma assinatura Microsoft Azure (MS-AZR-0145P), não haverá nenhuma alteração na resposta da API.For customers with a Microsoft Azure (MS-AZR-0145P) subscription, there will be no change to 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: Fri, 26 Feb 2016 20:31:45 GMT

{
    "totalCount": 4,
    "items": [
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNVX-005J-Data Transfer In (GB)",
            "meterName": "Data Transfer In",
            "category": "Bandwidth",
            "subcategory": "Bandwidth",
            "quantityUsed": 0.01129,
            "unit": "1 GB",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        },
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNVX-005J-Data Transfer Out (GB)",
            "meterName": "Data Transfer Out",
            "category": "Bandwidth",
            "subcategory": "Bandwidth",
            "quantityUsed": 0.000224,
            "unit": "1 GB",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        },
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNZ5-006G-10K Batch Write Operations",
            "meterName": "Batch Write Operations",
            "category": "Storage",
            "subcategory": "Tables",
            "quantityUsed": 0.2462,
            "unit": "10K",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        },
        {
            "subscriptionId": "{subscription-id}",
            "meterId": "DZH318Z0BNZ5-006G-Data Stored (GB/Month)",
            "meterName": "LRS Data Stored",
            "category": "Storage",
            "subcategory": "Tables",
            "quantityUsed": 0.002632,
            "unit": "1 GB/Month",
            "totalCost": 0,
            "currencyCode": "GBP",
            "usdTotalCost": 0,
            "lastModifiedDate": "2019-09-17T21:08:44.2566667+00:00",
            "attributes": {
                "objectType": "MeterUsageRecord"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/<customer-tenant-id>/subscriptions/<subscription-id>/meterusagerecords",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}