你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	计费帐户 ID
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

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: 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	资源 ID。
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