Referência da API de utilização de recursos do inquilino

  • Artigo

Um inquilino pode utilizar as APIs de inquilino para ver os dados de utilização de recursos do próprio inquilino. Estas APIs são consistentes com as APIs de utilização do Azure.

Pode utilizar o cmdlet Windows PowerShell Get-UsageAggregates para obter dados de utilização, tal como no Azure.

Chamada à API

Pedir

O pedido obtém detalhes de consumo para as subscrições pedidas e para o período de tempo pedido. Não existe nenhum corpo de pedido.

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

Parâmetros

Parâmetro Descrição
Armendpoint O Azure Resource Manager ponto final do ambiente do Azure Stack Hub. A convenção do Azure Stack Hub é que o nome do ponto final Resource Manager do Azure está no formato https://management.{domain-name}. Por exemplo, para o kit de desenvolvimento, o nome de domínio é local.azurestack.external e, em seguida, o ponto final Resource Manager é https://management.local.azurestack.external.
subId ID da subscrição do utilizador que está a fazer a chamada. Só pode utilizar esta API para consultar a utilização de uma única subscrição. Os fornecedores podem utilizar a API de utilização de recursos do fornecedor para consultar a utilização de todos os inquilinos.
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 este valor como UTC à meia-noite. O formato escapou do ISO 8601; por exemplo, 2015-06-16T18%3a53%3a11%2b00%3a00Z, onde dois pontos são escapados para %3a e mais é escapado para %2b para que seja amigável com o URI.
reportedEndTime Hora de fim da consulta. As restrições que se aplicam ao reportedStartTime também se aplicam a este parâmetro. O valor de reportedEndTime não pode ser no futuro.
agregaçãoGranularidade Parâmetro opcional que tem dois valores potenciais discretos: diariamente e por hora. Como os valores sugerem, um devolve os dados em granularidade diária e o outro é uma resolução por hora. A opção diária é a predefinição.
api-version Versão do protocolo utilizado para efetuar este pedido. Tem de utilizar 2015-06-01-preview.
continuationToken Token obtido da última chamada ao fornecedor de API de utilização. Este token é necessário quando uma resposta é superior a 1000 linhas. Funciona como um marcador para o progresso. Se não estiverem presentes, os dados são obtidos a partir do início do dia ou hora, com base na granularidade transmitida.

Resposta

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 utilização.
name Nome da agregação de utilização.
tipo Definição de recurso.
subscriptionId Identificador de subscrição do utilizador do Azure.
usageStartTime Hora de início utc do registo de utilização ao qual esta agregação de utilização pertence.
usageEndTime Hora de fim utc do registo de utilização ao qual esta agregação de utilização pertence.
instanceData Pares chave-valor de detalhes da instância (num novo formato):
resourceUri: ID de recurso completamente qualificado, incluindo grupos de recursos e nome da instância.
localização: região na qual este serviço foi executado.
etiquetas: etiquetas de recursos que o utilizador especifica.
additionalInfo: Mais detalhes sobre o recurso que foi consumido. Por exemplo, versão do SO ou tipo de imagem.
quantidade Quantidade de consumo de recursos que ocorreu neste período de tempo.
meterId ID exclusivo do recurso que foi consumido (também denominado ResourceID).

Passos seguintes