Query - Usage By External Cloud Provider Type
Consulte los datos de uso para el tipo de proveedor de nube externo definido.
POST https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query?api-version=2023-11-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
external
|
path | True |
string |
Puede ser '{externalSubscriptionId}' para la cuenta vinculada o '{externalBillingAccountId}' para la cuenta consolidada que se usa con operaciones de dimensión/consulta. |
external
|
path | True |
Tipo de proveedor de nube externo asociado a las operaciones de dimensión y consulta. Esto incluye "externalSubscriptions" para la cuenta vinculada y "externalBillingAccounts" para la cuenta consolidada. |
|
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
dataset | True |
Tiene la definición de los datos de esta consulta. |
|
timeframe | True |
Período de tiempo para extraer datos de la consulta. Si es personalizado, se debe proporcionar un período de tiempo específico. |
|
type | True |
Tipo de la consulta. |
|
timePeriod |
Tiene un período de tiempo para extraer datos de la consulta. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar. La solicitud se ha realizado correctamente. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
External |
External |
ExternalBillingAccountQueryList
Sample Request
POST https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/query?api-version=2023-11-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
}
}
Sample Response
{
"id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
"name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ServiceName",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
0,
"abc db",
"USD"
],
[
30.2572751438,
"abc compute cloud",
"USD"
],
[
0.07675760200000002,
"abc file system",
"USD"
],
[
50.43096419040001,
"abc elasticache",
"USD"
]
]
}
}
ExternalSubscriptionsQuery
Sample Request
POST https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/query?api-version=2023-11-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"filter": {
"and": [
{
"or": [
{
"dimensions": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tags": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimensions": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
}
}
Sample Response
{
"id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d",
"name": "d99477af-7510-40ee-aca2-e59bdca0d10d",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": []
}
}
Definiciones
Nombre | Description |
---|---|
Error |
Detalles del error. |
Error |
La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error:
|
Export |
Tipo de la consulta. |
external |
Tipo de proveedor de nube externo asociado a las operaciones de dimensión y consulta. Esto incluye "externalSubscriptions" para la cuenta vinculada y "externalBillingAccounts" para la cuenta consolidada. |
Function |
Nombre de la función de agregación que se va a usar. |
Granularity |
Granularidad de las filas de la previsión. |
Query |
Expresión de agregación que se va a usar en la consulta. |
Query |
Propiedades queryColumn |
Query |
Tipo de la columna de la exportación. |
Query |
Expresión de comparación que se va a usar en la consulta. |
Query |
Definición de datos presentes en la consulta. |
Query |
Configuración del conjunto de datos en la consulta. |
Query |
Definición de una consulta. |
Query |
Expresión de filtro que se va a usar en la exportación. |
Query |
Grupo por expresión que se va a usar en la consulta. |
Query |
Operador que se va a usar para la comparación. |
Query |
Resultado de la consulta. Contiene todas las columnas enumeradas en agrupaciones y agregaciones. |
Query |
Fecha de inicio y finalización para extraer datos de la consulta. |
Timeframe |
Período de tiempo para extraer datos de la consulta. Si es personalizado, se debe proporcionar un período de tiempo específico. |
ErrorDetails
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
La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
Algunas respuestas de error:
429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".
Nombre | Tipo | Description |
---|---|---|
error |
Detalles del error. |
ExportType
Tipo de la consulta.
Nombre | Tipo | Description |
---|---|---|
ActualCost |
string |
|
AmortizedCost |
string |
|
Usage |
string |
externalCloudProviderType
Tipo de proveedor de nube externo asociado a las operaciones de dimensión y consulta. Esto incluye "externalSubscriptions" para la cuenta vinculada y "externalBillingAccounts" para la cuenta consolidada.
Nombre | Tipo | Description |
---|---|---|
externalBillingAccounts |
string |
|
externalSubscriptions |
string |
FunctionType
Nombre de la función de agregación que se va a usar.
Nombre | Tipo | Description |
---|---|---|
Sum |
string |
GranularityType
Granularidad de las filas de la previsión.
Nombre | Tipo | Description |
---|---|---|
Daily |
string |
QueryAggregation
Expresión de agregación que se va a usar en la consulta.
Nombre | Tipo | Description |
---|---|---|
function |
Nombre de la función de agregación que se va a usar. |
|
name |
string |
Nombre de la columna que se va a agregar. |
QueryColumn
Propiedades queryColumn
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre de la columna. |
type |
string |
Tipo de columna. |
QueryColumnType
Tipo de la columna de la exportación.
Nombre | Tipo | Description |
---|---|---|
Dimension |
string |
Dimensión de los datos de costos. |
TagKey |
string |
Etiqueta asociada a los datos de costo. |
QueryComparisonExpression
Expresión de comparación que se va a usar en la consulta.
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre de la columna que se va a usar en comparación. |
operator |
Operador que se va a usar para la comparación. |
|
values |
string[] |
Matriz de valores que se van a usar para la comparación |
QueryDataset
Definición de datos presentes en la consulta.
Nombre | Tipo | Description |
---|---|---|
aggregation |
<string,
Query |
Diccionario de expresión de agregación que se va a usar en la consulta. La clave de cada elemento del diccionario es el alias de la columna agregada. La consulta puede tener hasta 2 cláusulas de agregación. |
configuration |
Tiene información de configuración para los datos de la exportación. La configuración se omitirá si se proporcionan la agregación y la agrupación. |
|
filter |
Expresión de filtro que se va a usar en la consulta. Consulte la documentación de REST de la API de consulta para obtener el formato correcto del filtro. |
|
granularity |
Granularidad de las filas de la consulta. |
|
grouping |
Matriz de agrupación por expresión que se va a usar en la consulta. La consulta puede tener hasta 2 cláusulas de grupo por. |
QueryDatasetConfiguration
Configuración del conjunto de datos en la consulta.
Nombre | Tipo | Description |
---|---|---|
columns |
string[] |
Matriz de nombres de columna que se incluirán en la consulta. Se permite cualquier nombre de columna de consulta válido. Si no se proporciona, la consulta incluye todas las columnas. |
QueryDefinition
Definición de una consulta.
Nombre | Tipo | Description |
---|---|---|
dataset |
Tiene la definición de los datos de esta consulta. |
|
timePeriod |
Tiene un período de tiempo para extraer datos de la consulta. |
|
timeframe |
Período de tiempo para extraer datos de la consulta. Si es personalizado, se debe proporcionar un período de tiempo específico. |
|
type |
Tipo de la consulta. |
QueryFilter
Expresión de filtro que se va a usar en la exportación.
Nombre | Tipo | Description |
---|---|---|
and |
Expresión lógica "AND". Debe tener al menos 2 elementos. |
|
dimensions |
Tiene una expresión de comparación para una dimensión |
|
or |
Expresión "OR" lógica. Debe tener al menos 2 elementos. |
|
tags |
Tiene una expresión de comparación para una etiqueta |
QueryGrouping
Grupo por expresión que se va a usar en la consulta.
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre de la columna que se va a agrupar. |
type |
Tiene el tipo de columna que se va a agrupar. |
QueryOperatorType
Operador que se va a usar para la comparación.
Nombre | Tipo | Description |
---|---|---|
In |
string |
QueryResult
Resultado de la consulta. Contiene todas las columnas enumeradas en agrupaciones y agregaciones.
Nombre | Tipo | Description |
---|---|---|
eTag |
string |
ETag del recurso. |
id |
string |
Identificador de recurso. |
location |
string |
Ubicación del recurso. |
name |
string |
Nombre del recurso. |
properties.columns |
Matriz de columnas |
|
properties.nextLink |
string |
Vínculo (url) a la página siguiente de resultados. |
properties.rows |
Rows[] |
Matriz de filas |
sku |
string |
SKU del recurso. |
tags |
object |
Etiquetas del recurso. |
type |
string |
Tipo de recurso. |
QueryTimePeriod
Fecha de inicio y finalización para extraer datos de la consulta.
Nombre | Tipo | Description |
---|---|---|
from |
string |
Fecha de inicio de la que se van a extraer datos. |
to |
string |
Fecha de finalización a la que se van a extraer datos. |
TimeframeType
Período de tiempo para extraer datos de la consulta. Si es personalizado, se debe proporcionar un período de tiempo específico.
Nombre | Tipo | Description |
---|---|---|
BillingMonthToDate |
string |
|
Custom |
string |
|
MonthToDate |
string |
|
TheLastBillingMonth |
string |
|
TheLastMonth |
string |
|
WeekToDate |
string |