Budgets - Create Or Update

Başvuru

Hizmet:: Consumption

API Sürümü:: 2024-08-01

Bütçe oluşturma veya güncelleştirme işlemi. İsteğe bağlı olarak eşzamanlılık denetimi biçimi olarak istenirse bir eTag sağlayabilirsiniz. Belirli bir bütçe için en son eTag'i edinmek için, yerleştirme işleminizden önce bir alma işlemi gerçekleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
budgetName	path	True	string	Bütçe Adı.
scope	path	True	string	Bütçe işlemleriyle ilişkili kapsam. Buna abonelik kapsamı için '/subscriptions/{subscriptionId}/' dahildir, ResourceGroup kapsamı için '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', Faturalama Hesabı kapsamı için '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}', Departman kapsamı için '/providers/Microsoft.Billing/billingAccountId}/departments/{departmentId}', '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}', invoiceSection scope için '/providers/Microsoft.Billing/billingAccountId}/invoiceSections/{invoiceSectionId}'.
api-version	query	True	string	İstemci isteğiyle kullanılacak API'nin sürümü. Geçerli sürüm 2023-03-01'dir.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.amount	True	number (decimal)	Bütçeyle izlenen toplam maliyet miktarı
properties.category	True	CategoryType	Bütçenin maliyeti veya kullanımı izlediği bütçe kategorisi.
properties.timeGrain	True	TimeGrainType	Bütçenin kapsadığı süre. Miktarın izlenmesi zaman dilimine göre sıfırlanır. BillingMonth, BillingQuarter ve BillingAnnual yalnızca WD müşterileri tarafından desteklenir
properties.timePeriod	True	BudgetTimePeriod	Bütçenin başlangıç ve bitiş tarihidir. Başlangıç tarihi ayın ilki olmalı ve bitiş tarihinden küçük olmalıdır. Bütçe başlangıç tarihi 1 Haziran 2017 tarihinde veya sonrasında olmalıdır. Gelecekteki başlangıç tarihi on iki aydan uzun olmamalıdır. Geçmiş başlangıç tarihi, zaman dilimi içinde seçilmelidir. Bitiş tarihinde herhangi bir kısıtlama yoktur.
eTag		string	Kaynağın eTag'i. Eşzamanlı güncelleştirme senaryolarını işlemek için, kullanıcının en son sürümü güncelleştirip güncelleştirmediğini belirlemek için bu alan kullanılır.
properties.filter		BudgetFilter	Bütçeleri kullanıcı tarafından belirtilen boyutlara ve/veya etiketlere göre filtrelemek için kullanılabilir.
properties.notifications		<string, Notification>	Bütçeyle ilişkili bildirimlerin sözlüğü. Bütçede en fazla beş bildirim olabilir.

Yanıtlar

Name	Tür	Description
200 OK	Budget	TAMAM. İstek başarılı oldu.
201 Created	Budget	Oluşturulan.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

CreateOrUpdateBudget

Örnek isteği

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": [
          "[email protected]",
          "[email protected]"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

Örnek yanıt

Durum kodu:: 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": [
          "[email protected]",
          "[email protected]"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

Durum kodu:: 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": [
          "[email protected]",
          "[email protected]"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

Tanımlar

Name	Description
Budget	Bütçe kaynağı.
BudgetComparisonExpression	Bütçelerde kullanılacak karşılaştırma ifadesi.
BudgetFilter	Bütçeleri kaynak grubuna, kaynağa veya ölçüme göre filtrelemek için kullanılabilir.
BudgetFilterProperties	Bütçeyi filtrelemek için Boyutlar veya Etiketler.
BudgetOperatorType	Karşılaştırma için kullanılacak işleç.
BudgetTimePeriod	Bütçenin başlangıç ve bitiş tarihi.
CategoryType	Bütçenin maliyeti veya kullanımı izlediği bütçe kategorisi.
CultureCode	Alıcının bildirimi alacağı dil
CurrentSpend	Bütçe için izlenen geçerli maliyet miktarı.
ErrorDetails	Hatanın ayrıntıları.
ErrorResponse	Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde sağlanır. Bazı Hata yanıtları: 429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin. 503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Yeniden Dene-Sonra" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin. 504 Ağ Geçidi Zaman Aşımı - İstek işlenirken hizmet zaman aşımına uğradı. Mümkünse istekteki tarih aralığını azaltın.
ForecastSpend	Bütçe için izlenen tahmini maliyet.
Notification	Bütçeyle ilişkili bildirim.
OperatorType	Karşılaştırma işleci.
ThresholdType	Eşik türü
TimeGrainType	Bütçenin kapsadığı süre. Miktarın izlenmesi zaman dilimine göre sıfırlanır. BillingMonth, BillingQuarter ve BillingAnnual yalnızca WD müşterileri tarafından desteklenir

Budget

Object

Bütçe kaynağı.

Name	Tür	Description
eTag	string	Kaynağın eTag'i. Eşzamanlı güncelleştirme senaryolarını işlemek için, kullanıcının en son sürümü güncelleştirip güncelleştirmediğini belirlemek için bu alan kullanılır.
id	string	Kaynak Kimliği.
name	string	Kaynak adı.
properties.amount	number (decimal)	Bütçeyle izlenen toplam maliyet miktarı
properties.category	CategoryType	Bütçenin maliyeti veya kullanımı izlediği bütçe kategorisi.
properties.currentSpend	CurrentSpend	Bütçe için izlenen geçerli maliyet miktarı.
properties.filter	BudgetFilter	Bütçeleri kullanıcı tarafından belirtilen boyutlara ve/veya etiketlere göre filtrelemek için kullanılabilir.
properties.forecastSpend	ForecastSpend	Bütçe için izlenen tahmini maliyet.
properties.notifications	<string, Notification>	Bütçeyle ilişkili bildirimlerin sözlüğü. Bütçede en fazla beş bildirim olabilir.
properties.timeGrain	TimeGrainType	Bütçenin kapsadığı süre. Miktarın izlenmesi zaman dilimine göre sıfırlanır. BillingMonth, BillingQuarter ve BillingAnnual yalnızca WD müşterileri tarafından desteklenir
properties.timePeriod	BudgetTimePeriod	Bütçenin başlangıç ve bitiş tarihidir. Başlangıç tarihi ayın ilki olmalı ve bitiş tarihinden küçük olmalıdır. Bütçe başlangıç tarihi 1 Haziran 2017 tarihinde veya sonrasında olmalıdır. Gelecekteki başlangıç tarihi on iki aydan uzun olmamalıdır. Geçmiş başlangıç tarihi, zaman dilimi içinde seçilmelidir. Bitiş tarihinde herhangi bir kısıtlama yoktur.
type	string	Kaynak türü.

BudgetComparisonExpression

Object

Bütçelerde kullanılacak karşılaştırma ifadesi.

Name	Tür	Description
name	string	Karşılaştırmada kullanılacak sütunun adı.
operator	BudgetOperatorType	Karşılaştırma için kullanılacak işleç.
values	string[]	Karşılaştırma için kullanılacak değer dizisi

BudgetFilter

Object

Bütçeleri kaynak grubuna, kaynağa veya ölçüme göre filtrelemek için kullanılabilir.

Name	Tür	Description
and	BudgetFilterProperties[]	Mantıksal "AND" ifadesi. En az 2 öğe olmalıdır.
dimensions	BudgetComparisonExpression	Boyut için karşılaştırma ifadesi var
tags	BudgetComparisonExpression	Etiket için karşılaştırma ifadesi var

BudgetFilterProperties

Object

Bütçeyi filtrelemek için Boyutlar veya Etiketler.

Name	Tür	Description
dimensions	BudgetComparisonExpression	Boyut için karşılaştırma ifadesi var
tags	BudgetComparisonExpression	Etiket için karşılaştırma ifadesi var

BudgetOperatorType

Listeleme

Karşılaştırma için kullanılacak işleç.

Değer	Description
In

BudgetTimePeriod

Object

Bütçenin başlangıç ve bitiş tarihi.

Name	Tür	Description
endDate	string (date-time)	Bütçenin bitiş tarihi. Sağlanmadıysa, bunu başlangıç tarihinden itibaren 10 yıl olarak varsayılan olarak kullanırız.
startDate	string (date-time)	Bütçenin başlangıç tarihi.

CategoryType

Listeleme

Bütçenin maliyeti veya kullanımı izlediği bütçe kategorisi.

Değer	Description
Cost

CultureCode

Listeleme

Alıcının bildirimi alacağı dil

Değer	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

Bütçe için izlenen geçerli maliyet miktarı.

Name	Tür	Description
amount	number (decimal)	Bütçe tarafından izlenen toplam maliyet miktarı.
unit	string	Bütçe tutarı için ölçü birimi.

ErrorDetails

Object

Hatanın ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu gösteren hata iletisi.

ErrorResponse

Object

Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde sağlanır.

Bazı Hata yanıtları:

429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin.
503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Yeniden Dene-Sonra" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin.
504 Ağ Geçidi Zaman Aşımı - İstek işlenirken hizmet zaman aşımına uğradı. Mümkünse istekteki tarih aralığını azaltın.

Name	Tür	Description
error	ErrorDetails	Hatanın ayrıntıları.

ForecastSpend

Object

Bütçe için izlenen tahmini maliyet.

Name	Tür	Description
amount	number (decimal)	Bütçe tarafından izlenen toplam zaman aralığı için tahmin edilen maliyet. Bu değer yalnızca bütçe bir tahmin uyarı türü içeriyorsa sağlanır.
unit	string	Bütçe tutarı için ölçü birimi.

Notification

Object

Bütçeyle ilişkili bildirim.

Name	Tür	Default value	Description
contactEmails	string[]		Eşik aşıldığında bütçe bildirimini göndermek için e-posta adresleri. Abonelik veya Kaynak Grubu kapsamlarında belirtilen en az bir kişi e-postası veya kişi grubu olmalıdır. Diğer tüm kapsamlarda en az bir kişi e-postası belirtilmelidir.
contactGroups	string[]		Eşik aşıldığında bütçe bildirimi gönderilecek eylem grupları. Tam azure kaynak kimliği olarak sağlanmalıdır. Yalnızca Abonelik veya Kaynak Grubu kapsamlarında desteklenir.
contactRoles	string[]		Eşik aşıldığında bütçe bildirimini göndermek için ilgili kişi rolleri.
enabled	boolean		Bildirim etkinleştirildi veya etkinleştirilmedi.
locale	CultureCode		Alıcının bildirimi alacağı dil
operator	OperatorType		Karşılaştırma işleci.
threshold	number (decimal)		Bildirimle ilişkili eşik değeri. Maliyet eşiği aştığında bildirim gönderilir. Her zaman yüzdedir ve 0 ile 1000 arasında olmalıdır.
thresholdType	ThresholdType	Actual	Eşik türü

OperatorType

Listeleme

Karşılaştırma işleci.

Değer	Description
EqualTo	Değerlendirilen maliyet eşik değeriyle aynıysa uyarı tetiklenir. Not: Maliyetin eşik değeriyle tam olarak aynı olma olasılığı düşük olduğundan uyarınızın eksik olmasına neden olduğundan bu OperatorType'ın kullanılması önerilmez. Bu OperatorType gelecekte kullanımdan kaldırılacaktır.
GreaterThan	Değerlendirilen maliyet eşik değerinden büyükse uyarı tetiklenir. Not: Bütçe Uyarısı yapılandırılırken önerilen OperatorType budur.
GreaterThanOrEqualTo	Değerlendirilen maliyet eşik değerinden büyük veya buna eşitse uyarı tetiklenir.

ThresholdType

Listeleme

Eşik türü

Değer	Description
Actual	Gerçek maliyetler bütçe uyarıları, tahakkuk eden gerçek maliyet ayrılan bütçeyi aştığında bunu bildirir.
Forecasted	Tahmin edilen maliyet bütçe uyarıları, tahmin edilen maliyet tahminlerine bağlı olduğundan harcama eğilimlerinizin ayrılmış bütçenizi aşma olasılığının yüksek olduğunu belirten gelişmiş bildirim sağlar.

TimeGrainType

Listeleme

Bütçenin kapsadığı süre. Miktarın izlenmesi zaman dilimine göre sıfırlanır. BillingMonth, BillingQuarter ve BillingAnnual yalnızca WD müşterileri tarafından desteklenir

Değer	Description
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

Aracılığıyla paylaş

Budgets - Create Or Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

CreateOrUpdateBudget

Örnek isteği

Örnek yanıt

Tanımlar

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType