Views - Create Or Update

Riferimento

Servizio:: Cost Management

Versione API:: 2023-11-01

Operazione per creare o aggiornare una visualizzazione. L'operazione di aggiornamento richiede che l'eTag più recente sia impostato nella richiesta. È possibile ottenere l'eTag più recente eseguendo un'operazione get. L'operazione di creazione non richiede eTag.

PUT https://management.azure.com/providers/Microsoft.CostManagement/views/{viewName}?api-version=2023-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
viewName	path	True	string	Nome della vista
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.query.timeframe	True	ReportTimeframeType	Intervallo di tempo per il pull dei dati per il report. Se personalizzato, è necessario specificare un periodo di tempo specifico.
properties.query.type	True	ReportType	Tipo del report. L'utilizzo rappresenta l'utilizzo effettivo, la previsione rappresenta i dati previsti e UsageAndForecast rappresenta sia l'utilizzo che i dati previsti. L'utilizzo effettivo e i dati previsti possono essere differenziati in base alle date.
eTag		string	eTag della risorsa. Per gestire lo scenario di aggiornamento simultaneo, questo campo verrà usato per determinare se l'utente sta aggiornando la versione più recente o meno.
properties.accumulated		AccumulatedType	Mostra i costi accumulati nel tempo.
properties.chart		ChartType	Tipo di grafico della visualizzazione principale in Analisi dei costi. Obbligatorio.
properties.dateRange		string	Intervallo di date della visualizzazione corrente.
properties.displayName		string	Nome di input utente della vista. Obbligatorio.
properties.kpis		KpiProperties[]	Elenco degli indicatori KPI da visualizzare nell'interfaccia utente analisi dei costi.
properties.metric		MetricType	Metrica da usare durante la visualizzazione dei costi.
properties.modifiedOn		string	Data dell'ultima modifica dell'utente in questa visualizzazione.
properties.pivots		PivotProperties[]	Configurazione di 3 viste secondarie nell'interfaccia utente analisi costi.
properties.query.dataSet		ReportConfigDataset	Definizione per i dati in questa configurazione del report.
properties.query.includeMonetaryCommitment		boolean	Se true, la relazione include l'impegno monetario.
properties.query.timePeriod		ReportConfigTimePeriod	Periodo di tempo per il pull dei dati per il report.
properties.scope		string	Ambito Gestione costi in cui salvare la visualizzazione. Ciò include 'subscriptions/{subscriptionId}' per l'ambito della sottoscrizione, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per l'ambito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per l'ambito account di fatturazione, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId}' per ambito reparto, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' per l'ambito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per l'ambito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' per l'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.

Risposte

Nome	Tipo	Descrizione
200 OK	View	OK. La richiesta ha avuto esito positivo.
201 Created	View	Creazione riuscita.
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché 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

CreateOrUpdatePrivateView

Esempio di richiesta

HTTP

PUT https://management.azure.com/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2023-11-01

{
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "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"
      }
    ]
  }
}

Risposta di esempio

Codice di stato:: 201

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

Codice di stato:: 200

{
  "id": "/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ffa5a9c2430c\"",
  "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 l'attesa del tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".
FunctionType	Nome della funzione di aggregazione da utilizzare.
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 usare 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 usare 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	Raggruppamento 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 di previsione. L'utilizzo effettivo e i dati previsti possono essere differenziati in base alle date.
View	Stati e configurazioni di Analisi dei costi.

AccumulatedType

Mostra i costi accumulati nel tempo.

Nome	Tipo	Descrizione
false	string
true	string

ChartType

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

Nome	Tipo	Descrizione
Area	string
GroupedColumn	string
Line	string
StackedColumn	string
Table	string

ErrorDetails

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

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 l'attesa del tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

FunctionType

Nome della funzione di aggregazione da utilizzare.

Nome	Tipo	Descrizione
Sum	string

KpiProperties

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

Tipo di indicatore KPI (Previsione, Budget).

Nome	Tipo	Descrizione
Budget	string
Forecast	string

MetricType

Metrica da usare per la visualizzazione dei costi.

Nome	Tipo	Descrizione
AHUB	string
ActualCost	string
AmortizedCost	string

OperatorType

Operatore da usare per il confronto.

Nome	Tipo	Descrizione
Contains	string
In	string

PivotProperties

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

Tipo di dati da visualizzare nella visualizzazione.

Nome	Tipo	Descrizione
Dimension	string
TagKey	string

QueryColumnType

Tipo della colonna nell'esportazione.

Nome	Tipo	Descrizione
Dimension	string	Dimensione dei dati sui costi.
TagKey	string	Tag associato ai dati sui costi.

ReportConfigAggregation

Espressione di aggregazione da utilizzare nel report.

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

ReportConfigComparisonExpression

Espressione di confronto da usare nel report.

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

ReportConfigDataset

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 forniti aggregazioni e raggruppamenti.
filter	ReportConfigFilter	Dispone dell'espressione di filtro da usare nel report.
granularity	ReportGranularityType	Granularità delle righe nel report.
grouping	ReportConfigGrouping[]	Matrice di raggruppamento per espressione da utilizzare nel report. Il report può avere fino a 2 clausole group by.
sorting	ReportConfigSorting[]	Matrice di ordine in base all'espressione da usare nel report.

ReportConfigDatasetConfiguration

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

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	Espressione di confronto per un tag

ReportConfigGrouping

Raggruppamento per espressione da utilizzare nel report.

Nome	Tipo	Descrizione
name	string	Nome della colonna da raggruppare. Questa versione supporta la sottoscrizione con granularità minima possibile.
type	QueryColumnType	Tipo della colonna da raggruppare.

ReportConfigSorting

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

Direzione di ordinamento.

Nome	Tipo	Descrizione
Ascending	string
Descending	string

ReportConfigTimePeriod

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

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

ReportGranularityType

Granularità delle righe nel report.

Nome	Tipo	Descrizione
Daily	string
Monthly	string

ReportTimeframeType

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

Nome	Tipo	Descrizione
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

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 di previsione. L'utilizzo effettivo e i dati previsti possono essere differenziati in base alle date.

Nome	Tipo	Descrizione
Usage	string

View

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	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 di 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	Data dell'ultima modifica dell'utente in questa visualizzazione.
properties.pivots	PivotProperties[]	Configurazione di 3 sotto-visualizzazioni nell'interfaccia utente di Analisi costi.
properties.query.dataSet	ReportConfigDataset	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 di previsione. L'utilizzo effettivo e i dati previsti possono essere differenziati in base alle date.
properties.scope	string	Ambito gestione costi per 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 l'ambito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per l'ambito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' per l'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