Views - Get

Riferimento

Servizio:: Cost Management

Versione API:: 2024-08-01

Ottiene la visualizzazione in base al nome della vista.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
viewName	path	True	string	Nome visualizzazione
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	View	OK. La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

PrivateView

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "id": "/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "",
    "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"
      }
    ]
  }
}

Definizioni

Nome	Descrizione
AccumulatedType	Mostra i costi accumulati nel tempo.
ChartType	Tipo di grafico della visualizzazione principale in Analisi dei costi. Obbligatorio.
ErrorDetails	Dettagli dell'errore.
ErrorResponse	La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore. Alcune risposte di errore: 429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".
FunctionType	Nome della funzione di aggregazione da usare.
KpiProperties	Ogni indicatore KPI deve contenere una chiave 'type' e 'enabled'.
KpiTypeType	Tipo di indicatore KPI (Previsione, Budget).
MetricType	Metrica da usare per la visualizzazione dei costi.
OperatorType	Operatore da utilizzare per il confronto.
PivotProperties	Ogni pivot deve contenere un 'type' e 'name'.
PivotTypeType	Tipo di dati da visualizzare nella visualizzazione.
QueryColumnType	Tipo della colonna nell'esportazione.
ReportConfigAggregation	Espressione di aggregazione da utilizzare nel report.
ReportConfigComparisonExpression	Espressione di confronto da utilizzare nel report.
ReportConfigDataset	Definizione dei dati presenti nel report.
ReportConfigDatasetConfiguration	Configurazione del set di dati nel report.
ReportConfigFilter	Espressione di filtro da utilizzare nel report.
ReportConfigGrouping	Gruppo per espressione da utilizzare nel report.
ReportConfigSorting	Ordine in base all'espressione da utilizzare nel report.
ReportConfigSortingType	Direzione di ordinamento.
ReportConfigTimePeriod	Data di inizio e fine per il pull dei dati per il report.
ReportGranularityType	Granularità delle righe nel report.
ReportTimeframeType	Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.
ReportType	Tipo del report. L'utilizzo rappresenta l'utilizzo effettivo, la previsione rappresenta i dati previsti e UsageAndForecast rappresenta sia i dati di utilizzo che i dati previsti. I dati effettivi di utilizzo e previsione possono essere differenziati in base alle date.
View	Stati e configurazioni di Analisi dei costi.

AccumulatedType

Enumerazione

Mostra i costi accumulati nel tempo.

Valore	Descrizione
false
true

ChartType

Enumerazione

Tipo di grafico della visualizzazione principale in Analisi dei costi. Obbligatorio.

Valore	Descrizione
Area
GroupedColumn
Line
StackedColumn
Table

ErrorDetails

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ErrorResponse

Object

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

FunctionType

Enumerazione

Nome della funzione di aggregazione da usare.

Valore	Descrizione
Sum

KpiProperties

Object

Ogni indicatore KPI deve contenere una chiave 'type' e 'enabled'.

Nome	Tipo	Descrizione
enabled	boolean	visualizzare l'indicatore KPI nell'interfaccia utente?
id	string	ID della risorsa correlata alla metrica (budget).
type	KpiTypeType	Tipo di indicatore KPI (Previsione, Budget).

KpiTypeType

Enumerazione

Tipo di indicatore KPI (Previsione, Budget).

Valore	Descrizione
Budget
Forecast

MetricType

Enumerazione

Metrica da usare per la visualizzazione dei costi.

Valore	Descrizione
AHUB
ActualCost
AmortizedCost

OperatorType

Enumerazione

Operatore da utilizzare per il confronto.

Valore	Descrizione
Contains
In

PivotProperties

Object

Ogni pivot deve contenere un 'type' e 'name'.

Nome	Tipo	Descrizione
name	string	Campo dati da visualizzare nella visualizzazione.
type	PivotTypeType	Tipo di dati da visualizzare nella visualizzazione.

PivotTypeType

Enumerazione

Tipo di dati da visualizzare nella visualizzazione.

Valore	Descrizione
Dimension
TagKey

QueryColumnType

Enumerazione

Tipo della colonna nell'esportazione.

Valore	Descrizione
Dimension	Dimensione dei dati sui costi.
TagKey	Tag associato ai dati sui costi.

ReportConfigAggregation

Object

Espressione di aggregazione da utilizzare nel report.

Nome	Tipo	Descrizione
function	FunctionType	Nome della funzione di aggregazione da usare.
name	string	Nome della colonna da aggregare.

ReportConfigComparisonExpression

Object

Espressione di confronto da utilizzare nel report.

Nome	Tipo	Descrizione
name	string	Nome della colonna da utilizzare in confronto.
operator	OperatorType	Operatore da utilizzare per il confronto.
values	string[]	Matrice di valori da usare per il confronto

ReportConfigDataset

Object

Definizione dei dati presenti nel report.

Nome	Tipo	Descrizione
aggregation	<string, ReportConfigAggregation>	Dizionario dell'espressione di aggregazione da usare nel report. La chiave di ogni elemento nel dizionario è l'alias per la colonna aggregata. Il report può avere fino a 2 clausole di aggregazione.
configuration	ReportConfigDatasetConfiguration	Contiene informazioni di configurazione per i dati nel report. La configurazione verrà ignorata se vengono fornite aggregazioni e raggruppamento.
filter	ReportConfigFilter	Dispone dell'espressione di filtro da utilizzare nel report.
granularity	ReportGranularityType	Granularità delle righe nel report.
grouping	ReportConfigGrouping[]	Matrice di raggruppamento per espressione da usare nel report. Il report può avere fino a 2 clausole group by.
sorting	ReportConfigSorting[]	Matrice dell'ordine in base all'espressione da utilizzare nel report.

ReportConfigDatasetConfiguration

Object

Configurazione del set di dati nel report.

Nome	Tipo	Descrizione
columns	string[]	Matrice di nomi di colonna da includere nel report. È consentito qualsiasi nome di colonna del report valido. Se non specificato, il report include tutte le colonne.

ReportConfigFilter

Object

Espressione di filtro da utilizzare nel report.

Nome	Tipo	Descrizione
and	ReportConfigFilter[]	Espressione logica "AND". Deve contenere almeno 2 elementi.
dimensions	ReportConfigComparisonExpression	Espressione di confronto per una dimensione
or	ReportConfigFilter[]	Espressione logica "OR". Deve contenere almeno 2 elementi.
tags	ReportConfigComparisonExpression	Ha un'espressione di confronto per un tag

ReportConfigGrouping

Object

Gruppo per espressione da utilizzare nel report.

Nome	Tipo	Descrizione
name	string	Nome della colonna da raggruppare. Questa versione supporta la sottoscrizione più bassa possibile.
type	QueryColumnType	Tipo della colonna da raggruppare.

ReportConfigSorting

Object

Ordine in base all'espressione da utilizzare nel report.

Nome	Tipo	Descrizione
direction	ReportConfigSortingType	Direzione di ordinamento.
name	string	Nome della colonna da ordinare.

ReportConfigSortingType

Enumerazione

Direzione di ordinamento.

Valore	Descrizione
Ascending
Descending

ReportConfigTimePeriod

Object

Data di inizio e fine per il pull dei dati per il report.

Nome	Tipo	Descrizione
from	string (date-time)	Data di inizio da cui estrarre i dati.
to	string (date-time)	Data di fine in cui eseguire il pull dei dati.

ReportGranularityType

Enumerazione

Granularità delle righe nel report.

Valore	Descrizione
Daily
Monthly

ReportTimeframeType

Enumerazione

Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.

Valore	Descrizione
Custom
MonthToDate
WeekToDate
YearToDate

ReportType

Enumerazione

Tipo del report. L'utilizzo rappresenta l'utilizzo effettivo, la previsione rappresenta i dati previsti e UsageAndForecast rappresenta sia i dati di utilizzo che i dati previsti. I dati effettivi di utilizzo e previsione possono essere differenziati in base alle date.

Valore	Descrizione
Usage

View

Object

Stati e configurazioni di Analisi dei costi.

Nome	Tipo	Descrizione
eTag	string	eTag della risorsa. Per gestire lo scenario di aggiornamento simultaneo, questo campo verrà usato per determinare se l'utente sta aggiornando o meno la versione più recente.
id	string	ID risorsa.
name	string	Nome risorsa.
properties.accumulated	AccumulatedType	Mostra i costi accumulati nel tempo.
properties.chart	ChartType	Tipo di grafico della visualizzazione principale in Analisi dei costi. Obbligatorio.
properties.createdOn	string (date-time)	Data di creazione della visualizzazione da parte dell'utente.
properties.currency	string	Valuta della visualizzazione corrente.
properties.dateRange	string	Intervallo di date della visualizzazione corrente.
properties.displayName	string	Nome di input dell'utente della visualizzazione. Obbligatorio.
properties.kpis	KpiProperties[]	Elenco degli indicatori KPI da visualizzare nell'interfaccia utente di Analisi dei costi.
properties.metric	MetricType	Metrica da usare per la visualizzazione dei costi.
properties.modifiedOn	string (date-time)	Data dell'ultima modifica dell'utente in questa visualizzazione.
properties.pivots	PivotProperties[]	Configurazione di 3 visualizzazioni secondarie nell'interfaccia utente di Analisi costi.
properties.query.dataSet	ReportConfigDataset	Ha una definizione per i dati in questa configurazione del report.
properties.query.includeMonetaryCommitment	boolean	Se true, il report include l'impegno monetario.
properties.query.timePeriod	ReportConfigTimePeriod	Periodo di tempo per il pull dei dati per il report.
properties.query.timeframe	ReportTimeframeType	Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.
properties.query.type	ReportType	Tipo del report. L'utilizzo rappresenta l'utilizzo effettivo, la previsione rappresenta i dati previsti e UsageAndForecast rappresenta sia i dati di utilizzo che i dati previsti. I dati effettivi di utilizzo e previsione possono essere differenziati in base alle date.
properties.scope	string	Ambito di Gestione costi in cui salvare la visualizzazione. Sono inclusi 'subscriptions/{subscriptionId}' per l'ambito della sottoscrizione, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per ambito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per ambito account di fatturazione, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' per ambito reparto, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' per ambito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per ambito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' per ambito InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' per ambito gruppo di gestione, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' per l'ambito ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' per l'ambito ExternalSubscription.
type	string	Tipo di risorsa.

Condividi tramite

Views - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

PrivateView

Esempio di richiesta

Risposta di esempio

Definizioni

AccumulatedType

ChartType

ErrorDetails

ErrorResponse

FunctionType

KpiProperties

KpiTypeType

MetricType

OperatorType

PivotProperties

PivotTypeType

QueryColumnType

ReportConfigAggregation

ReportConfigComparisonExpression

ReportConfigDataset

ReportConfigDatasetConfiguration

ReportConfigFilter

ReportConfigGrouping

ReportConfigSorting

ReportConfigSortingType

ReportConfigTimePeriod

ReportGranularityType

ReportTimeframeType

ReportType

View

Risorse aggiuntive