Obtener toda la información de análisis del uso de AzureGet all Azure usage analytics information

Se aplica aApplies To

  • Centro de partnersPartner Center
  • Centro de partners operado por 21VianetPartner Center operated by 21Vianet
  • Centro de partners para Microsoft Cloud AlemaniaPartner Center for Microsoft Cloud Germany
  • Centro de partners para Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Cómo obtener toda la información de análisis de uso de Azure para sus clientes.How to get all the Azure usage analytics information for your customers.

Requisitos previosPrerequisites

Solicitud RESTREST request

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de la solicitudRequest URI
GETGET * { BASEURL } */Partner/v1/Analytics/Usage/Azure http/1.1{baseURL}/partner/v1/analytics/usage/azure HTTP/1.1

Parámetros de URIURI parameters

ParámetroParameter

TipoType

DescripciónDescription

toptop

stringstring

Número de filas de datos que se devuelven en la solicitud.The number of rows of data to return in the request. El valor máximo y el valor predeterminado, si no se especifican, es 10 000.The maximum value and the default value if not specified is 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo que puedes usar para solicitar la siguiente página de datos.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data.

skipskip

intint

Número de filas que se omiten en la consulta.The number of rows to skip in the query. Usa este parámetro para consultar grandes conjuntos de datos.Use this parameter to page through large data sets. Por ejemplo, top=10000 and skip=0 Recupera las primeras 10000 filas de datos, top=10000 and skip=10000 Recupera las siguientes 10000 filas de datos, etc.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on.

filterfilter

stringstring

El parámetro filter de la solicitud contiene una o más instrucciones que filtran las filas de la respuesta.The filter parameter of the request contains one or more statements that filter the rows in the response. Cada instrucción contiene un campo y un valor que están asociados a los eq ne operadores o, y las instrucciones se pueden combinar mediante and o or .Each statement contains a field and value that are associated with the eq or ne operators, and statements can be combined using and or or. Puede especificar lo siguiente:You can specify the following s:

  • customerTenantId
  • customerName
  • subscriptionId
  • subscriptionName
  • usageDate
  • resourceLocation
  • meterCategory
  • meterSubcategory
  • meterUnit
  • reservationOrderId
  • reservationId
  • consumptionMeterId
  • serviceType

Ejemplo:Example:
.../usage/azure?filter=meterCategory eq 'Data Management'

Ejemplo:Example:
.../usage/azure?filter=meterCategory eq 'Data Management' or (usageDate le cast('2018-01-01', Edm.DateTimeOffset) and usageDate le cast('2018-04-01', Edm.DateTimeOffset))

aggregationLevelaggregationLevel

stringstring

Especifica el intervalo de tiempo necesario para el que quieres recuperar datos agregados.Specifies the time range for which to retrieve aggregate data. Puede ser una de las cadenas siguientes: day , week o month .Can be one of the following strings: day, week, or month. Si no se especifica, el valor predeterminado es day .If unspecified, the default is day.

El aggregationLevel parámetro no se admite sin un groupby .The aggregationLevel parameter isn't supported without a groupby. El aggregationLevel parámetro se aplica a todos los campos de fecha presentes en groupby .The aggregationLevel parameter applies to all date fields present in the groupby.

orderbyorderby

stringstring

Instrucción que ordena los valores de los datos de resultado de cada instalación.A statement that orders the result data values for each install. La sintaxis es ...&orderby=field [order],field [order],....The syntax is ...&orderby=field [order],field [order],.... El field parámetro puede ser una de las cadenas siguientes:The field parameter can be one of the following strings:

  • customerTenantId
  • customerName
  • subscriptionId
  • subscriptionName
  • usageDate
  • resourceLocation
  • meterCategory
  • meterSubcategory
  • meterUnit
  • reservationOrderId
  • reservationId
  • consumptionMeterId
  • serviceType

El parámetro Order es opcional y puede ser asc o desc ; para especificar el orden ascendente o descendente de cada campo, respectivamente.The order parameter is optional and can be asc or desc; to specify ascending or descending order for each field, respectively. De manera predeterminada, es asc.The default is asc.

Ejemplo:Example:
...&orderby=meterCategory,meterUnit

groupby

stringstring

Una instrucción que aplica la agregación de datos únicamente a los campos especificados.A statement that applies data aggregation only to the specified fields. Puedes especificar los siguientes campos:You can specify the following fields:

  • customerTenantId
  • customerName
  • subscriptionId
  • subscriptionName
  • usageDate
  • resourceLocation
  • meterCategory
  • meterSubcategory
  • meterUnit
  • reservationOrderId
  • reservationId
  • consumptionMeterId
  • serviceType

Las filas de datos devueltas contendrán los campos especificados en el groupby parámetro, así como la cantidad.The returned data rows will contain the fields specified in the groupby parameter as well as the Quantity.

El groupby parámetro se puede utilizar con el aggregationLevel parámetro.The groupby parameter can be used with the aggregationLevel parameter.

Ejemplo:Example:
...&groupby=meterCategory,meterUnit

Encabezados de solicitudRequest headers

Para obtener más información, consulta Encabezados REST del Centro de partners.For more information, see Partner Center REST headers.

Cuerpo de la solicitudRequest body

Ninguno.None.

Ejemplo de solicitudRequest example

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/usage/azure HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0

Respuesta RESTREST response

Si se realiza correctamente, el cuerpo de respuesta contiene una colección de recursos de uso de Azure .If successful, the response body contains a collection of Azure usage resources.

Códigos de error y de respuesta correctosResponse success and error codes

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.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales.Use a network trace tool to read this code, error type, and additional parameters. Para obtener la lista completa, consulte Códigos de error.For the full list, see Error Codes.

Ejemplo de respuestaResponse example

{
  "customerTenantId": "39A1DFAC-4969-4F31-AF94-D76588189CFE",
  "customerName": "A",
  "subscriptionId": "EC649980-D623-49F5-B7C1-80CC772B83A8",
  "subscriptionName": "AZURE PURCHSE SAMPLE APP",
  "usageDate": "2018-05-27T00:00:00",
  "resourceLocation": "useast",
  "meterCategory": "Data Management",
  "meterSubcategory": "None",
  "meterUnit": "10,000s",
  "reservationOrderId": "",
  "reservationId": "",
  "consumptionMeterId": "",
  "serviceType": "",
  "quantity": 20
}

Vea tambiénSee also