Query Billing Account - Query Billing Account

Служба:: Cost Management

Версия API:: 2018-05-31

Выводит данные об использовании для учетной записи выставления счетов.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Query?api-version=2018-05-31

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountId	path	True	string	Идентификатор BillingAccount
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 2018-05-31.

Текст запроса

Имя	Обязательно	Тип	Описание
timeframe	True	TimeframeType	Интервал времени для извлечения данных для отчета. Если это настраивается, необходимо указать определенный период времени.
type	True	ReportType	Тип отчета.
dataset		ReportConfigDataset	Содержит определение данных в этой конфигурации отчета.
timePeriod		ReportConfigTimePeriod	Имеет период времени для извлечения данных для отчета.

Ответы

Имя	Тип	Описание
200 OK	QueryResult	ХОРОШО. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

BillingAccountQuery

Образец запроса

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-05-31

{
  "type": "Usage",
  "timeframe": "MonthToDate",
  "dataset": {
    "granularity": "Daily",
    "configuration": {
      "columns": [
        "PreTaxCost",
        "ResourceGroup",
        "UsageDate"
      ]
    },
    "filter": {
      "and": [
        {
          "or": [
            {
              "dimension": {
                "name": "ResourceLocation",
                "operator": "In",
                "values": [
                  "East US",
                  "West Europe"
                ]
              }
            },
            {
              "tag": {
                "name": "Environment",
                "operator": "In",
                "values": [
                  "UAT",
                  "Prod"
                ]
              }
            }
          ]
        },
        {
          "dimension": {
            "name": "ResourceGroup",
            "operator": "In",
            "values": [
              "API"
            ]
          }
        }
      ]
    }
  }
}

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
      "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
      "type": "microsoft.costmanagement/Query",
      "properties": {
        "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D",
        "columns": [
          {
            "name": "PreTaxCost",
            "type": "Number"
          },
          {
            "name": "ResourceGroup",
            "type": "String"
          },
          {
            "name": "UsageDate",
            "type": "Number"
          }
        ],
        "rows": [
          [
            19.545363672276512,
            "JapanUnifia-Trial",
            20180331
          ],
          [
            173.41979241290323,
            "RVIIOT-TRIAL",
            20180331
          ],
          [
            20.35941656262545,
            "VSTSHOL-1595322048000",
            20180331
          ],
          [
            0.16677720329728665,
            "gs-stms-dev",
            20180331
          ]
        ]
      }
    }
  ]
}

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.
FunctionType	Имя используемой функции агрегирования.
GranularityType	Степень детализации строк в отчете.
OperatorType	Оператор, используемый для сравнения.
Query
QueryColumn
QueryResult	Результат запроса. Он содержит все столбцы, перечисленные в группах и агрегированиях.
ReportConfigAggregation	Выражение агрегирования, используемое в отчете.
ReportConfigColumnType	Тип столбца в отчете.
ReportConfigComparisonExpression	Выражение сравнения, используемое в отчете.
ReportConfigDataset	Определение данных, присутствующих в отчете.
ReportConfigDatasetConfiguration	Конфигурация набора данных в отчете.
ReportConfigDefinition	Определение конфигурации отчета.
ReportConfigFilter	Выражение фильтра, используемое в отчете.
ReportConfigGrouping	Группа по выражению, используемая в отчете.
ReportConfigTimePeriod	Дата начала и окончания извлечения данных для отчета.
ReportType	Тип отчета.
TimeframeType	Интервал времени для извлечения данных для отчета. Если это настраивается, необходимо указать определенный период времени.

ErrorDetails

Object

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Object

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке.

FunctionType

Перечисление

Имя используемой функции агрегирования.

Значение	Описание
Sum

GranularityType

Перечисление

Степень детализации строк в отчете.

Значение	Описание
Daily

OperatorType

Перечисление

Оператор, используемый для сравнения.

Значение	Описание
In

Query

Object

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.columns	QueryColumn[]	Массив столбцов
properties.nextLink	string
properties.rows	Rows[]
tags	object	Теги ресурсов.
type	string	Тип ресурса.

QueryColumn

Object

Имя	Тип	Описание
name	string
type	string

QueryResult

Object

Результат запроса. Он содержит все столбцы, перечисленные в группах и агрегированиях.

Имя	Тип	Описание
value	Query[]	Список данных об использовании.

ReportConfigAggregation

Object

Выражение агрегирования, используемое в отчете.

Имя	Тип	Описание
function	FunctionType	Имя используемой функции агрегирования.
name	string	Имя столбца для статистической обработки.

ReportConfigColumnType

Перечисление

Тип столбца в отчете.

Значение	Описание
Tag
Dimension

ReportConfigComparisonExpression

Object

Выражение сравнения, используемое в отчете.

Имя	Тип	Описание
name	string	Имя столбца, используемого в сравнении.
operator	OperatorType	Оператор, используемый для сравнения.
values	string[]	Массив значений, используемых для сравнения

ReportConfigDataset

Object

Определение данных, присутствующих в отчете.

Имя	Тип	Описание
aggregation	<string, ReportConfigAggregation>	Словарь выражения агрегирования для использования в отчете. Ключ каждого элемента в словаре — это псевдоним для агрегированного столбца. В отчете может быть до 2 предложений агрегирования.
configuration	ReportConfigDatasetConfiguration	Содержит сведения о конфигурации данных в отчете. Конфигурация будет игнорироваться, если предоставляется агрегирование и группирование.
filter	ReportConfigFilter	Имеет выражение фильтра для использования в отчете.
granularity	GranularityType	Степень детализации строк в отчете.
grouping	ReportConfigGrouping[]	Массив групп по выражению для использования в отчете. Отчет может содержать до 2 групп по предложениям.

ReportConfigDatasetConfiguration

Object

Конфигурация набора данных в отчете.

Имя	Тип	Описание
columns	string[]	Массив имен столбцов для включения в отчет. Разрешено любое допустимое имя столбца отчета. Если он не указан, отчет содержит все столбцы.

ReportConfigDefinition

Object

Определение конфигурации отчета.

Имя	Тип	Описание
dataset	ReportConfigDataset	Содержит определение данных в этой конфигурации отчета.
timePeriod	ReportConfigTimePeriod	Имеет период времени для извлечения данных для отчета.
timeframe	TimeframeType	Интервал времени для извлечения данных для отчета. Если это настраивается, необходимо указать определенный период времени.
type	ReportType	Тип отчета.

ReportConfigFilter

Object

Выражение фильтра, используемое в отчете.

Имя	Тип	Описание
and	ReportConfigFilter[]	Логическое выражение "AND". Должно быть не менее 2 элементов.
dimension	ReportConfigComparisonExpression	Имеет выражение сравнения для измерения
not	ReportConfigFilter	Логическое выражение NOT.
or	ReportConfigFilter[]	Логическое выражение OR. Должно быть не менее 2 элементов.
tag	ReportConfigComparisonExpression	Имеет выражение сравнения для тега

ReportConfigGrouping

Object

Группа по выражению, используемая в отчете.

Имя	Тип	Описание
columnType	ReportConfigColumnType	Имеет тип столбца для группировки.
name	string	Имя столбца для группировки.

ReportConfigTimePeriod

Object

Дата начала и окончания извлечения данных для отчета.

Имя	Тип	Описание
from	string (date-time)	Дата начала извлечения данных.
to	string (date-time)	Дата окончания извлечения данных.

ReportType

Перечисление

Тип отчета.

Значение	Описание
Usage

TimeframeType

Перечисление

Интервал времени для извлечения данных для отчета. Если это настраивается, необходимо указать определенный период времени.

Значение	Описание
WeekToDate
MonthToDate
YearToDate
Custom

Поделиться через

Query Billing Account - Query Billing Account

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

BillingAccountQuery

Образец запроса

Пример ответа

Определения

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType