Scheduled Actions - Create Or Update By Scope

參考

服務:: Cost Management

API 版本:: 2024-08-01

在指定的範圍內建立或更新共用排程動作。

PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2024-08-01

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	排程的動作名稱。
scope	path	True	string	與排程動作作業相關聯的範圍。這包括訂用帳戶範圍的 'subscriptions/{subscriptionId}'，resourceGroup 範圍的 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' '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/{EnrollmentAccount 範圍的 enrollmentAccount 範圍，'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope， 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope， 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.外部訂用帳戶範圍的 CostManagement/externalSubscriptions/{externalSubscriptionName}'。注意：深入解析警示僅適用於訂用帳戶範圍。
api-version	query	True	string	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
If-Match		string	實體的 ETag。建立實體時不需要。更新實體時為選擇性，而且可以指定來達成開放式並行存取。

要求本文

名稱	必要	類型	Description
properties.displayName	True	string	排程的動作名稱。
properties.notification	True	NotificationProperties	根據排程動作種類的通知屬性。
properties.schedule	True	ScheduleProperties	排程動作的排程。
properties.status	True	ScheduledActionStatus	排程動作的狀態。
properties.viewId	True	string	用於排程動作的成本分析 viewId。例如，'/providers/Microsoft.CostManagement/views/swaggerExample'
kind		ScheduledActionKind	排程動作的種類。
properties.fileDestination		FileDestination	檢視數據的目的地格式。這是選擇性的。
properties.notificationEmail		string	應取得取消訂閱要求和通知電子郵件之聯繫人的電子郵件位址。
properties.scope		string	針對私人排程動作（建立或更新），範圍會是空的。針對共用排程動作（建立或依範圍更新），成本管理範圍可以是訂用帳戶範圍的 'subscriptions/{subscriptionId}'，資源群組範圍的 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'、'providers/Microsoft.Billing/billingAccounts/{billingAccountId}'、'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope， 'providers/Microsoft。EnrollmentAccount 範圍的 Billing/billingAccounts/{billingAccountId}/{enrollmentAccountId}'、'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope， 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope， '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}'ExternalBillingAccount 範圍，以及 ExternalSubscription 範圍的 '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}'。

回應

名稱	類型	Description
200 OK	ScheduledAction	還行。要求已成功。
201 Created	ScheduledAction	創建。
Other Status Codes	ErrorResponseWithNestedDetails	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

CreateOrUpdateInsightAlertScheduledActionByScope

CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

範例要求

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource?api-version=2024-08-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"
  }
}

範例回覆

狀態碼:: 201

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

狀態碼:: 200

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

範例要求

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2024-08-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"
  }
}

範例回覆

狀態碼:: 201

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

狀態碼:: 200

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

定義

名稱	Description
createdByType	建立資源的身分識別類型。
DaysOfWeek	星期幾。
ErrorDetailsWithNestedDetails	錯誤的詳細數據。
ErrorResponseWithNestedDetails	錯誤回應表示服務無法處理傳入要求。錯誤訊息中會提供原因。某些錯誤回應： 429 TooManyRequests - 要求已節流。等候「x-ms-ratelimit-microsoft.consumption-retry-after」標頭中指定的時間後重試。 503 ServiceUnavailable - 服務暫時無法使用。等候「Retry-After」標頭中指定的時間後重試。
FileDestination	檢視數據的目的地。這是選擇性的。目前僅支援 CSV 格式。
FileFormat	檢視數據的目的地。目前僅支援 CSV 格式。
NotificationProperties	排程動作通知的屬性。
ScheduledAction	排程的動作定義。
ScheduledActionKind	排程動作的種類。
ScheduledActionStatus	排程動作的狀態。
ScheduleFrequency	排程的頻率。
ScheduleProperties	排程的屬性。
systemData	與建立和上次修改資源相關的元數據。
WeeksOfMonth	月數周。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DaysOfWeek

星期幾。

名稱	類型	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorDetailsWithNestedDetails

錯誤的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	ErrorDetailsWithNestedDetails[]	錯誤的其他詳細數據。
message	string	錯誤訊息，指出作業失敗的原因。

ErrorResponseWithNestedDetails

錯誤回應表示服務無法處理傳入要求。錯誤訊息中會提供原因。

某些錯誤回應：

429 TooManyRequests - 要求已節流。等候「x-ms-ratelimit-microsoft.consumption-retry-after」標頭中指定的時間後重試。
503 ServiceUnavailable - 服務暫時無法使用。等候「Retry-After」標頭中指定的時間後重試。

名稱	類型	Description
error	ErrorDetailsWithNestedDetails	錯誤的詳細數據。

FileDestination

檢視數據的目的地。這是選擇性的。目前僅支援 CSV 格式。

名稱	類型	Description
fileFormats	FileFormat[]	檢視數據的目的地。目前僅支援 CSV 格式。

FileFormat

檢視數據的目的地。目前僅支援 CSV 格式。

名稱	類型	Description
Csv	string

NotificationProperties

排程動作通知的屬性。

名稱	類型	Description
language	string	電子郵件的地區設定。
message	string	要新增至電子郵件的選擇性訊息。長度限制為 250 個字元。
regionalFormat	string	用於格式化電子郵件中日期/時間和貨幣值的區域格式。
subject	string	電子郵件的主旨。長度限制為 70 個字元。
to	string[]	電子郵件地址的陣列。

ScheduledAction

排程的動作定義。

名稱	類型	Description
eTag	string	資源 Etag。針對更新呼叫，eTag 是選擇性的，可以指定以達到開放式並行存取。先執行 'GET' 呼叫來擷取資源的 eTag，然後在執行更新時，將最新的 eTag 包含在要求本文或 'If-Match' 標頭中。針對建立呼叫，不需要 eTag。
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	ScheduledActionKind	排程動作的種類。
name	string	資源的名稱
properties.displayName	string	排程的動作名稱。
properties.fileDestination	FileDestination	檢視數據的目的地格式。這是選擇性的。
properties.notification	NotificationProperties	根據排程動作種類的通知屬性。
properties.notificationEmail	string	應取得取消訂閱要求和通知電子郵件之聯繫人的電子郵件位址。
properties.schedule	ScheduleProperties	排程動作的排程。
properties.scope	string	針對私人排程動作（建立或更新），範圍會是空的。針對共用排程動作（建立或依範圍更新），成本管理範圍可以是訂用帳戶範圍的 'subscriptions/{subscriptionId}'，資源群組範圍的 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'、'providers/Microsoft.Billing/billingAccounts/{billingAccountId}'、'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope， 'providers/Microsoft。EnrollmentAccount 範圍的 Billing/billingAccounts/{billingAccountId}/{enrollmentAccountId}'、'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope， 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope， '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}'ExternalBillingAccount 範圍，以及 ExternalSubscription 範圍的 '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}'。
properties.status	ScheduledActionStatus	排程動作的狀態。
properties.viewId	string	用於排程動作的成本分析 viewId。例如，'/providers/Microsoft.CostManagement/views/swaggerExample'
systemData	systemData	排程動作的種類。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ScheduledActionKind

排程動作的種類。

名稱	類型	Description
Email	string	成本分析數據將會以電子郵件傳送。
InsightAlert	string	成本異常資訊將會以電子郵件傳送。僅適用於每日頻率的訂用帳戶範圍。如果未在資源上偵測到異常，將不會傳送電子郵件。

ScheduledActionStatus

排程動作的狀態。

名稱	類型	Description
Disabled	string	已儲存排程的動作，但不會執行。
Enabled	string	已儲存排程的動作，且將會執行。
Expired	string	排程的動作已過期。

ScheduleFrequency

排程的頻率。

名稱	類型	Description
Daily	string	成本分析數據會每天以電子郵件傳送。
Monthly	string	每個月都會傳送成本分析數據的電子郵件。
Weekly	string	成本分析數據每周都會以電子郵件傳送。

ScheduleProperties

排程的屬性。

名稱	類型	Description
dayOfMonth	integer	將傳送成本分析數據的UTC日期。必須介於 1 到 31 之間。當 frequency 為 Monthly 並覆寫 weeksOfMonth 或 daysOfWeek 時，此屬性適用。
daysOfWeek	DaysOfWeek[]	將傳送成本分析數據的英文日期名稱。當 frequency 為 Weekly 或 Monthly 時，此屬性適用。
endDate	string	排程動作的結束日期和時間（UTC）。
frequency	ScheduleFrequency	排程的頻率。
hourOfDay	integer	將傳送成本分析數據的UTC時間。
startDate	string	排程動作的開始日期和時間（UTC）。
weeksOfMonth	WeeksOfMonth[]	將傳送成本分析數據的周。當 frequency 是 Monthly 且與 daysOfWeek 搭配使用時，此屬性就適用。

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

WeeksOfMonth

月數周。

名稱	類型	Description
First	string
Fourth	string
Last	string
Second	string
Third	string

共用方式為

Scheduled Actions - Create Or Update By Scope

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

範圍

範例

CreateOrUpdateInsightAlertScheduledActionByScope

範例要求

範例回覆

CreateOrUpdateScheduledActionByScope

範例要求

範例回覆

定義

createdByType

DaysOfWeek

ErrorDetailsWithNestedDetails

ErrorResponseWithNestedDetails

FileDestination

FileFormat

NotificationProperties

ScheduledAction

ScheduledActionKind

ScheduledActionStatus

ScheduleFrequency

ScheduleProperties

systemData

WeeksOfMonth

其他資源