Budgets - Create Or Update

Referenz

Dienst:: Consumption

API-Version:: 2024-08-01

Der Vorgang zum Erstellen oder Aktualisieren eines Budgets. Sie können optional ein eTag bereitstellen, wenn es sich um eine Form des Parallelitätssteuerelements handelt. Um das neueste eTag für ein bestimmtes Budget zu erhalten, führen Sie einen Get-Vorgang vor dem Put-Vorgang aus.

PUT https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2024-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
budgetName	path	True	string	Budgetname.
scope	path	True	string	Der Bereich, der budgetbezogenen Vorgängen zugeordnet ist. Dies schließt "/subscriptions/{subscriptionId}/" für den Abonnementbereich ein, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für den Ressourcengruppenbereich, '/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 enrollmentAccount-Bereich, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' für den Verwaltungsgruppenbereich, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' für billingProfile-Bereich, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' für invoiceSection-Bereich.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2023-03-01.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.amount	True	number (decimal)	Der Gesamtbetrag der Kosten, die mit dem Budget nachverfolgt werden sollen
properties.category	True	CategoryType	Die Kategorie des Budgets, unabhängig davon, ob das Budget Kosten oder Nutzung verfolgt.
properties.timeGrain	True	TimeGrainType	Die von einem Budget abgedeckte Zeit. Die Nachverfolgung der Menge wird basierend auf dem Zeitkorn zurückgesetzt. BillingMonth, BillingQuarter und BillingAnnual werden nur von WD-Kunden unterstützt.
properties.timePeriod	True	BudgetTimePeriod	Hat den Anfangs- und Endtermin des Budgets. Das Startdatum muss zuerst im Monat sein und sollte kleiner als das Enddatum sein. Der Starttermin des Budgets muss am oder nach dem 1. Juni 2017 erfolgen. Der zukünftige Anfangstermin darf nicht mehr als zwölf Monate betragen. Das datum der letzten Anfangstermine sollte innerhalb des Zeitgrainzeitraums ausgewählt werden. Es gibt keine Einschränkungen für das Enddatum.
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.
properties.filter		BudgetFilter	Kann verwendet werden, um Budgets nach benutzerdefinierten Dimensionen und/oder Tags zu filtern.
properties.notifications		<string, Notification>	Wörterbuch der Benachrichtigungen, die dem Budget zugeordnet sind. Das Budget kann bis zu fünf Benachrichtigungen aufweisen.

Antworten

Name	Typ	Beschreibung
200 OK	Budget	OKAY. Die Anforderung ist erfolgreich.
201 Created	Budget	Erstellt.
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

CreateOrUpdateBudget

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

Statuscode:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

Definitionen

Name	Beschreibung
Budget	Eine Budgetressource.
BudgetComparisonExpression	Der Vergleichsausdruck, der in den Budgets verwendet werden soll.
BudgetFilter	Kann verwendet werden, um Budgets nach Ressourcengruppe, Ressource oder Meter zu filtern.
BudgetFilterProperties	Die Dimensionen oder Tags, nach der ein Budget gefiltert werden soll.
BudgetOperatorType	Der für den Vergleich zu verwendende Operator.
BudgetTimePeriod	Der Anfangs- und Endtermin für ein Budget.
CategoryType	Die Kategorie des Budgets, unabhängig davon, ob das Budget Kosten oder Nutzung verfolgt.
CultureCode	Sprache, in der der Empfänger die Benachrichtigung erhält
CurrentSpend	Der aktuelle Kostenbetrag, der für ein Budget nachverfolgt wird.
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. 504 Gatewaytimeout – Diensttimeout beim Verarbeiten der Anforderung. Verringern Sie den Datumsbereich in der Anforderung, falls möglich.
ForecastSpend	Die prognostizierten Kosten, die für ein Budget nachverfolgt werden.
Notification	Die Benachrichtigung, die einem Budget zugeordnet ist.
OperatorType	Der Vergleichsoperator.
ThresholdType	Der Typ des Schwellenwerts
TimeGrainType	Die von einem Budget abgedeckte Zeit. Die Nachverfolgung der Menge wird basierend auf dem Zeitkorn zurückgesetzt. BillingMonth, BillingQuarter und BillingAnnual werden nur von WD-Kunden unterstützt.

Budget

Objekt

Eine Budgetressource.

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.amount	number (decimal)	Der Gesamtbetrag der Kosten, die mit dem Budget nachverfolgt werden sollen
properties.category	CategoryType	Die Kategorie des Budgets, unabhängig davon, ob das Budget Kosten oder Nutzung verfolgt.
properties.currentSpend	CurrentSpend	Der aktuelle Kostenbetrag, der für ein Budget nachverfolgt wird.
properties.filter	BudgetFilter	Kann verwendet werden, um Budgets nach benutzerdefinierten Dimensionen und/oder Tags zu filtern.
properties.forecastSpend	ForecastSpend	Die prognostizierten Kosten, die für ein Budget nachverfolgt werden.
properties.notifications	<string, Notification>	Wörterbuch der Benachrichtigungen, die dem Budget zugeordnet sind. Das Budget kann bis zu fünf Benachrichtigungen aufweisen.
properties.timeGrain	TimeGrainType	Die von einem Budget abgedeckte Zeit. Die Nachverfolgung der Menge wird basierend auf dem Zeitkorn zurückgesetzt. BillingMonth, BillingQuarter und BillingAnnual werden nur von WD-Kunden unterstützt.
properties.timePeriod	BudgetTimePeriod	Hat den Anfangs- und Endtermin des Budgets. Das Startdatum muss zuerst im Monat sein und sollte kleiner als das Enddatum sein. Der Starttermin des Budgets muss am oder nach dem 1. Juni 2017 erfolgen. Der zukünftige Anfangstermin darf nicht mehr als zwölf Monate betragen. Das datum der letzten Anfangstermine sollte innerhalb des Zeitgrainzeitraums ausgewählt werden. Es gibt keine Einschränkungen für das Enddatum.
type	string	Ressourcentyp.

BudgetComparisonExpression

Objekt

Der Vergleichsausdruck, der in den Budgets verwendet werden soll.

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

BudgetFilter

Objekt

Kann verwendet werden, um Budgets nach Ressourcengruppe, Ressource oder Meter zu filtern.

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

BudgetFilterProperties

Objekt

Die Dimensionen oder Tags, nach der ein Budget gefiltert werden soll.

Name	Typ	Beschreibung
dimensions	BudgetComparisonExpression	Hat einen Vergleichsausdruck für eine Dimension
tags	BudgetComparisonExpression	Hat einen Vergleichsausdruck für ein Tag

BudgetOperatorType

Enumeration

Der für den Vergleich zu verwendende Operator.

Wert	Beschreibung
In

BudgetTimePeriod

Objekt

Der Anfangs- und Endtermin für ein Budget.

Name	Typ	Beschreibung
endDate	string (date-time)	Das Enddatum für das Budget. Wenn nicht angegeben, wird dies standardmäßig auf 10 Jahre ab dem Startdatum festgelegt.
startDate	string (date-time)	Der Anfangstermin für das Budget.

CategoryType

Enumeration

Die Kategorie des Budgets, unabhängig davon, ob das Budget Kosten oder Nutzung verfolgt.

Wert	Beschreibung
Cost

CultureCode

Enumeration

Sprache, in der der Empfänger die Benachrichtigung erhält

Wert	Beschreibung
cs-cz
da-dk
de-de
en-gb
en-us
es-es
fr-fr
hu-hu
it-it
ja-jp
ko-kr
nb-no
nl-nl
pl-pl
pt-br
pt-pt
ru-ru
sv-se
tr-tr
zh-cn
zh-tw

CurrentSpend

Objekt

Der aktuelle Kostenbetrag, der für ein Budget nachverfolgt wird.

Name	Typ	Beschreibung
amount	number (decimal)	Der Gesamtbetrag der Kosten, die vom Budget nachverfolgt werden.
unit	string	Die Maßeinheit für den Budgetbetrag.

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.
504 Gatewaytimeout – Diensttimeout beim Verarbeiten der Anforderung. Verringern Sie den Datumsbereich in der Anforderung, falls möglich.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

ForecastSpend

Objekt

Die prognostizierten Kosten, die für ein Budget nachverfolgt werden.

Name	Typ	Beschreibung
amount	number (decimal)	Die prognostizierten Kosten für den gesamten Zeitraum, der vom Budget nachverfolgt wird. Dieser Wert wird nur bereitgestellt, wenn das Budget einen Prognosewarnungstyp enthält.
unit	string	Die Maßeinheit für den Budgetbetrag.

Notification

Objekt

Die Benachrichtigung, die einem Budget zugeordnet ist.

Name	Typ	Standardwert	Beschreibung
contactEmails	string[]		E-Mail-Adressen, an die die Budgetbenachrichtigung gesendet werden soll, wenn der Schwellenwert überschritten wird. Mindestens eine Kontakt-E-Mail oder Kontaktgruppe muss im Bereich "Abonnement" oder "Ressourcengruppe" angegeben sein. Alle anderen Bereiche müssen mindestens eine Kontakt-E-Mail angegeben haben.
contactGroups	string[]		Aktionsgruppen, an die die Budgetbenachrichtigung gesendet werden soll, wenn der Schwellenwert überschritten wird. Muss als vollqualifizierte Azure-Ressourcen-ID bereitgestellt werden. Wird nur für Abonnement- oder Ressourcengruppenbereiche unterstützt.
contactRoles	string[]		Kontaktrollen, an die die Budgetbenachrichtigung gesendet werden soll, wenn der Schwellenwert überschritten wird.
enabled	boolean		Die Benachrichtigung ist aktiviert oder nicht.
locale	CultureCode		Sprache, in der der Empfänger die Benachrichtigung erhält
operator	OperatorType		Der Vergleichsoperator.
threshold	number (decimal)		Schwellenwert, der einer Benachrichtigung zugeordnet ist. Die Benachrichtigung wird gesendet, wenn die Kosten den Schwellenwert überschritten haben. Es ist immer Prozent und muss zwischen 0 und 1000 liegen.
thresholdType	ThresholdType	Actual	Der Typ des Schwellenwerts

OperatorType

Enumeration

Der Vergleichsoperator.

Wert	Beschreibung
EqualTo	Warnung wird ausgelöst, wenn die ausgewerteten Kosten mit dem Schwellenwert übereinstimmen. Hinweis: Es wird nicht empfohlen, diesen OperatorType zu verwenden, da die Wahrscheinlichkeit gering ist, dass die Kosten exakt dem Schwellenwert entsprechen, was zu fehlender Warnung führt. Dieser OperatorType wird in Zukunft nicht mehr unterstützt.
GreaterThan	Warnung wird ausgelöst, wenn die ausgewerteten Kosten größer als der Schwellenwert sind. Hinweis: Dies ist der empfohlene OperatorType beim Konfigurieren der Budgetbenachrichtigung.
GreaterThanOrEqualTo	Warnung wird ausgelöst, wenn die ausgewerteten Kosten größer oder gleich dem Schwellenwert sind.

ThresholdType

Enumeration

Der Typ des Schwellenwerts

Wert	Beschreibung
Actual	Ist-Kostenbudgetbenachrichtigungen benachrichtigen, wenn die tatsächlichen aufgelaufenen Kosten das zugeordnete Budget überschreiten.
Forecasted	Warnungen zu prognostizierten Kostenbudgets bieten erweiterte Benachrichtigungen darüber, dass Ihre Ausgabentrends ihr zugewiesenes Budget wahrscheinlich überschreiten, da sie auf prognostizierte Kostenvorhersagen angewiesen sind.

TimeGrainType

Enumeration

Die von einem Budget abgedeckte Zeit. Die Nachverfolgung der Menge wird basierend auf dem Zeitkorn zurückgesetzt. BillingMonth, BillingQuarter und BillingAnnual werden nur von WD-Kunden unterstützt.

Wert	Beschreibung
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

Freigeben über

Budgets - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

CreateOrUpdateBudget

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Zusätzliche Ressourcen