Budgets - Create Or Update

Layanan:
Consumption
Versi API:
2024-08-01

Operasi untuk membuat atau memperbarui anggaran. Anda dapat secara opsional memberikan eTag jika diinginkan sebagai bentuk kontrol konkurensi. Untuk mendapatkan eTag terbaru untuk anggaran tertentu, lakukan operasi get sebelum operasi put Anda.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
budgetName
 path True

string

Nama Anggaran.
scope
 path True

string

Pengidentifikasi Azure Resource manager sumber daya yang sepenuhnya memenuhi syarat.
api-version
 query True

string

minLength: 1

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
properties.amount True

number (decimal)

Jumlah total biaya untuk dilacak dengan anggaran
properties.category True

CategoryType

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.
properties.timeGrain True

TimeGrainType

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD
properties.timePeriod True

BudgetTimePeriod

Memiliki tanggal mulai dan berakhir anggaran. Tanggal mulai harus pertama kali dari bulan dan harus kurang dari tanggal akhir. Tanggal mulai anggaran harus pada atau setelah 1 Juni 2017. Tanggal mulai di masa mendatang tidak boleh lebih dari dua belas bulan. Tanggal mulai sebelumnya harus dipilih dalam periode timegrain. Tidak ada batasan pada tanggal selesai.
eTag

string

eTag sumber daya. Untuk menangani skenario pembaruan bersamaan, bidang ini akan digunakan untuk menentukan apakah pengguna memperbarui versi terbaru atau tidak.
properties.filter

BudgetFilter

Dapat digunakan untuk memfilter anggaran menurut dimensi dan/atau tag yang ditentukan pengguna.
properties.notifications

<string,  Notification>

Kamus pemberitahuan yang terkait dengan anggaran. Anggaran dapat memiliki hingga lima pemberitahuan.

Respons

Nama Jenis Deskripsi
200 OK

Budget

Operasi pembaruan 'Anggaran' sumber daya berhasil
201 Created

Budget

Operasi pembuatan 'Anggaran' sumber daya berhasil
Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

CreateOrUpdateBudget

Permintaan sampel

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

Respon sampel

Kode status:
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"
    }
  }
}
Kode status:
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"
    }
  }
}

Definisi

Nama Deskripsi
Budget

Sumber daya anggaran.
BudgetComparisonExpression

Ekspresi perbandingan yang akan digunakan dalam anggaran.
BudgetFilter

Dapat digunakan untuk memfilter anggaran menurut grup sumber daya, sumber daya, atau meteran.
BudgetFilterProperties

Dimensi atau Tag untuk memfilter anggaran.
BudgetOperatorType

Operator yang digunakan untuk perbandingan.
BudgetTimePeriod

Tanggal mulai dan berakhir untuk anggaran.
CategoryType

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.
createdByType

Jenis identitas yang membuat sumber daya.
CultureCode

Bahasa tempat penerima akan menerima pemberitahuan
CurrentSpend

Jumlah biaya saat ini yang sedang dilacak untuk anggaran.
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Tanggapan kesalahan
ForecastSpend

Perkiraan biaya yang sedang dilacak untuk anggaran.
Notification

Pemberitahuan yang terkait dengan anggaran.
OperatorType

Operator perbandingan.
systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
ThresholdType

Jenis ambang batas
TimeGrainType

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD

Budget

Objek

Sumber daya anggaran.

Nama Jenis Deskripsi
eTag

string

eTag sumber daya. Untuk menangani skenario pembaruan bersamaan, bidang ini akan digunakan untuk menentukan apakah pengguna memperbarui versi terbaru atau tidak.
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nama sumber daya
properties.amount

number (decimal)

Jumlah total biaya untuk dilacak dengan anggaran
properties.category

CategoryType

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.
properties.currentSpend

CurrentSpend

Jumlah biaya saat ini yang sedang dilacak untuk anggaran.
properties.filter

BudgetFilter

Dapat digunakan untuk memfilter anggaran menurut dimensi dan/atau tag yang ditentukan pengguna.
properties.forecastSpend

ForecastSpend

Perkiraan biaya yang sedang dilacak untuk anggaran.
properties.notifications

<string,  Notification>

Kamus pemberitahuan yang terkait dengan anggaran. Anggaran dapat memiliki hingga lima pemberitahuan.
properties.timeGrain

TimeGrainType

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD
properties.timePeriod

BudgetTimePeriod

Memiliki tanggal mulai dan berakhir anggaran. Tanggal mulai harus pertama kali dari bulan dan harus kurang dari tanggal akhir. Tanggal mulai anggaran harus pada atau setelah 1 Juni 2017. Tanggal mulai di masa mendatang tidak boleh lebih dari dua belas bulan. Tanggal mulai sebelumnya harus dipilih dalam periode timegrain. Tidak ada batasan pada tanggal selesai.
systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type

string

Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

BudgetComparisonExpression

Objek

Ekspresi perbandingan yang akan digunakan dalam anggaran.

Nama Jenis Deskripsi
name

string

Nama kolom yang akan digunakan sebagai perbandingan.
operator

BudgetOperatorType

Operator yang digunakan untuk perbandingan.
values

string[]

Array nilai yang akan digunakan untuk perbandingan

BudgetFilter

Objek

Dapat digunakan untuk memfilter anggaran menurut grup sumber daya, sumber daya, atau meteran.

Nama Jenis Deskripsi
and

BudgetFilterProperties[]

Ekspresi "AND" logis. Harus memiliki setidaknya 2 item.
dimensions

BudgetComparisonExpression

Memiliki ekspresi perbandingan untuk dimensi
tags

BudgetComparisonExpression

Memiliki ekspresi perbandingan untuk tag

BudgetFilterProperties

Objek

Dimensi atau Tag untuk memfilter anggaran.

Nama Jenis Deskripsi
dimensions

BudgetComparisonExpression

Memiliki ekspresi perbandingan untuk dimensi
tags

BudgetComparisonExpression

Memiliki ekspresi perbandingan untuk tag

BudgetOperatorType

Enumerasi

Operator yang digunakan untuk perbandingan.

Nilai Deskripsi
In

BudgetTimePeriod

Objek

Tanggal mulai dan berakhir untuk anggaran.

Nama Jenis Deskripsi
endDate

string (date-time)

Tanggal akhir untuk anggaran. Jika tidak disediakan, kami default ini hingga 10 tahun dari tanggal mulai.
startDate

string (date-time)

Tanggal mulai untuk anggaran.

CategoryType

Enumerasi

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.

Nilai Deskripsi
Cost

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai Deskripsi
User
Application
ManagedIdentity
Key

CultureCode

Enumerasi

Bahasa tempat penerima akan menerima pemberitahuan

Nilai Deskripsi
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

Objek

Jumlah biaya saat ini yang sedang dilacak untuk anggaran.

Nama Jenis Deskripsi
amount

number (decimal)

Jumlah total biaya yang sedang dilacak oleh anggaran.
unit

string

Satuan ukuran untuk jumlah anggaran.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.
type

string

Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.
code

string

Kode kesalahan.
details

ErrorDetail[]

Detail kesalahan.
message

string

Pesan kesalahan.
target

string

Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

ForecastSpend

Objek

Perkiraan biaya yang sedang dilacak untuk anggaran.

Nama Jenis Deskripsi
amount

number (decimal)

Perkiraan biaya untuk total periode waktu yang sedang dilacak oleh anggaran. Nilai ini hanya disediakan jika anggaran berisi jenis pemberitahuan prakiraan.
unit

string

Satuan ukuran untuk jumlah anggaran.

Notification

Objek

Pemberitahuan yang terkait dengan anggaran.

Nama Jenis Nilai default Deskripsi
contactEmails

string[]

Alamat email untuk mengirim pemberitahuan anggaran ke saat ambang batas terlampaui. Harus memiliki setidaknya satu email kontak atau grup kontak yang ditentukan di cakupan Langganan atau Grup Sumber Daya. Semua cakupan lainnya harus memiliki setidaknya satu email kontak yang ditentukan.
contactGroups

string[]

Grup tindakan untuk mengirim pemberitahuan anggaran ke saat ambang batas terlampaui. Harus disediakan sebagai id sumber daya Azure yang sepenuhnya memenuhi syarat. Hanya didukung di cakupan Langganan atau Grup Sumber Daya.
contactRoles

string[]

Peran kontak untuk mengirim pemberitahuan anggaran ke saat ambang batas terlampaui.
enabled

boolean

Pemberitahuan diaktifkan atau tidak.
locale

CultureCode

Bahasa tempat penerima akan menerima pemberitahuan
operator

OperatorType

Operator perbandingan.
threshold

number (decimal)

Nilai ambang yang terkait dengan pemberitahuan. Pemberitahuan dikirim ketika biaya melebihi ambang batas. Selalu persen dan harus antara 0 dan 1000.
thresholdType

ThresholdType

Actual

Jenis ambang batas

OperatorType

Enumerasi

Operator perbandingan.

Nilai Deskripsi
EqualTo

Pemberitahuan akan dipicu jika biaya yang dievaluasi sama dengan nilai ambang batas. Catatan: Tidak disarankan untuk menggunakan OperatorType ini karena ada kemungkinan biaya yang rendah sama persis dengan nilai ambang batas, yang menyebabkan hilangnya pemberitahuan Anda. OperatorType ini akan ditolak di masa mendatang.
GreaterThan

Pemberitahuan akan dipicu jika biaya yang dievaluasi lebih besar dari nilai ambang batas. Catatan: Ini adalah OperatorType yang direkomendasikan saat mengonfigurasi Pemberitahuan Anggaran.
GreaterThanOrEqualTo

Pemberitahuan akan dipicu jika biaya yang dievaluasi lebih besar dari atau sama dengan nilai ambang batas.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string (date-time)

Stempel waktu pembuatan sumber daya (UTC).
createdBy

string

Identitas yang membuat sumber daya.
createdByType

createdByType

Jenis identitas yang membuat sumber daya.
lastModifiedAt

string (date-time)

Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy

string

Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType

createdByType

Jenis identitas yang terakhir memodifikasi sumber daya.

ThresholdType

Enumerasi

Jenis ambang batas

Nilai Deskripsi
Actual

Pemberitahuan anggaran biaya aktual memberi tahu ketika biaya akumulasi aktual melebihi anggaran yang dialokasikan .
Forecasted

Pemberitahuan anggaran biaya yang diperkirakan memberikan pemberitahuan lanjutan bahwa tren pengeluaran Anda kemungkinan melebihi anggaran yang dialokasikan, karena bergantung pada prediksi biaya yang diperkirakan.

TimeGrainType

Enumerasi

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD

Nilai Deskripsi
Monthly
Quarterly
Annually
BillingMonth
BillingQuarter
BillingAnnual