API использования ресурсов для поставщиковProvider resource usage API

Термин поставщик обозначает администраторов служб и любых делегированных поставщиков.The term provider applies to the service administrator and to any delegated providers. Операторы Azure Stack Hub и делегированные поставщики с помощью API использования ресурсов для поставщиков могут просматривать данные об использовании ресурсов их непосредственными клиентами.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Например, как показано на следующей схеме, с помощью API для поставщиков P0 может получить сведения о прямом использовании ресурсов для P1 и P2, а P1 — для P3 и P4.For example, as shown in the following diagram, P0 can call the provider API to get direct usage information on P1 and P2, and P1 can call for usage information on P3 and P4.

Концептуальная модель иерархии поставщиков

Справка о вызовах APIAPI call reference

ЗапросRequest

Запрос возвращает сведения о потреблении для указанной подписки и указанного периода времени.The request gets consumption details for the requested subscriptions and for the requested time frame. Запрос не содержит текст.There's no request body.

Этот API использования предназначен для поставщиков, поэтому вызывающей стороне должна быть назначена роль владельца , участника или читателя в подписке поставщика.This usage API is a provider API, so the caller must be assigned an Owner , Contributor , or Reader role in the provider's subscription.

МетодMethod URI запросаRequest URI
GETGET 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}

АргументыArguments

АргументArgument ОписаниеDescription
armendpoint Конечная точка Azure Resource Manager среды Azure Stack Hub.Azure Resource Manager endpoint of your Azure Stack Hub environment. В соответствии с соглашением Azure Stack Hub имя конечной точки Azure Resource Manager должно иметь формат https://adminmanagement.{domain-name}.The Azure Stack Hub convention is that the name of the Azure Resource Manager endpoint is in the format https://adminmanagement.{domain-name}. Например, если для пакета средств разработки Azure Stack (ASDK) доменное имя — local.azurestack.external , то конечная точка Azure Resource Manager — https://adminmanagement.local.azurestack.external.For example, for the Azure Stack Development Kit (ASDK), if the domain name is local.azurestack.external , then the Resource Manager endpoint is https://adminmanagement.local.azurestack.external.
subId Идентификатор подписки пользователя, который выполняет вызов.Subscription ID of the user who makes the call.
reportedStartTime Время начала выполнения запроса.Start time of the query. Значение DateTime должно быть в формате UTC и соответствовать началу нужного часа (например, 13:00).The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. Для сбора сведений за сутки это значение должно соответствовать полуночи в формате UTC.For daily aggregation, set this value to UTC midnight. В этом формате используется экранирование символов ISO 8601. Например, значение 2015-06-16T18%3a53%3a11%2b00%3a00Z можно использовать в составе URI, так как символ двоеточия преобразован в %3a, а плюс — в %2b.The format is escaped ISO 8601; for example, 2015-06-16T18%3a53%3a11%2b00%3a00Z, where the colon is escaped to %3a and the plus is escaped to %2b so that it's URI-friendly.
reportedEndTime Время завершения выполнения запроса.End time of the query. Действуют те же ограничения, что и для аргумента reportedStartTime.The constraints that apply to reportedStartTime also apply to this argument. Значение reportedEndTime не может относиться ни к будущему, ни к текущему дню.The value for reportedEndTime can't be either in the future, or the current date. В противном случае возвращается результат "Обработка не завершена".If it is, the result is set to "processing not complete."
aggregationGranularity Необязательный дискретный параметр, который имеет два возможных значения: daily (за сутки) или hourly (за час).Optional parameter that has two discrete potential values: daily and hourly. Эти значения возвращают данные с разной степенью детализации: за сутки и за час.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. Вариант с детализацией за сутки используется по умолчанию.The daily option is the default.
subscriberId Идентификатор подписки.Subscription ID. Чтобы получить отфильтрованные данные, нужно указать идентификатор подписки для прямого клиента поставщика.To get filtered data, the subscription ID of a direct tenant of the provider is required. Если идентификатор подписки не указан, вызов возвращает данные об использовании для всех прямых клиентов поставщика.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version Версия протокола, который используется для выполнения этого запроса.Version of the protocol that's used to make this request. Этот параметр имеет значение 2015-06-01-preview.This value is set to 2015-06-01-preview.
continuationToken Маркер, полученный из последнего вызова к API использования для поставщиков.Token retrieved from the last call to the usage API provider. Этот маркер требуется, когда ответ превышает 1000 строк.This token is needed when a response is greater than 1,000 lines. Он служит закладкой в процессе выполнения.It acts as a bookmark for the progress. Если маркер отсутствует, данные извлекаются с начала суток или часа, в зависимости от указанного уровня детализации.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

ОтветResponse

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"

}
},

. . .

Сведения об ответеResponse details

АргументArgument ОписаниеDescription
id Уникальный идентификатор статистического выражения использования.Unique ID of the usage aggregate.
name Имя статистического выражения использования.Name of the usage aggregate.
type Определение ресурса.Resource definition.
subscriptionId Идентификатор подписки пользователя Azure Stack Hub.Subscription identifier of the Azure Stack Hub user.
usageStartTime Начальное время включения в контейнер использования, к которому относится статистическое выражение использования (в формате UTC).UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime Конечное время включения в контейнер использования, к которому относится статистическое выражение использования (в формате UTC).UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Пары "ключ-значение" из сведений об экземпляре (в новом формате):Key-value pairs of instance details (in a new format):
resourceUri: полный идентификатор ресурса, который содержит группы ресурсов и имя экземпляра.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: регион, в котором выполнялась эта служба.location: Region in which this service was run.
tags: теги ресурсов, которые указываются пользователем.tags: Resource tags that are specified by the user.
additionalInfo: Подробные сведения об использованном ресурсе, например, версия ОС или тип образа.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Объем потребления ресурса за указанный промежуток времени.Amount of resource consumption that occurred in this time frame.
meterId Уникальный идентификатор использованного ресурса (также обозначается ResourceID).Unique ID for the resource that was consumed (also called ResourceID).

Получение сведений о потребленииRetrieve usage information

PowerShellPowerShell

Чтобы данные об использовании создавались, должны существовать активно работающие ресурсы, например, действующая виртуальная машина или учетная запись хранения, содержащая некоторые данные.To generate the usage data, you should have resources that are running and actively using the system; for example, an active virtual machine (VM), or a storage account containing some data. Если вы не знаете, есть ли у вас активные ресурсы в Azure Stack Hub Marketplace, разверните виртуальную машину, откройте для нее колонку мониторинга и проверьте выполнение.If you're not sure whether you have any resources running in the Azure Stack Hub Marketplace, deploy a VM, and verify the VM monitoring blade to make sure it's running. Следующие командлеты PowerShell позволяют просмотреть данные о потреблении:Use the following PowerShell cmdlets to view the usage data:

  1. Установка PowerShell для Azure Stack Hub.Install PowerShell for Azure Stack Hub.

  2. Настройка пользователя Azure Stack Hub или оператора Azure Stack Hub в среде PowerShell.Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Чтобы получить данные об использовании, вызовите PowerShell Get-AzsSubscriberUsage.To retrieve the usage data, call the Get-AzsSubscriberUsage PowerShell cmdlet:

    Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
    

REST APIREST API

Вы можете собирать сведения об использовании для удаленных подписок путем вызова службы Microsoft.Commerce.Admin.You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Возврат данных об использовании по всем клиентам для удаленных подписок для активных пользователейReturn all tenant usage for deleted for active users

МетодMethod URI запросаRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Возврат данных об использовании по удаленному или активному клиентуReturn usage for deleted or active tenant

МетодMethod URI запросаRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview

Дальнейшие действияNext steps