Budgets - Get

Referenz

Service:: Consumption

API Version:: 2023-05-01

Ruft das Budget für den Bereich anhand des Budgetnamens ab.

GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2023-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
budgetName	path	True	string	Budgetname.
scope	path	True	string	Der Bereich, der Budgetvorgä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.Management/managementGroups/{managementGroupId}" für verwaltungsgruppenbereich, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" für den Bereich billingProfile, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" für den Bereich "invoiceSection".
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2023-03-01.

Antworten

Name	Typ	Beschreibung
200 OK	Budget	OK. Die Anforderung war erfolgreich.
Other Status Codes	ErrorResponse	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

Budget

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget?api-version=2023-05-01

Sample Response

Status code:: 200

{
  "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,
        "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 Verbrauchseinheit zu filtern.
BudgetFilterProperties	Die Dimensionen oder Tags, nach der ein Budget gefiltert werden soll.
BudgetOperatorType	Der für den Vergleich zu verwendende Operator.
BudgetTimePeriod	Das Start- und Enddatum für ein Budget.
CategoryType	Die Kategorie des Budgets, unabhängig davon, ob das Budget die Kosten oder die Nutzung nachverfolgt.
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	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.
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 durch ein Budget abgedeckte Zeit. Die Nachverfolgung des Betrags wird basierend auf dem Zeitintervall zurückgesetzt. BillingMonth, BillingQuarter und BillingAnnual werden nur von WD-Kunden unterstützt.

Budget

Eine Budgetressource.

Name	Typ	Beschreibung
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.
id	string	Ressourcen-ID.
name	string	Name der Ressource.
properties.amount	number	Der Gesamtbetrag der Kosten, die mit dem Budget nachverfolgt werden sollen
properties.category	CategoryType	Die Kategorie des Budgets, unabhängig davon, ob das Budget die Kosten oder die Nutzung nachverfolgt.
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 enthalten.
properties.timeGrain	TimeGrainType	Die durch ein Budget abgedeckte Zeit. Die Nachverfolgung des Betrags wird basierend auf dem Zeitintervall zurückgesetzt. BillingMonth, BillingQuarter und BillingAnnual werden nur von WD-Kunden unterstützt.
properties.timePeriod	BudgetTimePeriod	Hat Das Start- und Enddatum des Budgets. Das Startdatum muss der Erste des Monats sein und sollte kleiner als das Enddatum sein. Das Startdatum des Budgets muss am oder nach dem 1. Juni 2017 sein. Das zukünftige Startdatum darf nicht mehr als zwölf Monate betragen. Das vergangene Startdatum sollte innerhalb des Zeitgrainzeitraums ausgewählt werden. Es gibt keine Einschränkungen für das Enddatum.
type	string	Der Ressourcentyp.

BudgetComparisonExpression

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

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

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

BudgetFilterProperties

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

Der für den Vergleich zu verwendende Operator.

Name	Typ	Beschreibung
In	string

BudgetTimePeriod

Das Start- und Enddatum für ein Budget.

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

CategoryType

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

Name	Typ	Beschreibung
Cost	string

CultureCode

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

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

CurrentSpend

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

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

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	ErrorDetails	Die Details des Fehlers.

ForecastSpend

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

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

Notification

Die Benachrichtigung, die einem Budget zugeordnet ist.

Name	Typ	Standardwert	Beschreibung
contactEmails	string[]		Email Adressen, an die die Budgetbenachrichtigung gesendet werden soll, wenn der Schwellenwert überschritten wird. Mindestens eine Kontakt-E-Mail oder Kontaktgruppe muss im Abonnement- oder Ressourcengruppenbereich angegeben sein. Für alle anderen Bereiche muss mindestens eine Kontakt-E-Mail angegeben sein.
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 im Abonnement- oder Ressourcengruppenbereich 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		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 sein.
thresholdType	ThresholdType	Actual	Der Typ des Schwellenwerts

OperatorType

Der Vergleichsoperator.

Name	Typ	Beschreibung
EqualTo	string	Eine 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 genau dem Schwellenwert entsprechen, was dazu führt, dass Ihre Warnung fehlt. Dieser OperatorType wird in Zukunft veraltet sein.
GreaterThan	string	Eine Warnung wird ausgelöst, wenn die ausgewerteten Kosten größer als der Schwellenwert sind. Hinweis: Dies ist der empfohlene OperatorType beim Konfigurieren der Budgetwarnung.
GreaterThanOrEqualTo	string	Eine Warnung wird ausgelöst, wenn die ausgewerteten Kosten größer oder gleich dem Schwellenwert sind.

ThresholdType

Der Typ des Schwellenwerts

Name	Typ	Beschreibung
Actual	string	Ist-Kostenbudgetwarnungen werden benachrichtigt, wenn die tatsächlichen aufgelaufenen Kosten das zugeordnete Budget überschreiten.
Forecasted	string	Budgetwarnungen für prognostizierte Kosten bieten eine erweiterte Benachrichtigung darüber, dass Ihre Ausgabentrends ihr zugewiesenes Budget wahrscheinlich überschreiten, da sie auf prognostizierten Kostenvorhersagen basieren.

TimeGrainType

Die durch ein Budget abgedeckte Zeit. Die Nachverfolgung des Betrags wird basierend auf dem Zeitintervall zurückgesetzt. BillingMonth, BillingQuarter und BillingAnnual werden nur von WD-Kunden unterstützt.

Name	Typ	Beschreibung
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
Quarterly	string

Share via

Budgets - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Budget

Sample Request

Sample Response

Definitionen

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Zusätzliche Ressourcen