Obter todas as informações de análise de uso do AzureGet all Azure usage analytics information

Aplica-se aApplies To

  • Partner CenterPartner Center
  • Partner Center operado pela 21VianetPartner Center operated by 21Vianet
  • 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

Como obter todas as informações de análise de uso do Azure para seus clientes.How to get all the Azure usage analytics information for your customers.

Pré-requisitosPrerequisites

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET * { BASEURL } */Partner/v1/Analytics/Usage/Azure http/1.1{baseURL}/partner/v1/analytics/usage/azure HTTP/1.1

Parâmetros do URIURI parameters

ParâmetroParameter TipoType DescriptionDescription
toptop cadeia de caracteresstring O número de linhas de dados a serem retornadas na solicitação.The number of rows of data to return in the request. O valor máximo e o valor padrão; se não forem especificados, será 10.000.The maximum value and the default value if not specified is 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um link que você poderá usar para solicitar a próxima página de dados.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 O número de linhas a serem ignoradas na consulta.The number of rows to skip in the query. Use este parâmetro para percorrer grandes conjuntos de dados.Use this parameter to page through large data sets. Por exemplo, top=10000 and skip=0 recupera as primeiras 10000 linhas de dados, top=10000 and skip=10000 recupera as próximas 10000 linhas de dados e assim por diante.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 cadeia de caracteresstring O parâmetro filter da solicitação contém uma ou mais instruções que filtram as linhas da resposta.The filter parameter of the request contains one or more statements that filter the rows in the response. Cada instrução contém um campo e um valor que são associados aos eq ne operadores ou, e as instruções podem ser combinadas usando and ou 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. Você pode especificar as seguintes cadeias de caracteres:You can specify the following strings:

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

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

Exemplo: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 cadeia de caracteresstring Especifica o intervalo de tempo para o qual recuperar dados agregados.Specifies the time range for which to retrieve aggregate data. Pode ser uma das seguintes cadeias de caracteres: day , week ou month .Can be one of the following strings: day, week, or month. Se não for especificado, o padrão será day .If unspecified, the default is day.

aggregationLevelNão há suporte para o parâmetro sem um groupby .The aggregationLevel parameter isn't supported without a groupby. O aggregationLevel parâmetro aplica-se a todos os campos de data presentes no groupby .The aggregationLevel parameter applies to all date fields present in the groupby.
orderbyorderby cadeia de caracteresstring Uma instrução que classifica os valores dos dados resultantes de cada instalação.A statement that orders the result data values for each install. A sintaxe é ...&orderby=field [order],field [order],....The syntax is ...&orderby=field [order],field [order],.... O field parâmetro pode ser uma das seguintes cadeias de caracteres:The field parameter can be one of the following strings:

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

O parâmetro Order é opcional e pode ser asc ou desc especificar ordem crescente ou decrescente para cada campo, respectivamente.The order parameter is optional and can be asc or desc to specify ascending or descending order for each field, respectively. O padrão é asc.The default is asc.

Exemplo:Example:
...&orderby=meterCategory,meterUnit
groupbygroupby cadeia de caracteresstring Uma instrução que aplica a agregação de dados apenas aos campos especificados.A statement that applies data aggregation only to the specified fields. Você pode especificar os campos a seguir:You can specify the following fields:

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

As linhas de dados retornadas conterão os campos especificados no groupby parâmetro, bem como a quantidade.The returned data rows will contain the fields specified in the groupby parameter as well as the Quantity.

O groupby parâmetro pode ser usado com o aggregationLevel parâmetro.The groupby parameter can be used with the aggregationLevel parameter.

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

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/partner/v1/analytics/usage/azure HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0

Resposta RESTREST response

Se for bem-sucedido, o corpo da resposta conterá uma coleção de recursos de uso do Azure .If successful, the response body contains a collection of Azure usage resources.

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, error type, and additional parameters. Para obter a lista completa, confira Códigos de Erro.For the full list, see Error Codes.

Exemplo de respostaResponse 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
}

Veja tambémSee also