Views - Get

Referenz

Dienst:: Cost Management

API-Version:: 2024-08-01

Ruft die Ansicht nach Ansichtsname ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
viewName	path	True	string	Ansichtsname
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	View	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

PrivateView

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AccumulatedType	Anzeigen der im Laufe der Zeit gesammelten Kosten.
ChartType	Diagrammtyp der Hauptansicht in der Kostenanalyse. Erforderlich.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten: 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
FunctionType	Der Name der zu verwendenden Aggregationsfunktion.
KpiProperties	Jeder KPI muss einen "Typ" und einen "aktivierten" Schlüssel enthalten.
KpiTypeType	KPI-Typ (Prognose, Budget).
MetricType	Metrik, die beim Anzeigen von Kosten verwendet werden soll.
OperatorType	Der für den Vergleich zu verwendende Operator.
PivotProperties	Jeder Pivot muss einen 'Typ' und 'Name' enthalten.
PivotTypeType	Datentyp, der in der Ansicht angezeigt werden soll.
QueryColumnType	Der Typ der Spalte im Export.
ReportConfigAggregation	Der Aggregationsausdruck, der im Bericht verwendet werden soll.
ReportConfigComparisonExpression	Der im Bericht zu verwendende Vergleichsausdruck.
ReportConfigDataset	Die Definition der daten, die im Bericht vorhanden sind.
ReportConfigDatasetConfiguration	Die Konfiguration des Datasets im Bericht.
ReportConfigFilter	Der filterausdruck, der im Bericht verwendet werden soll.
ReportConfigGrouping	Die Gruppe nach Ausdruck, die im Bericht verwendet werden soll.
ReportConfigSorting	Die Reihenfolge nach Ausdruck, die im Bericht verwendet werden soll.
ReportConfigSortingType	Sortierrichtung.
ReportConfigTimePeriod	Das Start- und Enddatum für das Abrufen von Daten für den Bericht.
ReportGranularityType	Die Granularität der Zeilen im Bericht.
ReportTimeframeType	Der Zeitrahmen zum Abrufen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.
ReportType	Der Typ des Berichts. Die Verwendung stellt die tatsächliche Nutzung dar, die Prognose stellt prognostizierte Daten dar und UsageAndForecast stellt sowohl Nutzungs- als auch Prognosedaten dar. Tatsächliche Nutzungs- und Prognosedaten können basierend auf Datumsangaben unterschieden werden.
View	Zustände und Konfigurationen der Kostenanalyse.

AccumulatedType

Enumeration

Anzeigen der im Laufe der Zeit gesammelten Kosten.

Wert	Beschreibung
false
true

ChartType

Enumeration

Diagrammtyp der Hauptansicht in der Kostenanalyse. Erforderlich.

Wert	Beschreibung
Area
GroupedColumn
Line
StackedColumn
Table

ErrorDetails

Objekt

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.
503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

FunctionType

Enumeration

Der Name der zu verwendenden Aggregationsfunktion.

Wert	Beschreibung
Sum

KpiProperties

Objekt

Jeder KPI muss einen "Typ" und einen "aktivierten" Schlüssel enthalten.

Name	Typ	Beschreibung
enabled	boolean	KPI in der Benutzeroberfläche anzeigen?
id	string	ID der Ressource im Zusammenhang mit der Metrik (Budget).
type	KpiTypeType	KPI-Typ (Prognose, Budget).

KpiTypeType

Enumeration

KPI-Typ (Prognose, Budget).

Wert	Beschreibung
Budget
Forecast

MetricType

Enumeration

Metrik, die beim Anzeigen von Kosten verwendet werden soll.

Wert	Beschreibung
AHUB
ActualCost
AmortizedCost

OperatorType

Enumeration

Der für den Vergleich zu verwendende Operator.

Wert	Beschreibung
Contains
In

PivotProperties

Objekt

Jeder Pivot muss einen 'Typ' und 'Name' enthalten.

Name	Typ	Beschreibung
name	string	Datenfeld, das in der Ansicht angezeigt werden soll.
type	PivotTypeType	Datentyp, der in der Ansicht angezeigt werden soll.

PivotTypeType

Enumeration

Datentyp, der in der Ansicht angezeigt werden soll.

Wert	Beschreibung
Dimension
TagKey

QueryColumnType

Enumeration

Der Typ der Spalte im Export.

Wert	Beschreibung
Dimension	Die Dimension der Kostendaten.
TagKey	Das Tag, das den Kostendaten zugeordnet ist.

ReportConfigAggregation

Objekt

Der Aggregationsausdruck, der im Bericht verwendet werden soll.

Name	Typ	Beschreibung
function	FunctionType	Der Name der zu verwendenden Aggregationsfunktion.
name	string	Der Name der zu aggregierenden Spalte.

ReportConfigComparisonExpression

Objekt

Der im Bericht zu verwendende Vergleichsausdruck.

Name	Typ	Beschreibung
name	string	Der Name der Spalte, die im Vergleich verwendet werden soll.
operator	OperatorType	Der für den Vergleich zu verwendende Operator.
values	string[]	Array von Werten, die für den Vergleich verwendet werden sollen

ReportConfigDataset

Objekt

Die Definition der daten, die im Bericht vorhanden sind.

Name	Typ	Beschreibung
aggregation	<string, ReportConfigAggregation>	Wörterbuch des Aggregationsausdrucks, der im Bericht verwendet werden soll. Der Schlüssel der einzelnen Elemente im Wörterbuch ist der Alias für die aggregierte Spalte. Der Bericht kann bis zu 2 Aggregationsklauseln aufweisen.
configuration	ReportConfigDatasetConfiguration	Enthält Konfigurationsinformationen für die Daten im Bericht. Die Konfiguration wird ignoriert, wenn Aggregation und Gruppierung bereitgestellt werden.
filter	ReportConfigFilter	Hat Filterausdruck, der im Bericht verwendet werden soll.
granularity	ReportGranularityType	Die Granularität der Zeilen im Bericht.
grouping	ReportConfigGrouping[]	Array von Gruppieren nach Ausdruck, das im Bericht verwendet werden soll. Der Bericht kann bis zu 2 Gruppen nach Klauseln aufweisen.
sorting	ReportConfigSorting[]	Array der Reihenfolge nach Ausdruck, das im Bericht verwendet werden soll.

ReportConfigDatasetConfiguration

Objekt

Die Konfiguration des Datasets im Bericht.

Name	Typ	Beschreibung
columns	string[]	Array von Spaltennamen, die in den Bericht aufgenommen werden sollen. Ein beliebiger gültiger Berichtsspaltenname ist zulässig. Wenn nicht angegeben, enthält der Bericht alle Spalten.

ReportConfigFilter

Objekt

Der filterausdruck, der im Bericht verwendet werden soll.

Name	Typ	Beschreibung
and	ReportConfigFilter[]	Der logische Ausdruck "AND". Mindestens 2 Elemente müssen enthalten sein.
dimensions	ReportConfigComparisonExpression	Hat einen Vergleichsausdruck für eine Dimension
or	ReportConfigFilter[]	Der logische "OR"-Ausdruck. Mindestens 2 Elemente müssen enthalten sein.
tags	ReportConfigComparisonExpression	Hat einen Vergleichsausdruck für ein Tag

ReportConfigGrouping

Objekt

Die Gruppe nach Ausdruck, die im Bericht verwendet werden soll.

Name	Typ	Beschreibung
name	string	Der Name der spalte, die gruppiert werden soll. Diese Version unterstützt das Abonnement mit möglichst geringem Getreide.
type	QueryColumnType	Weist den Typ der zu gruppierenden Spalte auf.

ReportConfigSorting

Objekt

Die Reihenfolge nach Ausdruck, die im Bericht verwendet werden soll.

Name	Typ	Beschreibung
direction	ReportConfigSortingType	Sortierrichtung.
name	string	Der Name der zu sortierenden Spalte.

ReportConfigSortingType

Enumeration

Sortierrichtung.

Wert	Beschreibung
Ascending
Descending

ReportConfigTimePeriod

Objekt

Das Start- und Enddatum für das Abrufen von Daten für den Bericht.

Name	Typ	Beschreibung
from	string (date-time)	Das Startdatum, aus dem Daten abgerufen werden sollen.
to	string (date-time)	Das Enddatum, in das Daten abgerufen werden sollen.

ReportGranularityType

Enumeration

Die Granularität der Zeilen im Bericht.

Wert	Beschreibung
Daily
Monthly

ReportTimeframeType

Enumeration

Der Zeitrahmen zum Abrufen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.

Wert	Beschreibung
Custom
MonthToDate
WeekToDate
YearToDate

ReportType

Enumeration

Der Typ des Berichts. Die Verwendung stellt die tatsächliche Nutzung dar, die Prognose stellt prognostizierte Daten dar und UsageAndForecast stellt sowohl Nutzungs- als auch Prognosedaten dar. Tatsächliche Nutzungs- und Prognosedaten können basierend auf Datumsangaben unterschieden werden.

Wert	Beschreibung
Usage

View

Objekt

Zustände und Konfigurationen der Kostenanalyse.

Name	Typ	Beschreibung
eTag	string	eTag der Ressource. Um das Szenario für gleichzeitige Updates zu behandeln, wird dieses Feld verwendet, um zu bestimmen, ob der Benutzer die neueste Version aktualisiert oder nicht.
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.accumulated	AccumulatedType	Anzeigen der im Laufe der Zeit gesammelten Kosten.
properties.chart	ChartType	Diagrammtyp der Hauptansicht in der Kostenanalyse. Erforderlich.
properties.createdOn	string (date-time)	Datum, an dem der Benutzer diese Ansicht erstellt hat.
properties.currency	string	Währung der aktuellen Ansicht.
properties.dateRange	string	Datumsbereich der aktuellen Ansicht.
properties.displayName	string	Benutzereingabename der Ansicht. Erforderlich.
properties.kpis	KpiProperties[]	Liste der KPIs, die in der Kostenanalyse-Benutzeroberfläche angezeigt werden sollen.
properties.metric	MetricType	Metrik, die beim Anzeigen von Kosten verwendet werden soll.
properties.modifiedOn	string (date-time)	Datum, an dem der Benutzer diese Ansicht zuletzt geändert hat.
properties.pivots	PivotProperties[]	Konfiguration von drei Unteransichten in der Kostenanalyse-Benutzeroberfläche.
properties.query.dataSet	ReportConfigDataset	Enthält definition für Daten in dieser Berichtskonfiguration.
properties.query.includeMonetaryCommitment	boolean	Wenn wahr, enthält der Bericht geldpolitische Verpflichtungen.
properties.query.timePeriod	ReportConfigTimePeriod	Hat einen Zeitraum für das Abrufen von Daten für den Bericht.
properties.query.timeframe	ReportTimeframeType	Der Zeitrahmen zum Abrufen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.
properties.query.type	ReportType	Der Typ des Berichts. Die Verwendung stellt die tatsächliche Nutzung dar, die Prognose stellt prognostizierte Daten dar und UsageAndForecast stellt sowohl Nutzungs- als auch Prognosedaten dar. Tatsächliche Nutzungs- und Prognosedaten können basierend auf Datumsangaben unterschieden werden.
properties.scope	string	Kostenverwaltungsbereich zum Speichern der Ansicht Dies umfasst "abonnements/{subscriptionId}" für den Abonnementbereich, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für resourceGroup-Bereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' für Abteilungsbereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für enrollmentAccount-Bereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' für den Bereich 'ExternalBillingAccount' und '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' für externalSubscription-Bereich.
type	string	Ressourcentyp.

Freigeben über

Views - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

PrivateView

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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

Zusätzliche Ressourcen