Scheduled Actions - Create Or Update By Scope
Membuat atau memperbarui tindakan terjadwal bersama dalam cakupan yang diberikan.
PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2023-11-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
name
|
path | True |
string |
Nama tindakan terjadwal. |
scope
|
path | True |
string |
Cakupan yang terkait dengan operasi tindakan terjadwal. Ini termasuk 'subscriptions/{subscriptionId}' untuk cakupan langganan, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' untuk cakupan resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' untuk cakupan EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' untuk cakupan BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' untuk cakupan InvoiceSection, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' untuk cakupan Akun Penagihan Eksternal dan 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' untuk cakupan Langganan Eksternal. Catatan: Pemberitahuan Wawasan hanya tersedia pada cakupan langganan. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
If-Match |
string |
ETag Entitas. Tidak diperlukan saat membuat entitas. Opsional saat memperbarui entitas dan dapat ditentukan untuk mencapai konkurensi optimis. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
properties.displayName | True |
string |
Nama tindakan terjadwal. |
properties.notification | True |
Properti pemberitahuan berdasarkan jenis tindakan terjadwal. |
|
properties.schedule | True |
Jadwal tindakan terjadwal. |
|
properties.status | True |
Status tindakan terjadwal. |
|
properties.viewId | True |
string |
Tampilan analisis biayaId digunakan untuk tindakan terjadwal. Misalnya, '/providers/Microsoft.CostManagement/views/swaggerExample' |
kind |
Jenis tindakan terjadwal. |
||
properties.fileDestination |
Format tujuan data tampilan. Ini opsional. |
||
properties.notificationEmail |
string |
Email alamat titik kontak yang akan mendapatkan permintaan berhenti berlangganan dan email pemberitahuan. |
|
properties.scope |
string |
Untuk tindakan terjadwal privat (Buat atau Perbarui), cakupan akan kosong. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK. Permintaan telah berhasil. |
|
201 Created |
Dibuat. |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
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
Create |
Create |
CreateOrUpdateInsightAlertScheduledActionByScope
Permintaan sampel
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource?api-version=2023-11-01
{
"kind": "InsightAlert",
"properties": {
"displayName": "Daily anomaly by resource",
"notification": {
"to": [
"user@gmail.com",
"team@gmail.com"
],
"subject": "Cost anomaly detected in the resource"
},
"schedule": {
"frequency": "Daily",
"startDate": "2020-06-19T22:21:51.1287144Z",
"endDate": "2021-06-19T22:21:51.1287144Z"
},
"status": "Enabled",
"viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
}
}
Respon sampel
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource",
"name": "dailyAnomalyByResource",
"type": "Microsoft.CostManagement/ScheduledActions",
"kind": "InsightAlert",
"eTag": "\"1d4ff9fe66f1d10\"",
"systemData": {
"createdBy": "testuser",
"createdByType": "User",
"createdAt": "2020-06-18T22:21:51.1287144Z",
"lastModifiedBy": "testuser",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-06-18T22:21:51.1287144Z"
},
"properties": {
"displayName": "Daily anomaly by resource",
"fileDestination": {
"fileFormats": []
},
"notification": {
"to": [
"user@gmail.com",
"team@gmail.com"
],
"subject": "Cost anomaly detected in the resource"
},
"schedule": {
"frequency": "Daily",
"startDate": "2020-06-19T22:21:51.1287144Z",
"endDate": "2021-06-19T22:21:51.1287144Z"
},
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
"status": "Enabled",
"viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
}
}
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource",
"name": "dailyAnomalyByResource",
"type": "Microsoft.CostManagement/ScheduledActions",
"kind": "InsightAlert",
"eTag": "\"1d4ff9fe66f1d10\"",
"systemData": {
"createdBy": "testuser",
"createdByType": "User",
"createdAt": "2020-06-18T22:21:51.1287144Z",
"lastModifiedBy": "testuser",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-06-19T22:21:51.1287144Z"
},
"properties": {
"displayName": "Daily anomaly by resource",
"fileDestination": {
"fileFormats": []
},
"notification": {
"to": [
"user@gmail.com",
"team@gmail.com"
],
"subject": "Cost anomaly detected in the resource"
},
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
"schedule": {
"frequency": "Daily",
"startDate": "2020-06-19T22:21:51.1287144Z",
"endDate": "2021-06-19T22:21:51.1287144Z"
},
"status": "Enabled",
"viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
}
}
CreateOrUpdateScheduledActionByScope
Permintaan sampel
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2023-11-01
{
"kind": "Email",
"properties": {
"displayName": "Monthly Cost By Resource",
"fileDestination": {
"fileFormats": [
"Csv"
]
},
"notification": {
"to": [
"user@gmail.com",
"team@gmail.com"
],
"subject": "Cost by resource this month"
},
"schedule": {
"frequency": "Monthly",
"weeksOfMonth": [
"First",
"Third"
],
"daysOfWeek": [
"Monday"
],
"hourOfDay": 10,
"startDate": "2020-06-19T22:21:51.1287144Z",
"endDate": "2021-06-19T22:21:51.1287144Z"
},
"status": "Enabled",
"viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
}
}
Respon sampel
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource",
"name": "monthlyCostByResource",
"type": "Microsoft.CostManagement/ScheduledActions",
"kind": "Email",
"eTag": "\"1d4ff9fe66f1d10\"",
"systemData": {
"createdBy": "testuser",
"createdByType": "User",
"createdAt": "2020-06-18T22:21:51.1287144Z",
"lastModifiedBy": "testuser",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-06-18T22:21:51.1287144Z"
},
"properties": {
"displayName": "Monthly Cost By Resource",
"fileDestination": {
"fileFormats": [
"Csv"
]
},
"notification": {
"to": [
"user@gmail.com",
"team@gmail.com"
],
"subject": "Cost by resource this month"
},
"schedule": {
"frequency": "Monthly",
"weeksOfMonth": [
"First",
"Third"
],
"daysOfWeek": [
"Monday"
],
"hourOfDay": 10,
"startDate": "2020-06-19T22:21:51.1287144Z",
"endDate": "2021-06-19T22:21:51.1287144Z"
},
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
"status": "Enabled",
"viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
}
}
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource",
"name": "monthlyCostByResource",
"type": "Microsoft.CostManagement/ScheduledActions",
"kind": "Email",
"eTag": "\"1d4ff9fe66f1d10\"",
"systemData": {
"createdBy": "testuser",
"createdByType": "User",
"createdAt": "2020-06-18T22:21:51.1287144Z",
"lastModifiedBy": "testuser",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-06-19T22:21:51.1287144Z"
},
"properties": {
"displayName": "Monthly Cost By Resource",
"notification": {
"to": [
"user@gmail.com",
"team@gmail.com"
],
"subject": "Cost by resource this month"
},
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
"schedule": {
"frequency": "Monthly",
"weeksOfMonth": [
"First",
"Third"
],
"daysOfWeek": [
"Monday"
],
"hourOfDay": 10,
"startDate": "2020-06-19T22:21:51.1287144Z",
"endDate": "2021-06-19T22:21:51.1287144Z"
},
"status": "Enabled",
"viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
}
}
Definisi
Nama | Deskripsi |
---|---|
created |
Jenis identitas yang membuat sumber daya. |
Days |
Hari dalam Seminggu. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan. Beberapa respons Kesalahan:
|
File |
Tujuan data tampilan. Ini opsional. Saat ini hanya format CSV yang didukung. |
File |
Tujuan data tampilan. Saat ini hanya format CSV yang didukung. |
Notification |
Properti pemberitahuan tindakan terjadwal. |
Scheduled |
Definisi tindakan terjadwal. |
Scheduled |
Jenis tindakan terjadwal. |
Scheduled |
Status tindakan terjadwal. |
Schedule |
Frekuensi jadwal. |
Schedule |
Properti jadwal. |
system |
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya. |
Weeks |
Minggu dalam sebulan. |
createdByType
Jenis identitas yang membuat sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DaysOfWeek
Hari dalam Seminggu.
Nama | Jenis | Deskripsi |
---|---|---|
Friday |
string |
|
Monday |
string |
|
Saturday |
string |
|
Sunday |
string |
|
Thursday |
string |
|
Tuesday |
string |
|
Wednesday |
string |
ErrorDetailsWithNestedDetails
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode Kesalahan. |
details |
Detail tambahan kesalahan. |
|
message |
string |
Pesan kesalahan yang menunjukkan mengapa operasi gagal. |
ErrorResponseWithNestedDetails
Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
Beberapa respons Kesalahan:
429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan di header "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Layanan sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".
Nama | Jenis | Deskripsi |
---|---|---|
error |
Detail kesalahan. |
FileDestination
Tujuan data tampilan. Ini opsional. Saat ini hanya format CSV yang didukung.
Nama | Jenis | Deskripsi |
---|---|---|
fileFormats |
Tujuan data tampilan. Saat ini hanya format CSV yang didukung. |
FileFormat
Tujuan data tampilan. Saat ini hanya format CSV yang didukung.
Nama | Jenis | Deskripsi |
---|---|---|
Csv |
string |
NotificationProperties
Properti pemberitahuan tindakan terjadwal.
Nama | Jenis | Deskripsi |
---|---|---|
language |
string |
Lokal email. |
message |
string |
Pesan opsional untuk ditambahkan dalam email. Panjangnya dibatasi hingga 250 karakter. |
regionalFormat |
string |
Format regional yang digunakan untuk memformat nilai tanggal/waktu dan mata uang dalam email. |
subject |
string |
Subjek email. Panjangnya dibatasi hingga 70 karakter. |
to |
string[] |
Array alamat email. |
ScheduledAction
Definisi tindakan terjadwal.
Nama | Jenis | Deskripsi |
---|---|---|
eTag |
string |
Sumber Daya Etag. Untuk panggilan pembaruan, eTag bersifat opsional dan dapat ditentukan untuk mencapai konkurensi optimis. Ambil eTag sumber daya dengan melakukan panggilan 'GET' terlebih dahulu lalu sertakan eTag terbaru sebagai bagian dari isi permintaan atau header 'If-Match' saat melakukan pembaruan. Untuk membuat panggilan, eTag tidak diperlukan. |
id |
string |
ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
Jenis tindakan terjadwal. |
|
name |
string |
Nama sumber daya. |
properties.displayName |
string |
Nama tindakan terjadwal. |
properties.fileDestination |
Format tujuan data tampilan. Ini opsional. |
|
properties.notification |
Properti pemberitahuan berdasarkan jenis tindakan terjadwal. |
|
properties.notificationEmail |
string |
Email alamat titik kontak yang akan mendapatkan permintaan berhenti berlangganan dan email pemberitahuan. |
properties.schedule |
Jadwal tindakan terjadwal. |
|
properties.scope |
string |
Untuk tindakan terjadwal privat (Buat atau Perbarui), cakupan akan kosong. |
properties.status |
Status tindakan terjadwal. |
|
properties.viewId |
string |
Tampilan analisis biayaId digunakan untuk tindakan terjadwal. Misalnya, '/providers/Microsoft.CostManagement/views/swaggerExample' |
systemData |
Jenis tindakan terjadwal. |
|
type |
string |
Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts" |
ScheduledActionKind
Jenis tindakan terjadwal.
Nama | Jenis | Deskripsi |
---|---|---|
string |
Data analisis biaya akan dikirim melalui email. |
|
InsightAlert |
string |
Informasi anomali biaya akan dikirim melalui email. Hanya tersedia pada cakupan langganan pada frekuensi harian. Jika tidak ada anomali yang terdeteksi pada sumber daya, email tidak akan dikirim. |
ScheduledActionStatus
Status tindakan terjadwal.
Nama | Jenis | Deskripsi |
---|---|---|
Disabled |
string |
Tindakan terjadwal disimpan tetapi tidak akan dijalankan. |
Enabled |
string |
Tindakan terjadwal disimpan dan akan dijalankan. |
Expired |
string |
Tindakan terjadwal kedaluwarsa. |
ScheduleFrequency
Frekuensi jadwal.
Nama | Jenis | Deskripsi |
---|---|---|
Daily |
string |
Data analisis biaya akan dikirim melalui email setiap hari. |
Monthly |
string |
Data analisis biaya akan dikirim melalui email setiap bulan. |
Weekly |
string |
Data analisis biaya akan dikirim melalui email setiap minggu. |
ScheduleProperties
Properti jadwal.
Nama | Jenis | Deskripsi |
---|---|---|
dayOfMonth |
integer |
Hari UTC di mana data analisis biaya akan dikirim melalui email. Harus antara 1 dan 31. Properti ini berlaku ketika frekuensi bulanan dan mengambil alih weeksOfMonth atau daysOfWeek. |
daysOfWeek |
Nama hari dalam bahasa Inggris tempat data analisis biaya akan dikirim melalui email. Properti ini berlaku ketika frekuensi Adalah Mingguan atau Bulanan. |
|
endDate |
string |
Tanggal akhir dan waktu tindakan terjadwal (UTC). |
frequency |
Frekuensi jadwal. |
|
hourOfDay |
integer |
Waktu UTC di mana data analisis biaya akan dikirim melalui email. |
startDate |
string |
Tanggal dan waktu mulai tindakan terjadwal (UTC). |
weeksOfMonth |
Minggu di mana data analisis biaya akan dikirim melalui email. Properti ini berlaku ketika frekuensi Bulanan dan digunakan dalam kombinasi dengan daysOfWeek. |
systemData
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
createdAt |
string |
Tanda waktu pembuatan sumber daya (UTC). |
createdBy |
string |
Identitas yang membuat sumber daya. |
createdByType |
Jenis identitas yang membuat sumber daya. |
|
lastModifiedAt |
string |
Tanda waktu modifikasi terakhir sumber daya (UTC) |
lastModifiedBy |
string |
Identitas yang terakhir memodifikasi sumber daya. |
lastModifiedByType |
Jenis identitas yang terakhir mengubah sumber daya. |
WeeksOfMonth
Minggu dalam sebulan.
Nama | Jenis | Deskripsi |
---|---|---|
First |
string |
|
Fourth |
string |
|
Last |
string |
|
Second |
string |
|
Third |
string |