Obter registos de utilização da subscrição para um cliente

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 SubscriptionMonthlyUsageRecord para obter registos de utilização da subscrição de um cliente de um serviço ou recurso específico do Azure durante o período de faturação atual. Este recurso representa todas as subscrições do cliente. Para um cliente com um plano do Azure, este recurso devolve uma lista desses planos (não subscrições individuais 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 ao selecionar 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).

C#

Para obter registos de utilização da subscrição de um cliente de um serviço ou recurso específico do Azure durante o período de faturação atual, siga os seguintes passos:

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

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

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

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

Para obter um exemplo, veja o seguinte:

Exemplo: aplicação de teste da consola
Projeto: PartnerSDK.FeatureSamples
Classe: GetSubscriptionUsageRecords.cs

Pedido REST

Sintaxe do pedido

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

Parâmetro URI

Esta tabela lista o parâmetro de consulta necessário 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.

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/usagerecords 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 SubscriptionMonthlyUsageRecord 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 uma oferta do Azure PayG de 145P .

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

{
    "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 os 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: Tue, 17 Sep 2019 20:31:45 GMT

{
    "totalCount": 2,
    "items": [
        {
            "status": "active",
            "partnerOnRecord": "some-id",
            "offerId": "DZH318Z0BPS6:0001:DZH318Z0BML6",
            "resourceId": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
            "id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
            "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": "c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3",
            "id": "c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3",
            "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"
    }
}

Partilhar via