Obter dados de utilização da subscrição por medidor

Artigo
10/07/2024

Aplica-se a: Centro de Parceiros | Centro de Parceiros para Microsoft Cloud for US Government

Pode utilizar a coleção de recursos MeterUsageRecord para obter registos de utilização do medidor de um cliente para serviços ou recursos específicos do Azure durante o período de faturação atual. Esta coleção de recursos representa um total agregado para cada medidor para o ciclo de faturação atual, em todo o plano do Azure.

Pré-requisitos

Credenciais conforme descrito na autenticação do Centro de Parceiros. Este cenário suporta a autenticação apenas com credenciais de Aplicação+Utilizador.
Um ID de cliente (customer-tenant-id). Se não souber o ID do cliente, pode procurá-lo no Centro de Parceiros selecionando a área de trabalho Clientes e, em seguida, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure o ID Microsoft na secção Informações da Conta de Cliente . O ID da Microsoft é o mesmo que o ID do cliente (customer-tenant-id).
Um ID de subscrição

Esta nova rota é equivalente a subscriptions/{subscription-id}/usagerecords/resources, que continuará a funcionar apenas para subscrições do Microsoft Azure (MS-AZR-0145P). Esta nova rota irá suportar subscrições do Microsoft Azure (MS-AZR-0145P) e planos do Azure. Para obter estas informações para o seu plano do Azure, tem de mudar para esta nova rota. Para além das propriedades mencionadas nas secções seguintes, a resposta é igual à rota antiga.

C#

Para obter registos de utilização do medidor de um cliente para um serviço ou recurso específico do Azure durante o período de faturação atual:

Utilize a coleção IAggregatePartner.Customers para chamar o método ById( ).

Chame a propriedade Subscrições e UsageRecords e, em seguida, a propriedade Medidores . Conclua ao chamar os métodos Get() ou GetAsync().

// IAggregatePartner partnerOperations;
// var selectedCustomerId as string;
// var selectedSubscriptionId as string;

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

Por exemplo, veja o exemplo seguinte:

Exemplo: aplicação de teste da consola
Project: PartnerSDK.FeatureSamples
Classe: GetSubscriptionUsageRecordsByMeter.cs

Pedido REST

Sintaxe do pedido

Método	URI do pedido
GET	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/meterusagerecords HTTP/1.1

Parâmetros URI

Esta tabela lista os parâmetros de consulta necessários para obter as informações de utilização classificadas do cliente.

Nome	Tipo	Necessário	Descrição
customer-tenant-id	guid	Y	Um GUID correspondente ao cliente.
subscription-id	guid	Y	Um GUID correspondente ao identificador de um recurso de subscrição do Centro de Parceiros, que representa uma subscrição do Microsoft Azure (MS-AZR-0145P) ou um plano do Azure. Para os recursos de subscrição do plano do Azure, forneça o iD do plano* como o id da subscrição nesta rota.*

Cabeçalhos do pedido

Para obter mais informações, veja Cabeçalhos REST do Centro de Parceiros.

Corpo do pedido

Nenhum.

Exemplo de pedido

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: aaaa0000-bb11-2222-33cc-444444dddddd

Resposta do REST

Se for bem-sucedido, este método devolve um recurso PagedResourceCollection<MeterUsageRecord> no corpo da resposta.

Códigos de erro e êxito da resposta

Cada resposta inclui um código de estado HTTP que indica êxito ou falha e informações adicionais de depuração. Utilize uma ferramenta de rastreio de rede para ler este código, o tipo de erro e parâmetros adicionais. Para obter uma lista completa, veja Códigos de Erro.

Exemplo de resposta para subscrições do Microsoft Azure (MS-AZR-0145P)

Neste exemplo, o cliente comprou o PayG do Azure de 145P.

Para clientes com uma subscrição do Microsoft Azure (MS-AZR-0145P), não haverá alterações na resposta à 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

{
    "totalCount": 1,
    "items": [
        {
            "status": "active",
            "offerId": "MS-AZR-0145P",
            "resourceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
            "id": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
            "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 Azure

Neste exemplo, o cliente comprou um plano do Azure.

Para clientes com planos do Azure, existem 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: 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"
    }
}

Partilhar via