Partilhar via

Referência da API de uso de recursos do locatário

  • Artigo

Um locatário pode usar as APIs do locatário para exibir os dados de uso de recursos do próprio locatário. Essas APIs são consistentes com as APIs de uso do Azure.

Você pode usar o cmdlet Get-UsageAggregates do Windows PowerShell para obter dados de uso, assim como no Azure.

Chamada à API

Pedir

A solicitação obtém detalhes de consumo para as assinaturas solicitadas e para o período de tempo solicitado. Não há órgão solicitante.

Método Solicitar URI
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parâmetros

Parâmetro Descrição
Armendpoint Ponto de extremidade do Azure Resource Manager do seu ambiente do Azure Stack Hub. A convenção do Azure Stack Hub é que o nome do ponto de extremidade do Azure Resource Manager está no formato https://management.{domain-name}. Por exemplo, para o kit de desenvolvimento, o nome de domínio é local.azurestack.external, então o ponto de extremidade do Resource Manager é https://management.local.azurestack.external.
subID ID de assinatura do usuário que está fazendo a chamada. Você pode usar essa API apenas para consultar o uso de uma única assinatura. Os provedores podem usar a API de uso de recursos do provedor para consultar o uso de todos os locatários.
reportedStartTime Hora de início da consulta. O valor de DateTime deve estar em UTC e no início da hora, por exemplo, 13:00. Para agregação diária, defina esse valor como UTC midnight. O formato é escapado ISO 8601; por exemplo, 2015-06-16T18%3a53%3a11%2b00%3a00Z, onde dois pontos são escapados para %3a e mais são escapados para %2b para que seja amigável para URI.
reportedEndTime Hora de fim da consulta. As restrições que se aplicam a reportedStartTime também se aplicam a esse parâmetro. O valor de reportedEndTime não pode ser no futuro.
agregaçãoGranularidade Parâmetro opcional que tem dois valores potenciais discretos: diário e horário. Como os valores sugerem, um retorna os dados em granularidade diária e o outro é uma resolução horária. A opção diária é o padrão.
api-version Versão do protocolo usado para fazer essa solicitação. Você deve usar 2015-06-01-preview.
continuationToken Token recuperado da última chamada para o provedor de API de uso. Esse token é necessário quando uma resposta é maior que 1.000 linhas. Funciona como um marcador para o progresso. Se não estiverem presentes, os dados são recuperados do início do dia ou da hora, com base na granularidade transmitida.

Response

GET
/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&api-version=1.0

{
"value": [
{

"id":
"/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregate/sub1-meterID1",
"name": "sub1-meterID1",
"type": "Microsoft.Commerce/UsageAggregate",

"properties": {
"subscriptionId":"sub1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"

}
},

...

Detalhes da resposta

Parâmetro Descrição
id ID exclusivo da agregação de uso.
nome Nome do agregado de uso.
tipo Definição de recursos.
subscriptionId Identificador de assinatura do usuário do Azure.
usoStartTime Hora de início UTC do bucket de uso ao qual esse agregado de uso pertence.
usageEndTime Hora de término UTC do bucket de uso ao qual esse agregado de uso pertence.
instanceData Pares chave-valor de detalhes da instância (em um novo formato):
resourceUri: ID de recurso totalmente qualificado, incluindo grupos de recursos e nome da instância.
localização: região em que este serviço foi executado.
tags: tags de recursos que o usuário especifica.
additionalInfo: Mais detalhes sobre o recurso que foi consumido. Por exemplo, versão do sistema operacional ou tipo de imagem.
quantidade Quantidade de consumo de recursos que ocorreu neste período de tempo.
meterId ID exclusivo para o recurso que foi consumido (também chamado de ResourceID).

Próximos passos