Budgets - Get
Hämtar budgeten för omfånget efter budgetnamn.
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}?api-version=2024-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
budget
|
path | True |
string |
Budgetnamn. Reguljärt uttrycksmönster: |
scope
|
path | True |
string |
Omfånget som är associerat med budgetåtgärder. Omfång som stöds för CategoryType: Kostnads Azure RBAC-omfång:
EA-omfång (Enterprise-avtal):
MCA-omfång (modernt kundavtal):
Omfång som stöds för CategoryType: ReservationUtilization EA-omfång (Enterprise-avtal):
MCA-omfång (modernt kundavtal):
|
api-version
|
query | True |
string |
DEN API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OKEJ. Begäran har slutförts. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Get-Cost-Budget |
Get-Reservation |
Get-Cost-Budget
Exempelbegäran
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget?api-version=2024-08-01
Exempelsvar
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget",
"name": "TestBudget",
"type": "Microsoft.CostManagement/budgets",
"eTag": "\"1d34d012214157f\"",
"properties": {
"category": "Cost",
"amount": 100.65,
"timeGrain": "Monthly",
"timePeriod": {
"startDate": "2023-04-01T00:00:00Z",
"endDate": "2024-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"
}
}
}
}
Get-ReservationUtilization-AlertRule
Exempelbegäran
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01
Exempelsvar
{
"id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule",
"name": "TestAlertRule",
"type": "Microsoft.CostManagement/budgets",
"eTag": "\"1d34d012214157f\"",
"properties": {
"category": "ReservationUtilization",
"timeGrain": "Last30Days",
"timePeriod": {
"startDate": "2023-04-01T00:00:00Z",
"endDate": "2025-04-01T00:00:00Z"
},
"filter": {
"dimensions": {
"name": "ReservedResourceType",
"operator": "In",
"values": [
"VirtualMachines",
"SqlDatabases",
"CosmosDb"
]
}
},
"notifications": {
"Actual_LessThan_99_Percent": {
"enabled": true,
"operator": "LessThan",
"threshold": 99,
"frequency": "Daily",
"locale": "en-us",
"contactEmails": [
"johndoe@contoso.com",
"janesmith@contoso.com"
]
}
}
}
}
Definitioner
Name | Description |
---|---|
Budget |
En budgetresurs. |
Budget |
Jämförelseuttrycket som ska användas i budgetarna. |
Budget |
Kan användas för att filtrera budgetar efter användardefinierade dimensioner och/eller taggar. Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
Budget |
De dimensioner eller taggar som en budget ska filtreras efter. Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
Budget |
Jämförelseoperatorn. Stöds för CategoryType(er): Kostnad, ReservationUtilization. Operatorer som stöds för CategoryType: Kostnads
Operatorer som stöds för CategoryType: ReservationUtilization
|
Budget |
Operatorn som ska användas för jämförelse. |
Budget |
Tidsperioden som definierar den aktiva perioden för budgeten. Budgeten utvärderar data på eller efter startDate och upphör att gälla på endDate. Stöds för CategoryType(er): Kostnad, ReservationUtilization. Krävs för CategoryType(er): Kostnad, ReservationUtilization. |
Category |
Kategorin för budgeten.
|
Culture |
Språk där mottagaren får meddelandet, Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
Current |
Det aktuella kostnadsbeloppet som spåras för en budget. Stöds för CategoryType(er): Kostnad. |
Error |
Information om felet. |
Error |
Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar:
|
Forecast |
Den prognostiserade kostnad som spåras för en budget. Stöds för CategoryType(er): Kostnad. |
Frequency |
Frekvens för ett meddelande. Representerar hur länge meddelandet är tyst efter att en avisering om ett tröskelvärde har utlösts. Om det inte anges anges anges frekvensen som standard baserat på timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days). Stöds för CategoryType(er): ReservationUtilization. |
Notification |
Meddelandet som är associerat med en budget. Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
Threshold |
Typ av tröskelvärde. Stöds för CategoryType(er): Kostnad. |
Time |
Den tid som omfattas av en budget. Spårning av beloppet återställs baserat på tidsintervallet. Stöds för CategoryType(er): Kostnad, ReservationUtilization. TimeGrainTypes som stöds för CategoryType: Cost
TimeGrainTypes som stöds för CategoryType: ReservationUtilization
Krävs för CategoryType(er): Kostnad, ReservationUtilization. |
Budget
En budgetresurs.
Name | Typ | Description |
---|---|---|
eTag |
string |
eTag för resursen. För att hantera samtidiga uppdateringsscenarion används det här fältet för att avgöra om användaren uppdaterar den senaste versionen eller inte. |
id |
string |
Resurs-ID. |
name |
string |
Resursnamn. |
properties.amount |
number |
Den totala kostnaden som ska spåras med budgeten. Stöds för CategoryType(er): Kostnad. Krävs för CategoryType(er): Kostnad. |
properties.category |
Kategorin för budgeten.
|
|
properties.currentSpend |
Det aktuella kostnadsbeloppet som spåras för en budget. Stöds för CategoryType(er): Kostnad. |
|
properties.filter |
Kan användas för att filtrera budgetar efter användardefinierade dimensioner och/eller taggar. Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
|
properties.forecastSpend |
Den prognostiserade kostnad som spåras för en budget. Stöds för CategoryType(er): Kostnad. |
|
properties.notifications |
<string, Notification> |
Ordlista med meddelanden som är associerade med budgeten. Stöds för CategoryType(er): Kostnad, ReservationUtilization.
|
properties.timeGrain |
Den tid som omfattas av en budget. Spårning av beloppet återställs baserat på tidsintervallet. Stöds för CategoryType(er): Kostnad, ReservationUtilization. TimeGrainTypes som stöds för CategoryType: Cost
TimeGrainTypes som stöds för CategoryType: ReservationUtilization
Krävs för CategoryType(er): Kostnad, ReservationUtilization. |
|
properties.timePeriod |
Tidsperioden som definierar den aktiva perioden för budgeten. Budgeten utvärderar data på eller efter startDate och upphör att gälla på endDate. Stöds för CategoryType(er): Kostnad, ReservationUtilization. Krävs för CategoryType(er): Kostnad, ReservationUtilization. |
|
type |
string |
Resurstyp. |
BudgetComparisonExpression
Jämförelseuttrycket som ska användas i budgetarna.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på kolumnen som ska användas i jämförelse. |
operator |
Operatorn som ska användas för jämförelse. |
|
values |
string[] |
Matris med värden som ska användas för jämförelse |
BudgetFilter
Kan användas för att filtrera budgetar efter användardefinierade dimensioner och/eller taggar.
Stöds för CategoryType(er): Kostnad, ReservationUtilization.
Name | Typ | Description |
---|---|---|
and |
Det logiska "AND"-uttrycket. Måste ha minst 2 objekt. Stöds för CategoryType(er): Kostnad. |
|
dimensions |
Har jämförelseuttryck för en dimension. Stöds för CategoryType(er): Kostnad, ReservationUtilization. Dimensionsnamn som stöds för CategoryType: ReservationUtilization
|
|
tags |
Har jämförelseuttryck för en tagg. Stöds för CategoryType(er): Kostnad. |
BudgetFilterProperties
De dimensioner eller taggar som en budget ska filtreras efter.
Stöds för CategoryType(er): Kostnad, ReservationUtilization.
Name | Typ | Description |
---|---|---|
dimensions |
Har jämförelseuttryck för en dimension. Stöds för CategoryType(er): Kostnad, ReservationUtilization. Dimensionsnamn som stöds för CategoryType: ReservationUtilization
|
|
tags |
Har jämförelseuttryck för en tagg. Stöds för CategoryType(er): Kostnad. |
BudgetNotificationOperatorType
Jämförelseoperatorn.
Stöds för CategoryType(er): Kostnad, ReservationUtilization.
Operatorer som stöds för CategoryType: Kostnads
- GreaterThan
- GreaterThanOrEqualTo
Operatorer som stöds för CategoryType: ReservationUtilization
- LessThan
Name | Typ | Description |
---|---|---|
EqualTo |
string |
Meddelandet utlöses om den utvärderade kostnaden är samma som tröskelvärdet. Obs! Vi rekommenderar inte att du använder den här OperatorType eftersom det är låg risk att kostnaden blir exakt samma som tröskelvärdet, vilket leder till att aviseringen saknas. OperatorType kommer att bli inaktuell i framtiden. Stöds för CategoryType(er): Kostnad. |
GreaterThan |
string |
Meddelandet utlöses om den utvärderade kostnaden är större än tröskelvärdet. Obs! Det här är den rekommenderade OperatorType när du konfigurerar budgetavisering. Stöds för CategoryType(er): Kostnad. |
GreaterThanOrEqualTo |
string |
Meddelandet utlöses om den utvärderade kostnaden är större än eller lika med tröskelvärdet. Stöds för CategoryType(er): Kostnad. |
LessThan |
string |
Meddelandet utlöses om några reservationer i omfånget för aviseringsregeln för reservationsanvändning har en användning som är mindre än tröskelvärdet. Stöds för CategoryType(er): ReservationUtilization. |
BudgetOperatorType
Operatorn som ska användas för jämförelse.
Name | Typ | Description |
---|---|---|
In |
string |
BudgetTimePeriod
Tidsperioden som definierar den aktiva perioden för budgeten. Budgeten utvärderar data på eller efter startDate och upphör att gälla på endDate.
Stöds för CategoryType(er): Kostnad, ReservationUtilization.
Krävs för CategoryType(er): Kostnad, ReservationUtilization.
Name | Typ | Description |
---|---|---|
endDate |
string |
Slutdatum för budgeten.
|
startDate |
string |
Startdatum för budgeten.
|
CategoryType
Kategorin för budgeten.
- "Kostnad" definierar en budget.
- "ReservationUtilization" definierar en aviseringsregel för reservationsanvändning.
Name | Typ | Description |
---|---|---|
Cost |
string |
En budget som utvärderar den ekonomiska kostnaden för Azure-resurser mot ett belopp och aviseringar baserat på ett konfigurerat meddelandetröskelvärde. |
ReservationUtilization |
string |
En aviseringsregel som utvärderar användningsprocenten för Azure-reservationer och aviseringar baserat på ett konfigurerat meddelandetröskelvärde. |
CultureCode
Språk där mottagaren får meddelandet,
Stöds för CategoryType(er): Kostnad, ReservationUtilization.
Name | Typ | Description |
---|---|---|
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
Det aktuella kostnadsbeloppet som spåras för en budget.
Stöds för CategoryType(er): Kostnad.
Name | Typ | Description |
---|---|---|
amount |
number |
Den totala kostnad som spåras av budgeten. |
unit |
string |
Måttenheten för budgetbeloppet. |
ErrorDetails
Information om felet.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod. |
message |
string |
Felmeddelande som anger varför åtgärden misslyckades. |
ErrorResponse
Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
Några felsvar:
429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
Name | Typ | Description |
---|---|---|
error |
Information om felet. |
ForecastSpend
Den prognostiserade kostnad som spåras för en budget.
Stöds för CategoryType(er): Kostnad.
Name | Typ | Description |
---|---|---|
amount |
number |
Den prognostiserade kostnaden för den totala tidsperiod som spåras av budgeten. Det här värdet anges endast om budgeten innehåller en prognosaviseringstyp. |
unit |
string |
Måttenheten för budgetbeloppet. |
Frequency
Frekvens för ett meddelande. Representerar hur länge meddelandet är tyst efter att en avisering om ett tröskelvärde har utlösts. Om det inte anges anges anges frekvensen som standard baserat på timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days).
Stöds för CategoryType(er): ReservationUtilization.
Name | Typ | Description |
---|---|---|
Daily |
string |
När tröskelvärdesöverträdelserna och en avisering har utlösts skickas inga ytterligare aviseringar förrän nästa kalenderdag. |
Monthly |
string |
När tröskelvärdesöverträdelserna och en avisering har utlösts skickas inga ytterligare aviseringar under 30 kalenderdagar. |
Weekly |
string |
När tröskelvärdesöverträdelserna och en avisering har utlösts skickas inga ytterligare aviseringar under 7 kalenderdagar. |
Notification
Meddelandet som är associerat med en budget.
Stöds för CategoryType(er): Kostnad, ReservationUtilization.
Name | Typ | Standardvärde | Description |
---|---|---|---|
contactEmails |
string[] |
E-postadresser som meddelandet ska skickas till när tröskelvärdet överskrids. Minst en kontakt-e-post eller kontaktgrupp måste anges i omfånget Prenumeration eller Resursgrupp. Alla andra omfång måste ha minst en e-postadress för kontakten angiven. Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
|
contactGroups |
string[] |
Omfång för prenumeration eller resursgrupp. Åtgärdsgrupper som meddelandet ska skickas till när tröskelvärdet överskrids. Måste anges som ett fullständigt kvalificerat Azure-resurs-ID. Stöds för CategoryType(er): Kostnad. |
|
contactRoles |
string[] |
Omfång för prenumeration eller resursgrupp. Kontakta roller för att skicka meddelandet till när tröskelvärdet överskrids. Stöds för CategoryType(er): Kostnad. |
|
enabled |
boolean |
Meddelandet är aktiverat eller inte. Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
|
frequency |
Frekvens för ett meddelande. Representerar hur länge meddelandet är tyst efter att en avisering om ett tröskelvärde har utlösts. Om det inte anges anges anges frekvensen som standard baserat på timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days). Stöds för CategoryType(er): ReservationUtilization. |
||
locale |
Språk där mottagaren får meddelandet, Stöds för CategoryType(er): Kostnad, ReservationUtilization. |
||
operator |
Jämförelseoperatorn. Stöds för CategoryType(er): Kostnad, ReservationUtilization. Operatorer som stöds för CategoryType: Kostnads
Operatorer som stöds för CategoryType: ReservationUtilization
|
||
threshold |
number |
Tröskelvärde som är associerat med ett meddelande. Det är alltid procent med högst 2 decimaler. Stöds för CategoryType(er): Kostnad, ReservationUtilization. CategoryType: Cost – måste vara mellan 0 och 1000. Meddelande skickas när kostnaden överskred tröskelvärdet. CategoryType: ReservationUtilization – måste vara mellan 0 och 100. Meddelande skickas när en reservation har en användningsprocent under tröskelvärdet. |
|
thresholdType | Actual |
Typ av tröskelvärde. Stöds för CategoryType(er): Kostnad. |
ThresholdType
Typ av tröskelvärde.
Stöds för CategoryType(er): Kostnad.
Name | Typ | Description |
---|---|---|
Actual |
string |
Budgetaviseringar för faktiska kostnader meddelar när den faktiska upplupna kostnaden överskrider den allokerade budgeten. |
Forecasted |
string |
Budgetaviseringar för prognostiserade kostnader ger ett avancerat meddelande om att dina utgiftstrender sannolikt kommer att överskrida din allokerade budget, eftersom den förlitar sig på prognostiserade kostnadsförutsägelser. |
TimeGrainType
Den tid som omfattas av en budget. Spårning av beloppet återställs baserat på tidsintervallet.
Stöds för CategoryType(er): Kostnad, ReservationUtilization.
TimeGrainTypes som stöds för CategoryType: Cost
Månatlig
Kvartalsvis
Årligen
BillingMonth*
BillingQuarter*
FaktureringÅr*
*stöds endast för Web Direct-kunder.
TimeGrainTypes som stöds för CategoryType: ReservationUtilization
- Last7Days
- Last30Days
Krävs för CategoryType(er): Kostnad, ReservationUtilization.
Name | Typ | Description |
---|---|---|
Annually |
string |
Budgeten spårar kostnader under det aktuella kalenderåret mot beloppet. Stöds för CategoryType: Endast kostnad. |
BillingAnnual |
string |
Budgeten spårar kostnader under det aktuella faktureringsåret mot beloppet. Stöds endast för CategoryType: Kostnads- och webbdirigeringskunder. |
BillingMonth |
string |
Budgeten spårar kostnaderna under den aktuella faktureringsmånaden mot beloppet. Stöds endast för CategoryType: Kostnads- och webbdirigeringskunder. |
BillingQuarter |
string |
Budgeten spårar kostnader i det aktuella faktureringskvartalet mot beloppet. Stöds endast för CategoryType: Kostnads- och webbdirigeringskunder. |
Last30Days |
string |
Aviseringsregeln för reservationsanvändning utvärderar reservationer baserat på deras 30-dagars användningsprocent. Stöds endast för CategoryType: ReservationUtilization. |
Last7Days |
string |
Aviseringsregeln för reservationsanvändning utvärderar reservationer baserat på deras 7-dagars användningsprocent. Stöds endast för CategoryType: ReservationUtilization. |
Monthly |
string |
Budgeten spårar kostnaderna under den aktuella kalendermånaden mot beloppet. Stöds för CategoryType: Endast kostnad. |
Quarterly |
string |
Budgeten spårar kostnaderna i det aktuella kalenderkvartalet mot beloppet. Stöds för CategoryType: Endast kostnad. |