Views - Create Or Update By Scope
Der Vorgang zum Erstellen oder Aktualisieren einer Ansicht. Für den Updatevorgang muss das neueste eTag in der Anforderung festgelegt werden. 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=2023-11-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
scope
|
path | True |
string |
Der Bereich, der Ansichtsvorgängen zugeordnet ist. Dies schließt "subscriptions/{subscriptionId}" für den Abonnementbereich ein, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" für resourceGroup-Bereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" für Abrechnungskontobereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" für abteilungsbereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für den Bereich EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" für BillingProfile-Bereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" für den Bereich "InvoiceSection", "providers/Microsoft.Management/managementGroups/{managementGroupId}" für verwaltungsgruppenbereich, "providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}" für den Bereich "Externes Abrechnungskonto" und "providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" für den Bereich "Externes Abonnement". |
view
|
path | True |
string |
Name der Ansicht |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties.query.timeframe | True |
Der Zeitrahmen für das Pullen von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden. |
|
properties.query.type | True |
Der Typ des Berichts. Die Verwendung stellt die tatsächliche Nutzung dar, die Vorhersage stellt prognostizierte Daten dar, und UsageAndForecast stellt sowohl Nutzungsdaten als auch prognostizierte Daten dar. Die tatsächliche Nutzung und die vorhergesagten Daten können anhand von Datumsangaben unterschieden werden. |
|
eTag |
string |
eTag der Ressource. Um gleichzeitige Updates zu verarbeiten, wird dieses Feld verwendet, um zu bestimmen, ob der Benutzer die neueste Version aktualisiert oder nicht. |
|
properties.accumulated |
Anzeigen der im Laufe der Zeit akkumulierten Kosten. |
||
properties.chart |
Diagrammtyp der Standard Ansicht in der Kostenanalyse. Erforderlich. |
||
properties.dateRange |
string |
Datumsbereich der aktuellen Ansicht. |
|
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.modifiedOn |
string |
Datum, an dem der Benutzer diese Ansicht zuletzt geändert hat. |
|
properties.pivots |
Konfiguration von drei Unteransichten auf der Benutzeroberfläche für die Kostenanalyse. |
||
properties.query.dataSet |
Verfügt über eine Definition für Daten in dieser Berichtskonfiguration. |
||
properties.query.includeMonetaryCommitment |
boolean |
Wenn true, enthält der Bericht eine geldpolitische Verpflichtung. |
|
properties.query.timePeriod |
Weist einen Zeitraum für das Pullen von Daten für den Bericht auf. |
||
properties.scope |
string |
Kostenverwaltungsbereich, in dem die Ansicht gespeichert werden soll. Dies schließt "subscriptions/{subscriptionId}" für den Abonnementbereich ein, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" für resourceGroup-Bereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" für Abrechnungskontobereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{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}/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 den ExternalSubscription-Bereich. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK. Die Anforderung war 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 | Beschreibung |
---|---|
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=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"
}
]
}
}
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
Name | Beschreibung |
---|---|
Accumulated |
Anzeigen der im Laufe der Zeit kumulierten Kosten. |
Chart |
Diagrammtyp der Standard Ansicht in der Kostenanalyse. Erforderlich. |
Error |
Die Details des Fehlers. |
Error |
Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten:
|
Function |
Der Name der zu verwendenden Aggregationsfunktion. |
Kpi |
Jede KPI muss einen "type" und "enabled"-Schlüssel enthalten. |
Kpi |
KPI-Typ (Forecast, Budget). |
Metric |
Metrik, die beim Anzeigen von Kosten verwendet werden soll. |
Operator |
Der für den Vergleich zu verwendende Operator. |
Pivot |
Jeder Pivot muss einen "typ" und "name" enthalten. |
Pivot |
Datentyp, der in der Ansicht angezeigt werden soll. |
Query |
Der Typ der Spalte im Export. |
Report |
Der Aggregationsausdruck, der im Bericht verwendet werden soll. |
Report |
Der Im Bericht zu verwendende Vergleichsausdruck. |
Report |
Die Definition der im Bericht vorhandenen Daten. |
Report |
Die Konfiguration des Datasets im Bericht. |
Report |
Der Filterausdruck, der im Bericht verwendet werden soll. |
Report |
Der gruppierungs-nach-Ausdruck, der im Bericht verwendet werden soll. |
Report |
Die Reihenfolge nach dem Ausdruck, der im Bericht verwendet werden soll. |
Report |
Richtung der Art. |
Report |
Das Start- und Enddatum für das Pulling von Daten für den Bericht. |
Report |
Die Granularität der Zeilen im Bericht. |
Report |
Der Zeitrahmen für das Pulling von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden. |
Report |
Der Typ des Berichts. Usage stellt die tatsächliche Nutzung dar, die Prognose stellt Vorhersagedaten dar, und UsageAndForecast stellt sowohl nutzungs- als auch prognostizierte Daten dar. Die tatsächliche Nutzung und die vorhergesagten Daten können anhand von Datumsangaben unterschieden werden. |
View |
Zustände und Konfigurationen der Kostenanalyse. |
AccumulatedType
Anzeigen der im Laufe der Zeit kumulierten Kosten.
Name | Typ | Beschreibung |
---|---|---|
false |
string |
|
true |
string |
ChartType
Diagrammtyp der Standard Ansicht in der Kostenanalyse. Erforderlich.
Name | Typ | Beschreibung |
---|---|---|
Area |
string |
|
GroupedColumn |
string |
|
Line |
string |
|
StackedColumn |
string |
|
Table |
string |
ErrorDetails
Die Details des Fehlers.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode |
message |
string |
Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist. |
ErrorResponse
Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
Einige Fehlerantworten:
429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.
503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Details des Fehlers. |
FunctionType
Der Name der zu verwendenden Aggregationsfunktion.
Name | Typ | Beschreibung |
---|---|---|
Sum |
string |
KpiProperties
Jede KPI muss einen "type" und "enabled"-Schlüssel enthalten.
Name | Typ | Beschreibung |
---|---|---|
enabled |
boolean |
KPI auf der Benutzeroberfläche anzeigen? |
id |
string |
ID der Ressource im Zusammenhang mit Metrik (Budget). |
type |
KPI-Typ (Forecast, Budget). |
KpiTypeType
KPI-Typ (Forecast, Budget).
Name | Typ | Beschreibung |
---|---|---|
Budget |
string |
|
Forecast |
string |
MetricType
Metrik, die beim Anzeigen von Kosten verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
AHUB |
string |
|
ActualCost |
string |
|
AmortizedCost |
string |
OperatorType
Der für den Vergleich zu verwendende Operator.
Name | Typ | Beschreibung |
---|---|---|
Contains |
string |
|
In |
string |
PivotProperties
Jeder Pivot muss einen "typ" und "name" enthalten.
Name | Typ | Beschreibung |
---|---|---|
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 | Typ | Beschreibung |
---|---|---|
Dimension |
string |
|
TagKey |
string |
QueryColumnType
Der Typ der Spalte im Export.
Name | Typ | Beschreibung |
---|---|---|
Dimension |
string |
Die Dimension von Kostendaten. |
TagKey |
string |
Das Tag, das den Kostendaten zugeordnet ist. |
ReportConfigAggregation
Der Aggregationsausdruck, der im Bericht verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
function |
Der Name der zu verwendenden Aggregationsfunktion. |
|
name |
string |
Der Name der zu aggregierenden Spalte. |
ReportConfigComparisonExpression
Der Im Bericht zu verwendende Vergleichsausdruck.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der Spalte, die im Vergleich verwendet werden soll. |
operator |
Der für den Vergleich zu verwendende Operator. |
|
values |
string[] |
Array von Werten, die für den Vergleich verwendet werden sollen |
ReportConfigDataset
Die Definition der im Bericht vorhandenen Daten.
Name | Typ | Beschreibung |
---|---|---|
aggregation |
<string,
Report |
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 |
Verfügt über einen Filterausdruck, der im Bericht verwendet werden soll. |
|
granularity |
Die Granularität der Zeilen im Bericht. |
|
grouping |
Array von Gruppierung nach Ausdruck, das im Bericht verwendet werden soll. Der Bericht kann bis zu 2 Group by-Klauseln enthalten. |
|
sorting |
Array von Reihenfolge nach Ausdruck, das im Bericht verwendet werden soll. |
ReportConfigDatasetConfiguration
Die Konfiguration des Datasets im Bericht.
Name | Typ | Beschreibung |
---|---|---|
columns |
string[] |
Array von Spaltennamen, die in den Bericht aufgenommen werden sollen. Jeder gültige Berichtsspaltenname ist zulässig. Falls nicht angegeben, enthält der Bericht alle Spalten. |
ReportConfigFilter
Der Filterausdruck, der im Bericht verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
and |
Der logische Ausdruck "AND". Muss mindestens 2 Elemente aufweisen. |
|
dimensions |
Verfügt über einen Vergleichsausdruck für eine Dimension |
|
or |
Der logische "OR"-Ausdruck. Muss mindestens 2 Elemente aufweisen. |
|
tags |
Hat einen Vergleichsausdruck für ein Tag |
ReportConfigGrouping
Der gruppierungs-nach-Ausdruck, der im Bericht verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der zu gruppierenden Spalte. Diese Version unterstützt das niedrigste mögliche Körnungsabonnement für Abonnements. |
type |
Hat den Typ der zu gruppierenden Spalte. |
ReportConfigSorting
Die Reihenfolge nach dem Ausdruck, der im Bericht verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
direction |
Richtung der Art. |
|
name |
string |
Der Name der zu sortierenden Spalte. |
ReportConfigSortingType
Richtung der Art.
Name | Typ | Beschreibung |
---|---|---|
Ascending |
string |
|
Descending |
string |
ReportConfigTimePeriod
Das Start- und Enddatum für das Pulling von Daten für den Bericht.
Name | Typ | Beschreibung |
---|---|---|
from |
string |
Das Startdatum, aus dem Daten abgerufen werden sollen. |
to |
string |
Das Enddatum, an das Daten abgerufen werden sollen. |
ReportGranularityType
Die Granularität der Zeilen im Bericht.
Name | Typ | Beschreibung |
---|---|---|
Daily |
string |
|
Monthly |
string |
ReportTimeframeType
Der Zeitrahmen für das Pulling von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Custom |
string |
|
MonthToDate |
string |
|
WeekToDate |
string |
|
YearToDate |
string |
ReportType
Der Typ des Berichts. Usage stellt die tatsächliche Nutzung dar, die Prognose stellt Vorhersagedaten dar, und UsageAndForecast stellt sowohl nutzungs- als auch prognostizierte Daten dar. Die tatsächliche Nutzung und die vorhergesagten Daten können anhand von Datumsangaben unterschieden werden.
Name | Typ | Beschreibung |
---|---|---|
Usage |
string |
View
Zustände und Konfigurationen der Kostenanalyse.
Name | Typ | Beschreibung |
---|---|---|
eTag |
string |
eTag der Ressource. Um gleichzeitiges Updateszenario zu behandeln, wird dieses Feld verwendet, um zu bestimmen, 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 kumulierten Kosten. |
|
properties.chart |
Diagrammtyp der Standard Ansicht 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 in der Benutzeroberfläche der Kostenanalyse 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 auf der Benutzeroberfläche für die Kostenanalyse. |
|
properties.query.dataSet |
Verfügt über eine Definition für Daten in dieser Berichtskonfiguration. |
|
properties.query.includeMonetaryCommitment |
boolean |
Wenn true, enthält der Bericht eine geldpolitische Verpflichtung. |
properties.query.timePeriod |
Weist einen Zeitraum für das Pullen von Daten für den Bericht auf. |
|
properties.query.timeframe |
Der Zeitrahmen für das Pulling von Daten für den Bericht. Wenn benutzerdefiniert, muss ein bestimmter Zeitraum angegeben werden. |
|
properties.query.type |
Der Typ des Berichts. Usage stellt die tatsächliche Nutzung dar, die Prognose stellt Vorhersagedaten dar, und UsageAndForecast stellt sowohl nutzungs- als auch prognostizierte Daten dar. Die tatsächliche Nutzung und die vorhergesagten Daten können anhand von Datumsangaben unterschieden werden. |
|
properties.scope |
string |
Cost Management-Bereich, für den die Ansicht gespeichert werden soll. Dies schließt "subscriptions/{subscriptionId}" für den Abonnementbereich ein. 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '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}/invoiceSections/{invoiceSectionId}' for InvoiceSection Scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' für den ExternalBillingAccount-Bereich und "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" für den ExternalSubscription-Bereich. |
type |
string |
Der Ressourcentyp. |