Obtener el resumen de uso de la suscripción del cliente

Se aplica a: Centro de partners | Centro de partners para Microsoft Cloud for US Government

Puede usar el recurso SubscriptionUsageSummary para obtener un resumen de uso de la suscripción para un cliente. Este recurso representa el resumen de uso de la suscripción de un servicio o recurso de Azure específico durante el período de facturación actual.

Requisitos previos

  • Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación solo con credenciales de aplicación y usuario.

  • Un id. de cliente (customer-tenant-id). Si no conoce el identificador del cliente, puede buscarlo en el Centro de partners si selecciona el área de trabajo Clientes , el cliente de la lista de clientes y, a continuación, cuenta. En la página Cuenta del cliente, busca el Id. de Microsoft en la sección Información de la cuenta del cliente. El id. de Microsoft es el mismo que el de cliente (customer-tenant-id).

  • Un identificador de suscripción

C#

Para obtener un resumen de uso de la suscripción de un cliente:

  1. Use la colección IAggregatePartner.Customers para llamar al método ById().

  2. A continuación, llame a la propiedad Subscriptions y a la propiedad UsageSummary . Para finalizar, llame a los métodos Get() o GetAsync().

    // IAggregatePartner partnerOperations;
    // var selectedCustomerId as string;
    // var selectedSubscriptionId as string;
    
    var subscriptionUsageSummary = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscriptionId).UsageSummary.Get();
    

Para obtener un ejemplo, vea lo siguiente:

Solicitud REST

Sintaxis de la solicitud

Método URI de la solicitud
GET {baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/usagesummary HTTP/1.1

Parámetros del identificador URI

En esta tabla se enumeran los parámetros de consulta necesarios para obtener la información de uso calificada del cliente.

Nombre Tipo Obligatorio Descripción
customer-tenant-id guid Y GUID correspondiente al cliente.
subscription-id guid Y GUID correspondiente al identificador de una suscripción. Para un plan de Azure, este es el identificador del recurso de suscripción del Centro de partners correspondiente, que representa el plan de Azure. En el caso de los recursos de suscripción del plan de Azure, proporcione el identificador de plan como identificador de suscripción en esta ruta.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

Ninguno.

Ejemplo de solicitud

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

Respuesta REST

Si se ejecuta correctamente, este método devuelve un recurso SubscriptionUsageSummary en el cuerpo de la respuesta.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales. Para obtener una lista completa, consulte Códigos de error.

Ejemplo de respuesta para suscripciones de Microsoft Azure (MS-AZR-0145P)

En este ejemplo, el cliente compró una oferta de Pago por uso de Azure 145P .

Para los clientes con suscripciones de Microsoft Azure (MS-AZR-0145P), no habrá ningún cambio en la respuesta de la API.

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

{
    "resourceId": "ABCDEFGH-F347-41B6-B02C-187B1B778A43",
    "id": "ABCDEFGH-F347-41B6-B02C-187B1B778A43",
    "resourceName": "Microsoft Azure",
    "name": "Microsoft Azure",
    "billingStartDate": "2019-08-28T00:00:00-07:00",
    "billingEndDate": "2019-09-27T00:00:00-07:00",
    "totalCost": 22.861172,
    "currencyLocale": "fr-FR",
    "lastModifiedDate": "2019-09-01T23:04:41.193+00:00",
    "links": {
        "self": {
            "uri": "/customers/<customer-tenant-id>/subscriptions/<subscription-id>/usagesummary",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "SubscriptionUsageSummary"
    }
}

Ejemplo de respuesta REST para el plan de Azure

En este ejemplo, el cliente compró un plan de Azure.

En el caso de los clientes con planes de Azure, hay los siguientes cambios de respuesta de api:

  • currencyLocale se reemplaza por currencyCode
  • usdTotalCost es un nuevo campo
HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: 47c36033-af5d-4457-80a4-512c1626fac1
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT

{
    "resourceId": "11111111-dca5-6f31-d3a6-dbbfad9be0fc",
    "resourceName": "Azure plan",
    "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",
    "links": {
        "self": {
            "uri": "/customers/<customer-tenant-id>/subscriptions/<subscription-id>/usagesummary",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "SubscriptionUsageSummary"
    }
}