Query Billing Account - Query Billing Account

Servicio:: Cost Management

Versión de la API:: 2018-05-31

Enumera los datos de uso de la cuenta de facturación.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingAccountId	path	True	string	ID de cuenta de facturación
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2018-05-31.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
timeframe	True	TimeframeType	Período de tiempo para extraer datos para el informe. Si es personalizado, se debe proporcionar un período de tiempo específico.
type	True	ReportType	Tipo del informe.
dataset		ReportConfigDataset	Tiene definición para los datos de esta configuración de informe.
timePeriod		ReportConfigTimePeriod	Tiene un período de tiempo para extraer datos para el informe.

Respuestas

Nombre	Tipo	Description
200 OK	QueryResult	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

BillingAccountQuery

Solicitud de ejemplo

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"
            ]
          }
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 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
          ]
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
FunctionType	Nombre de la función de agregación que se va a usar.
GranularityType	Granularidad de las filas del informe.
OperatorType	Operador que se va a usar para la comparación.
Query
QueryColumn
QueryResult	Resultado de la consulta. Contiene todas las columnas enumeradas en agrupaciones y agregaciones.
ReportConfigAggregation	Expresión de agregación que se va a usar en el informe.
ReportConfigColumnType	Tipo de la columna del informe.
ReportConfigComparisonExpression	Expresión de comparación que se va a usar en el informe.
ReportConfigDataset	Definición de los datos presentes en el informe.
ReportConfigDatasetConfiguration	Configuración del conjunto de datos en el informe.
ReportConfigDefinition	Definición de una configuración de informe.
ReportConfigFilter	Expresión de filtro que se va a usar en el informe.
ReportConfigGrouping	Grupo por expresión que se va a usar en el informe.
ReportConfigTimePeriod	Fecha de inicio y finalización para extraer datos del informe.
ReportType	Tipo del informe.
TimeframeType	Período de tiempo para extraer datos para el informe. Si es personalizado, se debe proporcionar un período de tiempo específico.

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

Object

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

FunctionType

Enumeración

Nombre de la función de agregación que se va a usar.

Valor	Description
Sum

GranularityType

Enumeración

Granularidad de las filas del informe.

Valor	Description
Daily

OperatorType

Enumeración

Operador que se va a usar para la comparación.

Valor	Description
In

Query

Object

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.columns	QueryColumn[]	Matriz de columnas
properties.nextLink	string
properties.rows	Rows[]
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

QueryColumn

Object

Nombre	Tipo	Description
name	string
type	string

QueryResult

Object

Resultado de la consulta. Contiene todas las columnas enumeradas en agrupaciones y agregaciones.

Nombre	Tipo	Description
value	Query[]	Lista de datos de uso.

ReportConfigAggregation

Object

Expresión de agregación que se va a usar en el informe.

Nombre	Tipo	Description
function	FunctionType	Nombre de la función de agregación que se va a usar.
name	string	Nombre de la columna que se va a agregar.

ReportConfigColumnType

Enumeración

Tipo de la columna del informe.

Valor	Description
Tag
Dimension

ReportConfigComparisonExpression

Object

Expresión de comparación que se va a usar en el informe.

Nombre	Tipo	Description
name	string	Nombre de la columna que se va a usar en comparación.
operator	OperatorType	Operador que se va a usar para la comparación.
values	string[]	Matriz de valores que se van a usar para la comparación

ReportConfigDataset

Object

Definición de los datos presentes en el informe.

Nombre	Tipo	Description
aggregation	<string, ReportConfigAggregation>	Diccionario de expresiones de agregación que se van a usar en el informe. La clave de cada elemento del diccionario es el alias de la columna agregada. El informe puede tener hasta 2 cláusulas de agregación.
configuration	ReportConfigDatasetConfiguration	Tiene información de configuración para los datos del informe. La configuración se omitirá si se proporcionan la agregación y la agrupación.
filter	ReportConfigFilter	Tiene la expresión de filtro que se va a usar en el informe.
granularity	GranularityType	Granularidad de las filas del informe.
grouping	ReportConfigGrouping[]	Matriz de agrupación por expresión que se va a usar en el informe. El informe puede tener hasta 2 cláusulas group by.

ReportConfigDatasetConfiguration

Object

Configuración del conjunto de datos en el informe.

Nombre	Tipo	Description
columns	string[]	Matriz de nombres de columna que se van a incluir en el informe. Se permite cualquier nombre de columna de informe válido. Si no se proporciona, el informe incluye todas las columnas.

ReportConfigDefinition

Object

Definición de una configuración de informe.

Nombre	Tipo	Description
dataset	ReportConfigDataset	Tiene definición para los datos de esta configuración de informe.
timePeriod	ReportConfigTimePeriod	Tiene un período de tiempo para extraer datos para el informe.
timeframe	TimeframeType	Período de tiempo para extraer datos para el informe. Si es personalizado, se debe proporcionar un período de tiempo específico.
type	ReportType	Tipo del informe.

ReportConfigFilter

Object

Expresión de filtro que se va a usar en el informe.

Nombre	Tipo	Description
and	ReportConfigFilter[]	Expresión "AND" lógica. Debe tener al menos 2 elementos.
dimension	ReportConfigComparisonExpression	Tiene una expresión de comparación para una dimensión
not	ReportConfigFilter	Expresión lógica "NOT".
or	ReportConfigFilter[]	Expresión "OR" lógica. Debe tener al menos 2 elementos.
tag	ReportConfigComparisonExpression	Tiene expresión de comparación para una etiqueta

ReportConfigGrouping

Object

Grupo por expresión que se va a usar en el informe.

Nombre	Tipo	Description
columnType	ReportConfigColumnType	Tiene el tipo de columna que se va a agrupar.
name	string	Nombre de la columna que se va a agrupar.

ReportConfigTimePeriod

Object

Fecha de inicio y finalización para extraer datos del informe.

Nombre	Tipo	Description
from	string (date-time)	Fecha de inicio de la que se van a extraer datos.
to	string (date-time)	Fecha de finalización a la que se van a extraer los datos.

ReportType

Enumeración

Tipo del informe.

Valor	Description
Usage

TimeframeType

Enumeración

Período de tiempo para extraer datos para el informe. Si es personalizado, se debe proporcionar un período de tiempo específico.

Valor	Description
WeekToDate
MonthToDate
YearToDate
Custom

Compartir a través de

Query Billing Account - Query Billing Account

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

BillingAccountQuery

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorDetails

ErrorResponse

FunctionType

GranularityType

OperatorType

Query

QueryColumn

QueryResult

ReportConfigAggregation

ReportConfigColumnType

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigDefinition

ReportConfigFilter

ReportConfigGrouping

ReportConfigTimePeriod

ReportType

TimeframeType