API de uso de recurso de provedor
O provedor de termos se aplica ao administrador de serviços e a quaisquer provedores delegados. Operadores do Azure Stack Hub e provedores delegados podem usar a API de uso do provedor para exibir o uso de seus locatários diretos. Por exemplo, conforme 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 solicitando informações de uso em P3 e P4.
Referência de chamada à API
Solicitação
A solicitação obtém detalhes de consumo para as assinaturas solicitadas e para o período solicitado. Não há nenhum corpo de solicitação.
Essa API de uso é uma API do provedor, portanto, o chamador deve receber uma função de Proprietário, Colaborador ou Leitor na assinatura do provedor.
| Método | URI da solicitação |
|---|---|
| GET | 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 |
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 esteja no formato https://adminmanagement.{domain-name}. Por exemplo, para o ASDK (Kit de Desenvolvimento do Azure Stack), se o nome de domínio for local.azurestack.external, o ponto de extremidade Resource Manager será https://adminmanagement.local.azurestack.external. |
subId |
ID da assinatura do usuário que faz a chamada. |
reportedStartTime |
A hora de início da consulta. O valor de DateTime deve estar em URC (Tempo Universal Coordenado) e no início da hora; por exemplo, 13:00. Para a agregação diária, defina esse valor como meia-noite UTC. O formato tem escape da ISO 8601; por exemplo, 2015-06-16T18%3a53%3a11%2b00%3a00Z, em que os dois-pontos são escapados para %3a e a vantagem é escapada para para que seja amigável ao %2b URI. |
reportedEndTime |
A hora de término da consulta. As restrições que se aplicam a reportedStartTime também se aplicam a esse argumento. O valor de reportedEndTime não pode ser no futuro, nem na data atual. Se for, o resultado será definido como "processamento não concluído". |
aggregationGranularity |
Parâmetro opcional que tem dois valores potenciais discretos: diariamente e por hora. Como os valores sugerem, um retorna os dados em granularidade diária e o outro é uma resolução por hora. A opção diária é o padrão. |
subscriberId |
ID da assinatura. Para obter dados filtrados, a ID da assinatura de um locatário direto do provedor é necessária. Se nenhum parâmetro de ID da 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 é configurado para 2015-06-01-preview. |
continuationToken |
Token recuperado da última chamada para o provedor de API de uso. Esse token é necessário quando uma resposta tem mais que 1.000 linhas. Ele atua como um indicador do 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 passada. |
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 exclusiva da agregação de uso. |
name |
Nome da agregação de uso. |
type |
Definição de recurso. |
subscriptionId |
Identificador de assinatura do usuário do Azure Stack Hub. |
usageStartTime |
Hora de início UTC do bucket de uso ao qual essa agregação de uso pertence. |
usageEndTime |
Hora de término UTC do bucket de uso ao qual essa agregação de uso pertence. |
instanceData |
Pares chave-valor de detalhes da instância (em um novo formato):resourceUri: ID de recurso totalmente qualificado, que inclui os grupos de recursos e o nome da instância. location: região na qual esse serviço foi executado. tags: marcas de recurso especificadas pelo usuário. additionalInfo: mais detalhes sobre o recurso que foi consumido; por exemplo, a versão do sistema operacional ou o tipo de imagem. |
quantity |
A quantidade de consumo de recursos que ocorreu neste período. |
meterId |
A ID exclusiva para o recurso que foi consumido (também chamada 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 VM (máquina virtual) ativa ou uma conta de armazenamento que contém alguns dados. Se você não tiver certeza se tem recursos em execução no Marketplace do Azure Stack Hub, implante uma VM e verifique a folha de monitoramento da VM para verificar se ela está em execução. Use os seguintes cmdlets do PowerShell para exibir os dados de uso:
Configure o usuário do Azure Stack Hub ou o ambiente do PowerShell do operador do Azure Stack Hub .
Para recuperar os dados de uso, chame o cmdlet Get-AzsSubscriberUsage do PowerShell:
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
API REST
Você pode coletar informações de uso para assinaturas excluídas chamando o serviço Microsoft.Commerce.Administração.
Retornar todo o uso do locatário para excluído para usuários ativos
| Método | URI da solicitação |
|---|---|
| GET | 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 do locatário excluído ou ativo
| Método | URI da solicitação |
|---|---|
| GET | 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 |