Views - Get By Scope

Referencia

Servicio:: Cost Management

Versión de la API:: 2024-08-01

Obtiene la vista del ámbito definido por nombre de vista.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/views/{viewName}?api-version=2024-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
scope	path	True	string	Ámbito asociado a las operaciones de vista. Esto incluye "subscriptions/{subscriptionId}" para el ámbito de la suscripción, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito de la cuenta de facturación, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para el ámbito department, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para el ámbito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para el ámbito invoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' para el ámbito del grupo de administración, 'providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}" para el ámbito de la cuenta de facturación externa y "providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" para el ámbito de la suscripción externa.
viewName	path	True	string	Nombre de la vista
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	View	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

ResourceGroupView

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2024-08-01

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG",
    "query": {
      "type": "Usage",
      "timeframe": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "aggregation": {
          "totalCost": {
            "name": "PreTaxCost",
            "function": "Sum"
          }
        },
        "grouping": [],
        "sorting": [
          {
            "direction": "Ascending",
            "name": "UsageDate"
          }
        ]
      }
    },
    "chart": "Table",
    "accumulated": "true",
    "metric": "ActualCost",
    "kpis": [
      {
        "type": "Forecast",
        "id": null,
        "enabled": true
      },
      {
        "type": "Budget",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo",
        "enabled": true
      }
    ],
    "pivots": [
      {
        "type": "Dimension",
        "name": "ServiceName"
      },
      {
        "type": "Dimension",
        "name": "MeterCategory"
      },
      {
        "type": "TagKey",
        "name": "swaggerTagKey"
      }
    ]
  }
}

Definiciones

Nombre	Description
AccumulatedType	Muestra los costos acumulados a lo largo del tiempo.
ChartType	Tipo de gráfico de la vista principal en Análisis de costos. Obligatorio.
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. 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 "Retry-After".
FunctionType	Nombre de la función de agregación que se va a usar.
KpiProperties	Cada KPI debe contener una clave "type" y "enabled".
KpiTypeType	Tipo de KPI (previsión, presupuesto).
MetricType	Métrica que se va a usar al mostrar los costos.
OperatorType	Operador que se va a usar para la comparación.
PivotProperties	Cada tabla dinámica debe contener un "tipo" y "name".
PivotTypeType	Tipo de datos que se va a mostrar en la vista.
QueryColumnType	Tipo de la columna de la exportación.
ReportConfigAggregation	Expresión de agregación que se va a usar en el 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.
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.
ReportConfigSorting	Orden por expresión que se va a usar en el informe.
ReportConfigSortingType	Dirección de ordenación.
ReportConfigTimePeriod	Fecha de inicio y finalización para extraer datos del informe.
ReportGranularityType	Granularidad de las filas del informe.
ReportTimeframeType	Período de tiempo para extraer datos para el informe. Si es personalizado, se debe proporcionar un período de tiempo específico.
ReportType	Tipo del informe. El uso representa el uso real, la previsión representa los datos previstos y UsageAndForecast representa los datos de uso y previsión. El uso real y los datos previstos se pueden diferenciar en función de las fechas.
View	Estados y configuraciones de Análisis de costos.

AccumulatedType

Muestra los costos acumulados a lo largo del tiempo.

Nombre	Tipo	Description
false	string
true	string

ChartType

Tipo de gráfico de la vista principal en Análisis de costos. Obligatorio.

Nombre	Tipo	Description
Area	string
GroupedColumn	string
Line	string
StackedColumn	string
Table	string

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 "Retry-After".

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

FunctionType

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

Nombre	Tipo	Description
Sum	string

KpiProperties

Cada KPI debe contener una clave "type" y "enabled".

Nombre	Tipo	Description
enabled	boolean	¿muestra el KPI en la interfaz de usuario?
id	string	Identificador del recurso relacionado con la métrica (presupuesto).
type	KpiTypeType	Tipo de KPI (previsión, presupuesto).

KpiTypeType

Tipo de KPI (previsión, presupuesto).

Nombre	Tipo	Description
Budget	string
Forecast	string

MetricType

Métrica que se va a usar al mostrar los costos.

Nombre	Tipo	Description
AHUB	string
ActualCost	string
AmortizedCost	string

OperatorType

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

Nombre	Tipo	Description
Contains	string
In	string

PivotProperties

Cada tabla dinámica debe contener un "tipo" y "name".

Nombre	Tipo	Description
name	string	Campo de datos que se va a mostrar en la vista.
type	PivotTypeType	Tipo de datos que se va a mostrar en la vista.

PivotTypeType

Tipo de datos que se va a mostrar en la vista.

Nombre	Tipo	Description
Dimension	string
TagKey	string

QueryColumnType

Tipo de la columna de la exportación.

Nombre	Tipo	Description
Dimension	string	Dimensión de los datos de costo.
TagKey	string	Etiqueta asociada a los datos de costo.

ReportConfigAggregation

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.

ReportConfigComparisonExpression

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

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	ReportGranularityType	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.
sorting	ReportConfigSorting[]	Matriz de orden por expresión que se va a usar en el informe.

ReportConfigDatasetConfiguration

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.

ReportConfigFilter

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.
dimensions	ReportConfigComparisonExpression	Tiene una expresión de comparación para una dimensión
or	ReportConfigFilter[]	Expresión "OR" lógica. Debe tener al menos 2 elementos.
tags	ReportConfigComparisonExpression	Tiene expresión de comparación para una etiqueta

ReportConfigGrouping

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

Nombre	Tipo	Description
name	string	Nombre de la columna que se va a agrupar. Esta versión admite el nivel más bajo posible de la suscripción.
type	QueryColumnType	Tiene el tipo de columna que se va a agrupar.

ReportConfigSorting

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

Nombre	Tipo	Description
direction	ReportConfigSortingType	Dirección de ordenación.
name	string	Nombre de la columna que se va a ordenar.

ReportConfigSortingType

Dirección de ordenación.

Nombre	Tipo	Description
Ascending	string
Descending	string

ReportConfigTimePeriod

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

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 los datos.

ReportGranularityType

Granularidad de las filas del informe.

Nombre	Tipo	Description
Daily	string
Monthly	string

ReportTimeframeType

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

Nombre	Tipo	Description
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

ReportType

Tipo del informe. El uso representa el uso real, la previsión representa los datos previstos y UsageAndForecast representa los datos de uso y previsión. El uso real y los datos previstos se pueden diferenciar en función de las fechas.

Nombre	Tipo	Description
Usage	string

View

Estados y configuraciones de Análisis de costos.

Nombre	Tipo	Description
eTag	string	eTag del recurso. Para controlar el escenario de actualización simultánea, este campo se usará para determinar si el usuario está actualizando la versión más reciente o no.
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.accumulated	AccumulatedType	Muestra los costos acumulados a lo largo del tiempo.
properties.chart	ChartType	Tipo de gráfico de la vista principal en Análisis de costos. Obligatorio.
properties.createdOn	string	Fecha en que el usuario creó esta vista.
properties.currency	string	Moneda de la vista actual.
properties.dateRange	string	Intervalo de fechas de la vista actual.
properties.displayName	string	Nombre de entrada de usuario de la vista. Obligatorio.
properties.kpis	KpiProperties[]	Lista de KPI que se van a mostrar en La interfaz de usuario de análisis de costos.
properties.metric	MetricType	Métrica que se va a usar al mostrar los costos.
properties.modifiedOn	string	Fecha en que el usuario modificó esta vista por última vez.
properties.pivots	PivotProperties[]	Configuración de 3 sub-vistas en la interfaz de usuario de análisis de costos.
properties.query.dataSet	ReportConfigDataset	Tiene definición para los datos de esta configuración de informe.
properties.query.includeMonetaryCommitment	boolean	Si es true, el informe incluye el compromiso monetario.
properties.query.timePeriod	ReportConfigTimePeriod	Tiene un período de tiempo para extraer datos para el informe.
properties.query.timeframe	ReportTimeframeType	Período de tiempo para extraer datos para el informe. Si es personalizado, se debe proporcionar un período de tiempo específico.
properties.query.type	ReportType	Tipo del informe. El uso representa el uso real, la previsión representa los datos previstos y UsageAndForecast representa los datos de uso y previsión. El uso real y los datos previstos se pueden diferenciar en función de las fechas.
properties.scope	string	Ámbito de Cost Management en el que guardar la vista. Esto incluye "subscriptions/{subscriptionId}" para el ámbito de la suscripción, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito de la cuenta de facturación, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para el ámbito department, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para el ámbito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para el ámbito invoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' para el ámbito del grupo de administración, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' para el ámbito ExternalBillingAccount y '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para el ámbito ExternalSubscription.
type	string	Tipo de recurso.

Compartir a través de