Views - Create Or Update By Scope

Der Vorgang zum Erstellen oder Aktualisieren einer Ansicht. Der Aktualisierungsvorgang erfordert, dass das neueste eTag in der Anforderung festgelegt wird. Sie können das neueste eTag abrufen, indem Sie einen Get-Vorgang ausführen. Der Erstellungsvorgang erfordert kein eTag.

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

URI-Parameter

Name In Required Type Description
scope
path True
  • string

Der Bereich, der mit Ansichtsvorgängen verknüpft ist. Dies umfasst "Abonnements/{subscriptionId}" für den Abonnementbereich, "Abonnements/{subscriptionId}/resourceGroups/{resourceGroupName}" für ressourcenGroup-Bereich, "Anbieter/Microsoft.Billing/billingAccounts/{billingAccountId}" für Abrechnungskontobereich, "Provider/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingAccounts/{departmentId}" für Abteilungsbereich, "Anbieter/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/{ registrierungsAccountId}' für den Bereich "EnrollmentAccount", 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccounts/{invoiceSectionId}' for InvoiceSectionId}' for InvoiceSection Scope, 'providers/Microsoft.ManagementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' für den Bereich "Externe Abrechnungskonto" und "Anbieter/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" für den Bereich "Externes Abonnement".

viewName
path True
  • string

Name der Ansicht

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name Required Type Description
properties.query.timeframe True

Der Zeitrahmen für das Abrufen von Daten für den Bericht. Wenn benutzerdefinierter Zeitraum angegeben werden muss, muss ein bestimmter Zeitraum bereitgestellt werden.

properties.query.type True

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

eTag
  • string

eTag der Ressource. Um das gleichzeitige Updateszenario zu behandeln, wird dieses Feld verwendet, um festzustellen, ob der Benutzer die neueste Version aktualisiert oder nicht.

properties.accumulated

Zeigen Sie die im Laufe der Zeit gesammelten Kosten an.

properties.chart

Diagrammtyp der Hauptansicht in der Kostenanalyse. Erforderlich.

properties.displayName
  • string

Benutzereingabename der Ansicht. Erforderlich.

properties.kpis

Liste der KPIs, die in der Benutzeroberfläche für Die Kostenanalyse angezeigt werden sollen.

properties.metric

Metrik, die beim Anzeigen von Kosten verwendet werden soll.

properties.pivots

Konfiguration von 3 Unteransichten in der Kostenanalyse-Benutzeroberfläche.

properties.query.dataSet

Hat Definition für Daten in dieser Berichtskonfiguration.

properties.query.includeMonetaryCommitment
  • boolean

Wenn true, enthält der Bericht geldpolitische Verpflichtung.

properties.query.timePeriod

Verfügt über einen Zeitraum für das Abrufen von Daten für den Bericht.

properties.scope
  • string

Kostenverwaltungsbereich zum Speichern der Ansicht. Dies umfasst "Abonnements/{subscriptionId}" für den Abonnementbereich, "Abonnements/{subscriptionId}/resourceGroups/{resourceGroupName}" für ressourcenGroup-Bereich, "Anbieter/Microsoft.Billing/billingAccounts/{billingAccountId}" für Abrechnungskontobereich, "Provider/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingAccounts/{departmentId}" für Abteilungsbereich, "Anbieter/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/{ registrierungsAccountId}' für den Bereich "EnrollmentAccount", 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccounts/{invoiceSectionId}' for InvoiceSectionId}' for InvoiceSection Scope, 'providers/Microsoft.ManagementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' für den Bereich "ExternalBillingAccount" und "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" für den Bereich "ExternalSubscriptionName}".

Antworten

Name Type Description
200 OK

OK. Die Anforderung ist erfolgreich.

201 Created

Erstellt.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ResourceGroupCreateOrUpdateView

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2021-10-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"
      }
    ]
  }
}

Sample Response

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

Definitionen

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. Versuchen Sie es erneut, nachdem Sie auf die in der Kopfzeile "x-ms-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit warten.

  • 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.

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 operator, der zum Vergleich verwendet werden soll.

PivotProperties

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

PivotTypeType

Datentyp, der in der Ansicht angezeigt werden soll.

ReportConfigAggregation

Der Aggregationsausdruck, der im Bericht verwendet werden soll.

ReportConfigColumnType

Der Typ der Spalte im Bericht.

ReportConfigComparisonExpression

Der im Bericht zu verwendende Vergleichsausdruck.

ReportConfigDataset

Die Definition von 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 von Zeilen im Bericht.

ReportTimeframeType

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

ReportType

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

View

Zustände und Konfigurationen der Kostenanalyse.

AccumulatedType

Anzeigen der im Laufe der Zeit gesammelten Kosten.

Name Type Description
false
  • string
true
  • string

ChartType

Diagrammtyp der Hauptansicht in der Kostenanalyse. Erforderlich.

Name Type Description
Area
  • string
GroupedColumn
  • string
Line
  • string
StackedColumn
  • string
Table
  • string

ErrorDetails

Die Details des Fehlers.

Name Type Description
code
  • string

Fehlercode

message
  • string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

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. Versuchen Sie es erneut, nachdem Sie auf die in der Kopfzeile "x-ms-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit warten.

  • 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.

Name Type Description
error

Die Details des Fehlers.

FunctionType

Der Name der zu verwendenden Aggregationsfunktion.

Name Type Description
Sum
  • string

KpiProperties

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

Name Type Description
enabled
  • boolean

KPI in der Benutzeroberfläche anzeigen?

id
  • string

ID der Ressource im Zusammenhang mit Metrik (Budget).

type

KPI-Typ (Prognose, Budget).

KpiTypeType

KPI-Typ (Prognose, Budget).

Name Type Description
Budget
  • string
Forecast
  • string

MetricType

Metrik, die beim Anzeigen von Kosten verwendet werden soll.

Name Type Description
AHUB
  • string
ActualCost
  • string
AmortizedCost
  • string

OperatorType

Der operator, der zum Vergleich verwendet werden soll.

Name Type Description
Contains
  • string
In
  • string

PivotProperties

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

Name Type Description
name
  • string

Datenfeld, das in der Ansicht angezeigt werden soll.

type

Datentyp, der in der Ansicht angezeigt werden soll.

PivotTypeType

Datentyp, der in der Ansicht angezeigt werden soll.

Name Type Description
Dimension
  • string
TagKey
  • string

ReportConfigAggregation

Der Aggregationsausdruck, der im Bericht verwendet werden soll.

Name Type Description
function

Der Name der zu verwendenden Aggregationsfunktion.

name
  • string

Der Name der zu aggregierenden Spalte.

ReportConfigColumnType

Der Typ der Spalte im Bericht.

Name Type Description
Dimension
  • string
Tag
  • string

ReportConfigComparisonExpression

Der im Bericht zu verwendende Vergleichsausdruck.

Name Type Description
name
  • string

Der Name der Spalte, die im Vergleich verwendet werden soll.

operator

Der operator, der zum Vergleich verwendet werden soll.

values
  • string[]

Array von Werten, die für den Vergleich verwendet werden sollen

ReportConfigDataset

Die Definition von Daten, die im Bericht vorhanden sind.

Name Type Description
aggregation

Wörterbuch des Aggregationsausdrucks, der im Bericht verwendet werden soll. Der Schlüssel jedes Elements im Wörterbuch ist der Alias für die aggregierte Spalte. Der Bericht kann bis zu 2 Aggregationsklauseln aufweisen.

configuration

Enthält Konfigurationsinformationen für die Daten im Bericht. Die Konfiguration wird ignoriert, wenn Aggregation und Gruppierung bereitgestellt werden.

filter

Hat Filterausdruck, der im Bericht verwendet werden soll.

granularity

Die Granularität von Zeilen im Bericht.

grouping

Array der Gruppe nach Ausdruck, die im Bericht verwendet werden soll. Der Bericht kann bis zu 2 Gruppen nach Klauseln aufweisen.

sorting

Array der Reihenfolge nach Ausdruck, der im Bericht verwendet werden soll.

ReportConfigDatasetConfiguration

Die Konfiguration des Datasets im Bericht.

Name Type Description
columns
  • string[]

Array von Spaltennamen, die in den Bericht einbezogen werden sollen. Ein beliebiger gültiger Berichtsspaltenname ist zulässig. Falls nicht angegeben, enthält der Bericht alle Spalten.

ReportConfigFilter

Der filterausdruck, der im Bericht verwendet werden soll.

Name Type Description
and

Der logische "AND"-Ausdruck. Muss mindestens 2 Elemente enthalten.

dimensions

Hat Vergleichsausdruck für eine Dimension

or

Der logische "OR"-Ausdruck. Muss mindestens 2 Elemente enthalten.

tags

Hat Vergleichsausdruck für ein Tag

ReportConfigGrouping

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

Name Type Description
name
  • string

Der Name der zu gruppierenden Spalte. Diese Version unterstützt ein Abonnement, das am niedrigsten möglichen Getreidewert ist.

type

Weist den Typ der zu gruppierenden Spalte auf.

ReportConfigSorting

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

Name Type Description
direction

Sortierrichtung.

name
  • string

Der Name der zu sortierenden Spalte.

ReportConfigSortingType

Sortierrichtung.

Name Type Description
Ascending
  • string
Descending
  • string

ReportConfigTimePeriod

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

Name Type Description
from
  • string

Das Startdatum, aus dem Daten abgerufen werden sollen.

to
  • string

Das Enddatum, an das Daten abgerufen werden sollen.

ReportGranularityType

Die Granularität von Zeilen im Bericht.

Name Type Description
Daily
  • string
Monthly
  • string

ReportTimeframeType

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

Name Type Description
Custom
  • string
MonthToDate
  • string
WeekToDate
  • string
YearToDate
  • string

ReportType

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

Name Type Description
Usage
  • string

View

Zustände und Konfigurationen der Kostenanalyse.

Name Type Description
eTag
  • string

eTag der Ressource. Um das Szenario für gleichzeitiges Update zu behandeln, wird dieses Feld verwendet, um festzustellen, ob der Benutzer die neueste Version aktualisiert oder nicht.

id
  • string

Ressourcen-ID.

name
  • string

Name der Ressource.

properties.accumulated

Anzeigen der im Laufe der Zeit gesammelten Kosten.

properties.chart

Diagrammtyp der Hauptansicht in der Kostenanalyse. Erforderlich.

properties.createdOn
  • string

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

Liste der KPIs, die auf der Kostenanalyse-Benutzeroberfläche angezeigt werden sollen.

properties.metric

Metrik, die beim Anzeigen von Kosten verwendet werden soll.

properties.modifiedOn
  • string

Datum, an dem der Benutzer diese Ansicht zuletzt geändert hat.

properties.pivots

Konfiguration von 3 Unteransichten in der Kostenanalyse-Benutzeroberfläche.

properties.query.dataSet

Enthält Definition für Daten in dieser Berichtskonfiguration.

properties.query.includeMonetaryCommitment
  • boolean

Wenn wahr, enthält der Bericht eine geldpolitische Verpflichtung.

properties.query.timePeriod

Verfügt über einen Zeitraum für das Abrufen von Daten für den Bericht.

properties.query.timeframe

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

properties.query.type

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

properties.scope
  • string

Kostenverwaltungsbereich, um die Ansicht zu speichern. Dies schließt "abonnements/{subscriptionId}" für den Abonnementbereich ein, "abonnements/{subscriptionId}/resourceGroups/{resourceGroupName}" für den Bereich "resourceGroup", "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" für Abrechnungskontobereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{departmentId}" für Abteilungsbereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für den Bereich "EnrollmentAccount", 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{invoiceSectionId}' for 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 den Bereich "ExternalSubscriptionName}".

type
  • string

Der Ressourcentyp.