Budgets - Get

Referentie

Service:: Consumption

API-versie:: 2024-08-01

Hiermee haalt u het budget voor het bereik op budgetnaam op.

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

URI-parameters

Name	In	Vereist	Type	Description
budgetName	path	True	string	Budgetnaam.
scope	path	True	string	Het bereik dat is gekoppeld aan budgetbewerkingen. Dit omvat '/subscriptions/{subscriptionId}/' voor het abonnementsbereik, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' voor resourceGroup-bereik, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor het bereik van de factureringsrekening, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/afdelingen/{departmentId}' voor afdelingsbereik, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} voor het bereik EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' voor het bereik van de beheergroep, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor het bereik invoiceSection.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2023-03-01.

Antwoorden

Name	Type	Description
200 OK	Budget	OK. De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Budget

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Budget	Een budgetresource.
BudgetComparisonExpression	De vergelijkingsexpressie die moet worden gebruikt in de budgetten.
BudgetFilter	Kan worden gebruikt om budgetten te filteren op resourcegroep, resource of meter.
BudgetFilterProperties	De dimensies of tags om een budget te filteren.
BudgetOperatorType	De operator die moet worden gebruikt voor vergelijking.
BudgetTimePeriod	De begin- en einddatum voor een budget.
CategoryType	De categorie van het budget, ongeacht of het budget de kosten of het gebruik bijhoudt.
CultureCode	Taal waarin de ontvanger de melding ontvangt
CurrentSpend	Het huidige bedrag aan kosten dat wordt bijgehouden voor een budget.
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'. Time-out van 504 gateway: er is een time-out opgetreden voor de service tijdens het verwerken van de aanvraag. Verminder indien mogelijk het datumbereik in de aanvraag.
ForecastSpend	De geraamde kosten die worden bijgehouden voor een budget.
Notification	De melding die is gekoppeld aan een budget.
OperatorType	De vergelijkingsoperator.
ThresholdType	Het type drempelwaarde
TimeGrainType	De tijd die door een begroting wordt gedekt. Het bijhouden van de hoeveelheid wordt opnieuw ingesteld op basis van de tijdsinterval. BillingMonth, BillingQuarter en BillingAnnual worden alleen ondersteund door WD-klanten

Budget

Object

Een budgetresource.

Name	Type	Description
eTag	string	eTag van de resource. Voor het afhandelen van een gelijktijdig updatescenario wordt dit veld gebruikt om te bepalen of de gebruiker de nieuwste versie bijwerkt of niet.
id	string	Resource-id.
name	string	Resourcenaam.
properties.amount	number (decimal)	Het totale bedrag aan kosten dat moet worden bijgehouden met het budget
properties.category	CategoryType	De categorie van het budget, ongeacht of het budget de kosten of het gebruik bijhoudt.
properties.currentSpend	CurrentSpend	Het huidige bedrag aan kosten dat wordt bijgehouden voor een budget.
properties.filter	BudgetFilter	Kan worden gebruikt om budgetten te filteren op door de gebruiker opgegeven dimensies en/of tags.
properties.forecastSpend	ForecastSpend	De geraamde kosten die worden bijgehouden voor een budget.
properties.notifications	<string, Notification>	Woordenlijst met meldingen die zijn gekoppeld aan het budget. Budget kan maximaal vijf meldingen bevatten.
properties.timeGrain	TimeGrainType	De tijd die door een begroting wordt gedekt. Het bijhouden van de hoeveelheid wordt opnieuw ingesteld op basis van de tijdsinterval. BillingMonth, BillingQuarter en BillingAnnual worden alleen ondersteund door WD-klanten
properties.timePeriod	BudgetTimePeriod	Heeft de begin- en einddatum van het budget. De begindatum moet eerst van de maand zijn en moet kleiner zijn dan de einddatum. De begindatum van het budget moet op of na 1 juni 2017 zijn. De begindatum van de toekomst mag niet langer zijn dan twaalf maanden. De eerdere begindatum moet binnen de periode van de periode worden geselecteerd. Er gelden geen beperkingen voor de einddatum.
type	string	Resourcetype.

BudgetComparisonExpression

Object

De vergelijkingsexpressie die moet worden gebruikt in de budgetten.

Name	Type	Description
name	string	De naam van de kolom die moet worden gebruikt in vergelijking.
operator	BudgetOperatorType	De operator die moet worden gebruikt voor vergelijking.
values	string[]	Matrix met waarden die moeten worden gebruikt voor vergelijking

BudgetFilter

Object

Kan worden gebruikt om budgetten te filteren op resourcegroep, resource of meter.

Name	Type	Description
and	BudgetFilterProperties[]	De logische 'AND'-expressie. Moet ten minste 2 items bevatten.
dimensions	BudgetComparisonExpression	Heeft een vergelijkingsexpressie voor een dimensie
tags	BudgetComparisonExpression	Heeft een vergelijkingsexpressie voor een tag

BudgetFilterProperties

Object

De dimensies of tags om een budget te filteren.

Name	Type	Description
dimensions	BudgetComparisonExpression	Heeft een vergelijkingsexpressie voor een dimensie
tags	BudgetComparisonExpression	Heeft een vergelijkingsexpressie voor een tag

BudgetOperatorType

Inventarisatie

De operator die moet worden gebruikt voor vergelijking.

Waarde	Description
In

BudgetTimePeriod

Object

De begin- en einddatum voor een budget.

Name	Type	Description
endDate	string (date-time)	De einddatum voor het budget. Indien niet opgegeven, wordt dit standaard ingesteld op 10 jaar vanaf de begindatum.
startDate	string (date-time)	De begindatum voor het budget.

CategoryType

Inventarisatie

De categorie van het budget, ongeacht of het budget de kosten of het gebruik bijhoudt.

Waarde	Description
Cost

CultureCode

Inventarisatie

Taal waarin de ontvanger de melding ontvangt

Waarde	Description
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

Object

Het huidige bedrag aan kosten dat wordt bijgehouden voor een budget.

Name	Type	Description
amount	number (decimal)	Het totale bedrag aan kosten dat door het budget wordt bijgehouden.
unit	string	De maateenheid voor het budgetbedrag.

ErrorDetails

Object

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Object

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Enkele foutberichten:

429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
Time-out van 504 gateway: er is een time-out opgetreden voor de service tijdens het verwerken van de aanvraag. Verminder indien mogelijk het datumbereik in de aanvraag.

Name	Type	Description
error	ErrorDetails	De details van de fout.

ForecastSpend

Object

De geraamde kosten die worden bijgehouden voor een budget.

Name	Type	Description
amount	number (decimal)	De geraamde kosten voor de totale periode die door het budget wordt bijgehouden. Deze waarde wordt alleen opgegeven als het budget een waarschuwingstype voor een prognose bevat.
unit	string	De maateenheid voor het budgetbedrag.

Notification

Object

De melding die is gekoppeld aan een budget.

Name	Type	Default value	Description
contactEmails	string[]		E-mailadressen voor het verzenden van de budgetmelding naar wanneer de drempelwaarde wordt overschreden. Er moet ten minste één e-mailadres of groep contactpersonen zijn opgegeven in de bereiken Abonnement of Resourcegroep. Alle andere bereiken moeten ten minste één e-mail met contactpersonen hebben opgegeven.
contactGroups	string[]		Actiegroepen om de budgetmelding te verzenden wanneer de drempelwaarde wordt overschreden. Moet worden opgegeven als een volledig gekwalificeerde Azure-resource-id. Alleen ondersteund in bereiken van abonnement of resourcegroep.
contactRoles	string[]		Neem contact op met rollen om de budgetmelding te verzenden wanneer de drempelwaarde wordt overschreden.
enabled	boolean		De melding is ingeschakeld of niet.
locale	CultureCode		Taal waarin de ontvanger de melding ontvangt
operator	OperatorType		De vergelijkingsoperator.
threshold	number (decimal)		Drempelwaarde die is gekoppeld aan een melding. Er wordt een melding verzonden wanneer de kosten de drempelwaarde hebben overschreden. Het is altijd procent en moet tussen 0 en 1000 zijn.
thresholdType	ThresholdType	Actual	Het type drempelwaarde

OperatorType

Inventarisatie

De vergelijkingsoperator.

Waarde	Description
EqualTo	Waarschuwing wordt geactiveerd als de geëvalueerde kosten gelijk zijn aan de drempelwaarde. Opmerking: het is niet raadzaam om dit OperatorType te gebruiken omdat er een lage kans is dat de kosten exact hetzelfde zijn als de drempelwaarde, waardoor uw waarschuwing ontbreekt. Dit OperatorType wordt in de toekomst afgeschaft.
GreaterThan	Waarschuwing wordt geactiveerd als de geëvalueerde kosten groter zijn dan de drempelwaarde. Opmerking: dit is het aanbevolen OperatorType tijdens het configureren van budgetwaarschuwingen.
GreaterThanOrEqualTo	Waarschuwing wordt geactiveerd als de geëvalueerde kosten groter zijn dan of gelijk zijn aan de drempelwaarde.

ThresholdType

Inventarisatie

Het type drempelwaarde

Waarde	Description
Actual	Budgetwaarschuwingen voor werkelijke kosten melden wanneer de werkelijke samengevoegde kosten groter zijn dan het toegewezen budget.
Forecasted	Budgetwaarschuwingen voor geraamde kosten bieden geavanceerde meldingen dat uw uitgaventrends waarschijnlijk uw toegewezen budget overschrijden, omdat deze afhankelijk is van voorspellingen van geraamde kosten.

TimeGrainType

Inventarisatie

De tijd die door een begroting wordt gedekt. Het bijhouden van de hoeveelheid wordt opnieuw ingesteld op basis van de tijdsinterval. BillingMonth, BillingQuarter en BillingAnnual worden alleen ondersteund door WD-klanten

Waarde	Description
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

Delen via

Budgets - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Budget

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Aanvullende resources