Budgets - Create Or Update

Szolgáltatás:
Consumption
API-verzió:
2024-08-01

A költségvetés létrehozásához vagy frissítéséhez szükséges művelet. Igény szerint megadhat egy eTag-et az egyidejűség-vezérlés egyik formájaként. Egy adott költségvetés legújabb eTagjének beszerzéséhez hajtsa végre a beolvasási műveletet az üzembe helyezési művelet előtt.

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

URI-paraméterek

Name In Kötelező Típus Description
budgetName
 path True

string

Költségvetés neve.
scope
 path True

string

Az erőforrás teljes Azure Resource Manager-azonosítója.
api-version
 query True

string

minLength: 1

A művelethez használandó API-verzió.

Kérelem törzse

Name Kötelező Típus Description
properties.amount True

number (decimal)

A költségvetéssel nyomon követendő költségek teljes összege
properties.category True

CategoryType

A költségvetés kategóriája, függetlenül attól, hogy a költségvetés nyomon követi-e a költségeket vagy a használatot.
properties.timeGrain True

TimeGrainType

A költségvetés által lefedett idő. Az összeg nyomon követése az időérték alapján lesz visszaállítva. A BillingMonth, a BillingQuarter és a BillingAnnual szolgáltatást csak a WD-ügyfelek támogatják
properties.timePeriod True

BudgetTimePeriod

A költségvetés kezdő és záró dátuma. A kezdő dátumnak a hónap első napjának kell lennie, és a befejezési dátumnál kisebbnek kell lennie. A költségvetés kezdő dátumának 2017. június 1-jén vagy azt követően kell lennie. A jövőbeli kezdési dátum legfeljebb tizenkét hónap lehet. A korábbi kezdési dátumot az időtartományon belül kell kijelölni. A befejezési dátumra nincsenek korlátozások.
eTag

string

Az erőforrás eTagje. Az egyidejű frissítési forgatókönyv kezeléséhez ez a mező határozza meg, hogy a felhasználó frissíti-e a legújabb verziót.
properties.filter

BudgetFilter

Használható a költségvetések felhasználó által megadott dimenziók és/vagy címkék szerinti szűrésére.
properties.notifications

<string,  Notification>

A költségvetéshez társított értesítések szótára. A költségvetés legfeljebb öt értesítésből áll.

Válaszok

Name Típus Description
200 OK

Budget

A "Költségvetés" erőforrás frissítési művelete sikeres volt
201 Created

Budget

A "Költségvetés" erőforrás létrehozási művelete sikeres volt
Other Status Codes

ErrorResponse

Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

CreateOrUpdateBudget

Mintakérelem

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

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "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": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Mintaválasz

Állapotkód:
200 
{
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "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": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}
Állapotkód:
201 
{
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "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": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Definíciók

Name Description
Budget

Költségvetési erőforrás.
BudgetComparisonExpression

A költségvetésekben használandó összehasonlító kifejezés.
BudgetFilter

A költségvetések erőforráscsoport, erőforrás vagy mérő szerint történő szűrésére használhatók.
BudgetFilterProperties

A költségvetések szűréséhez használható dimenziók vagy címkék.
BudgetOperatorType

Az összehasonlításhoz használni kívánt operátor.
BudgetTimePeriod

A költségvetés kezdő és záró dátuma.
CategoryType

A költségvetés kategóriája, függetlenül attól, hogy a költségvetés nyomon követi-e a költségeket vagy a használatot.
createdByType

Az erőforrást létrehozó identitás típusa.
CultureCode

Az a nyelv, amelyben a címzett megkapja az értesítést
CurrentSpend

A költségvetéshez nyomon követett aktuális költségmennyiség.
ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.
ErrorDetail

A hiba részletei.
ErrorResponse

Hibaválasz
ForecastSpend

A költségvetéshez nyomon követett előre jelzett költség.
Notification

A költségvetéshez társított értesítés.
OperatorType

Az összehasonlító operátor.
systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
ThresholdType

A küszöbérték típusa
TimeGrainType

A költségvetés által lefedett idő. Az összeg nyomon követése az időérték alapján lesz visszaállítva. A BillingMonth, a BillingQuarter és a BillingAnnual szolgáltatást csak a WD-ügyfelek támogatják

Budget

Tárgy

Költségvetési erőforrás.

Name Típus Description
eTag

string

Az erőforrás eTagje. Az egyidejű frissítési forgatókönyv kezeléséhez ez a mező határozza meg, hogy a felhasználó frissíti-e a legújabb verziót.
id

string

Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Az erőforrás neve
properties.amount

number (decimal)

A költségvetéssel nyomon követendő költségek teljes összege
properties.category

CategoryType

A költségvetés kategóriája, függetlenül attól, hogy a költségvetés nyomon követi-e a költségeket vagy a használatot.
properties.currentSpend

CurrentSpend

A költségvetéshez nyomon követett aktuális költségmennyiség.
properties.filter

BudgetFilter

Használható a költségvetések felhasználó által megadott dimenziók és/vagy címkék szerinti szűrésére.
properties.forecastSpend

ForecastSpend

A költségvetéshez nyomon követett előre jelzett költség.
properties.notifications

<string,  Notification>

A költségvetéshez társított értesítések szótára. A költségvetés legfeljebb öt értesítésből áll.
properties.timeGrain

TimeGrainType

A költségvetés által lefedett idő. Az összeg nyomon követése az időérték alapján lesz visszaállítva. A BillingMonth, a BillingQuarter és a BillingAnnual szolgáltatást csak a WD-ügyfelek támogatják
properties.timePeriod

BudgetTimePeriod

A költségvetés kezdő és záró dátuma. A kezdő dátumnak a hónap első napjának kell lennie, és a befejezési dátumnál kisebbnek kell lennie. A költségvetés kezdő dátumának 2017. június 1-jén vagy azt követően kell lennie. A jövőbeli kezdési dátum legfeljebb tizenkét hónap lehet. A korábbi kezdési dátumot az időtartományon belül kell kijelölni. A befejezési dátumra nincsenek korlátozások.
systemData

systemData

A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type

string

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

BudgetComparisonExpression

Tárgy

A költségvetésekben használandó összehasonlító kifejezés.

Name Típus Description
name

string

Az összehasonlítandó oszlop neve.
operator

BudgetOperatorType

Az összehasonlításhoz használni kívánt operátor.
values

string[]

Összehasonlításhoz használandó értékek tömbje

BudgetFilter

Tárgy

A költségvetések erőforráscsoport, erőforrás vagy mérő szerint történő szűrésére használhatók.

Name Típus Description
and

BudgetFilterProperties[]

A logikai "AND" kifejezés. Legalább 2 elemnek kell lennie.
dimensions

BudgetComparisonExpression

Dimenzió összehasonlító kifejezéssel rendelkezik
tags

BudgetComparisonExpression

Címkéhez tartozó összehasonlító kifejezéssel rendelkezik

BudgetFilterProperties

Tárgy

A költségvetések szűréséhez használható dimenziók vagy címkék.

Name Típus Description
dimensions

BudgetComparisonExpression

Dimenzió összehasonlító kifejezéssel rendelkezik
tags

BudgetComparisonExpression

Címkéhez tartozó összehasonlító kifejezéssel rendelkezik

BudgetOperatorType

Felsorolás

Az összehasonlításhoz használni kívánt operátor.

Érték Description
In

BudgetTimePeriod

Tárgy

A költségvetés kezdő és záró dátuma.

Name Típus Description
endDate

string (date-time)

A költségvetés záró dátuma. Ha nincs megadva, ezt alapértelmezés szerint a kezdési dátumtól számított 10 évre számítjuk.
startDate

string (date-time)

A költségvetés kezdő dátuma.

CategoryType

Felsorolás

A költségvetés kategóriája, függetlenül attól, hogy a költségvetés nyomon követi-e a költségeket vagy a használatot.

Érték Description
Cost

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték Description
User
Application
ManagedIdentity
Key

CultureCode

Felsorolás

Az a nyelv, amelyben a címzett megkapja az értesítést

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

CurrentSpend

Tárgy

A költségvetéshez nyomon követett aktuális költségmennyiség.

Name Típus Description
amount

number (decimal)

A költségvetés által nyomon követett költség teljes összege.
unit

string

A költségvetési összeg mértékegysége.

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.
type

string

A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.
code

string

A hibakód.
details

ErrorDetail[]

A hiba részletei.
message

string

A hibaüzenet.
target

string

A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

ForecastSpend

Tárgy

A költségvetéshez nyomon követett előre jelzett költség.

Name Típus Description
amount

number (decimal)

A költségvetés által nyomon követett teljes időszak előrejelzett költsége. Ez az érték csak akkor adható meg, ha a költségvetés előrejelzési riasztástípust tartalmaz.
unit

string

A költségvetési összeg mértékegysége.

Notification

Tárgy

A költségvetéshez társított értesítés.

Name Típus Alapértelmezett érték Description
contactEmails

string[]

E-mail-címek, a küszöbérték túllépése esetén a költségvetési értesítés elküldéséhez. Rendelkeznie kell legalább egy kapcsolattartó e-mail-címével vagy partnercsoporttal az előfizetés vagy az erőforráscsoport hatókörében. Minden más hatókörhöz legalább egy kapcsolattartó e-mail meg van adva.
contactGroups

string[]

A küszöbérték túllépése esetén a költségvetési értesítést küldő műveletcsoportok. Teljes körű Azure-erőforrás-azonosítóként kell megadni. Csak előfizetési vagy erőforráscsoport-hatókörök esetén támogatott.
contactRoles

string[]

Vegye fel a kapcsolatot a szerepkörökvel, és küldje el a költségvetési értesítést a küszöbérték túllépésekor.
enabled

boolean

Az értesítés engedélyezve van vagy sem.
locale

CultureCode

Az a nyelv, amelyben a címzett megkapja az értesítést
operator

OperatorType

Az összehasonlító operátor.
threshold

number (decimal)

Értesítéshez társított küszöbérték. A rendszer értesítést küld, ha a költség túllépte a küszöbértéket. Ez mindig százalék, és 0 és 1000 között kell lennie.
thresholdType

ThresholdType

Actual

A küszöbérték típusa

OperatorType

Felsorolás

Az összehasonlító operátor.

Érték Description
EqualTo

A riasztás akkor aktiválódik, ha a kiértékelt költség megegyezik a küszöbérték értékével. Megjegyzés: Nem ajánlott ezt az Operátortípust használni, mivel alacsony az esélye annak, hogy a költség pontosan megegyezik a küszöbérték értékével, ami a riasztás hiányához vezet. Ez az Operátortípus a jövőben megszűnik.
GreaterThan

A riasztás akkor aktiválódik, ha a kiértékelt költség nagyobb, mint a küszöbérték. Megjegyzés: Ez az ajánlott Operátortípus a költségvetési riasztás konfigurálása során.
GreaterThanOrEqualTo

A riasztás akkor aktiválódik, ha a kiértékelt költség nagyobb vagy egyenlő a küszöbérték értékénél.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string (date-time)

Az erőforrás-létrehozás időbélyege (UTC).
createdBy

string

Az erőforrást létrehozó identitás.
createdByType

createdByType

Az erőforrást létrehozó identitás típusa.
lastModifiedAt

string (date-time)

Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy

string

Az erőforrást legutóbb módosító identitás.
lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

ThresholdType

Felsorolás

A küszöbérték típusa

Érték Description
Actual

A tényleges költségkeret-riasztások értesítést küldenek, ha a tényleges felhalmozott költség meghaladja a lefoglalt költségvetést .
Forecasted

Az előrejelzett költségkeret-riasztások speciális értesítést nyújtanak arról, hogy a költségtrendek valószínűleg meghaladják a lefoglalt költségvetést, mivel az előrejelzett költség-előrejelzésekre támaszkodik.

TimeGrainType

Felsorolás

A költségvetés által lefedett idő. Az összeg nyomon követése az időérték alapján lesz visszaállítva. A BillingMonth, a BillingQuarter és a BillingAnnual szolgáltatást csak a WD-ügyfelek támogatják

Érték Description
Monthly
Quarterly
Annually
BillingMonth
BillingQuarter
BillingAnnual