API de uso de recursos do provedor
O termo provedor se aplica ao administrador de serviços e a quaisquer provedores delegados. Os operadores do Azure Stack Hub e os provedores delegados podem usar a API de uso do provedor para exibir o uso de seus locatários diretos. Por exemplo, como mostrado no diagrama a seguir, P0 pode chamar a API do provedor para obter informações de uso direto em P1 e P2, e P1 pode chamar informações de uso em P3 e P4.
Referência de chamada de API
Pedido
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.
Esta API de utilização é uma API de provedor, portanto, o chamador deve ser atribuído a um papel de Proprietário, Colaboradorou Leitor na assinatura do provedor.
| Método | Solicitar URI |
|---|---|
| OBTER | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&subscriberId={sub1.1}&api-version=2015-06-01-preview&continuationToken={token-value} |
Argumentos
| Argumento | Descrição |
|---|---|
armendpoint |
Endpoint do Azure Resource Manager do seu ambiente do Azure Stack Hub. A convenção do Azure Stack Hub é que o nome do endpoint do Azure Resource Manager está no formato https://adminmanagement.{domain-name}. Por exemplo, para o Azure Stack Development Kit (ASDK), se o nome de domínio for local.azurestack.external, o ponto de extremidade do Resource Manager será https://adminmanagement.local.azurestack.external. |
subId |
ID de assinatura do usuário que faz a chamada. |
reportedStartTime |
Hora de início da consulta. O valor para DateTime deve estar em Tempo Universal Coordenado (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 o cólon é escapado para %3a e o plus é escapado para %2b para que seja amigável ao URI. |
reportedEndTime |
Hora de fim da consulta. As restrições que se aplicam a reportedStartTime também se aplicam a este argumento. O valor para reportedEndTime não pode ser nem no futuro nem na data atual. Se for, o resultado é definido como "processamento não concluído". |
aggregationGranularity |
Parâmetro opcional que tem dois valores potenciais discretos: diária 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. |
subscriberId |
ID da subscrição. Para obter dados filtrados, é necessário o ID de assinatura de um locatário direto do provedor. Se nenhum parâmetro de ID de assinatura for especificado, a chamada retornará dados de uso para todos os locatários diretos do provedor. |
api-version |
Versão do protocolo usado para fazer essa solicitação. Esse valor é definido como 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 o token não estiver presente, os dados serão recuperados do início do dia ou da hora, com base na granularidade transmitida. |
Resposta
GET
/subscriptions/sub1/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&subscriberId=sub1.1&api-version=1.0
{
"value": [
{
"id":
"/subscriptions/sub1.1/providers/Microsoft.Commerce.Admin/UsageAggregate/sub1.1-
meterID1",
"name": "sub1.1-meterID1",
"type": "Microsoft.Commerce.Admin/UsageAggregate",
"properties": {
"subscriptionId":"sub1.1",
"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
| Argumento | Descrição |
|---|---|
id |
ID exclusivo do agregado de uso. |
name |
Nome do agregado de uso. |
type |
Definição de recursos. |
subscriptionId |
Identificador de assinatura do usuário do Azure Stack Hub. |
usageStartTime |
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 (num novo formato):resourceUri: ID de recurso totalmente qualificado, que inclui os grupos de recursos e o nome da instância. location: Região em que este serviço foi executado. tags: Tags de recursos especificadas pelo usuário. additionalInfo: Mais detalhes sobre o recurso que foi consumido; por exemplo, a versão do SO ou o tipo de imagem. |
quantity |
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). |
Recuperar informações de uso
PowerShell
Para gerar os dados de uso, você deve ter recursos que estão em execução e usando ativamente o sistema; por exemplo, uma máquina virtual (VM) ativa ou uma conta de armazenamento contendo alguns dados. Se você não tiver certeza se tem algum recurso em execução no Azure Stack Hub Marketplace, implante uma VM e verifique a folha de monitoramento de VM para garantir que ela esteja em execução. Use os seguintes cmdlets do PowerShell para exibir os dados de uso:
Configure o de usuário do Azure Stack Hub ou o operador do Azure Stack Hub ambiente do PowerShell.
Para recuperar os dados de uso, chame o cmdlet Get-AzsSubscriberUsage PowerShell:
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST API
Você pode coletar informações de uso para assinaturas excluídas chamando o serviço de Microsoft.Commerce.Admin.
Retornar todo o uso de inquilinos ou locatários eliminados para usuários ativos
| Método | Solicitar URI |
|---|---|
| OBTER | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Retornar o uso para locatário excluído ou ativo
| Método | Solicitar URI |
|---|---|
| OBTER | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview |