你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
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 范围的 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}' for External Billing Account scope and 'providers/Microsoft' 。外部订阅范围的 CostManagement/externalSubscriptions/{externalSubscriptionName}' 。注意：见解警报仅适用于订阅范围。
api-version	query	True	string	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	实体的 ETag。创建实体时不需要。更新实体时是可选的，可以指定以实现乐观并发。

请求正文

名称	必需	类型	说明
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}” ， resourceGroup 范围的“subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”、计费帐户范围的“providers/Microsoft.Billing/billingAccounts/{billingAccountId}”、“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}”（用于部门范围）的“providers/Microsoft”。Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope， '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}' forExternalBillingAccount 范围和 ExternalSubscription 作用域的“/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}”。

响应

名称	类型	说明
200 OK	ScheduledAction	还行。请求已成功。
201 Created	ScheduledAction	创建。
Other Status Codes	ErrorResponseWithNestedDetails	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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"
  }
}

定义

名称	说明
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

创建资源的标识的类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DaysOfWeek

星期几。

名称	类型	说明
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorDetailsWithNestedDetails

错误的详细信息。

名称	类型	说明
code	string	错误代码。
details	ErrorDetailsWithNestedDetails[]	错误的其他详细信息。
message	string	指示操作失败的原因的错误消息。

ErrorResponseWithNestedDetails

错误响应指示服务无法处理传入请求。错误消息中提供了原因。

一些错误响应：

429 TooManyRequests - 请求受到限制。等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。
503 ServiceUnavailable - 服务暂时不可用。在等待“Retry-After”标头中指定的时间后重试。

名称	类型	说明
error	ErrorDetailsWithNestedDetails	错误的详细信息。

FileDestination

视图数据的目标。这是可选的。目前仅支持 CSV 格式。

名称	类型	说明
fileFormats	FileFormat[]	视图数据的目标。目前仅支持 CSV 格式。

FileFormat

视图数据的目标。目前仅支持 CSV 格式。

名称	类型	说明
Csv	string

NotificationProperties

计划操作通知的属性。

名称	类型	说明
language	string	电子邮件的区域设置。
message	string	要添加到电子邮件中的可选邮件。长度限制为 250 个字符。
regionalFormat	string	用于设置电子邮件中日期/时间和货币值的格式的区域格式。
subject	string	电子邮件的主题。长度限制为 70 个字符。
to	string[]	电子邮件地址数组。

ScheduledAction

计划的操作定义。

名称	类型	说明
eTag	string	资源 Etag。对于更新调用，eTag 是可选的，可以指定以实现乐观并发。先执行“GET”调用，然后在执行更新时将最新的 eTag 作为请求正文的一部分或“If-Match”标头来提取资源的 eTag。对于创建调用，不需要 eTag。
id	string	资源的完全限定资源 ID。 Ex - /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}” ， resourceGroup 范围的“subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”、计费帐户范围的“providers/Microsoft.Billing/billingAccounts/{billingAccountId}”、“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}”（用于部门范围）的“providers/Microsoft”。Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope， '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}' forExternalBillingAccount 范围和 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

计划的操作的类型。

名称	类型	说明
Email	string	成本分析数据将通过电子邮件发送。
InsightAlert	string	成本异常信息将通过电子邮件发送。仅在每日频率的订阅范围内可用。如果未在资源上检测到异常，则不会发送电子邮件。

ScheduledActionStatus

计划操作的状态。

名称	类型	说明
Disabled	string	已保存计划操作，但不会运行。
Enabled	string	已保存计划操作，将运行。
Expired	string	计划操作已过期。

ScheduleFrequency

计划的频率。

名称	类型	说明
Daily	string	成本分析数据将每天发送电子邮件。
Monthly	string	每月都会通过电子邮件发送成本分析数据。
Weekly	string	成本分析数据将每周发送电子邮件。

ScheduleProperties

计划的属性。

名称	类型	说明
dayOfMonth	integer	将通过电子邮件发送成本分析数据的 UTC 日期。必须介于 1 和 31 之间。当频率为 Monthly 并重写 weeksOfMonth 或 daysOfWeek 时，此属性适用。
daysOfWeek	DaysOfWeek[]	将通过电子邮件发送成本分析数据的英文日期名称。当频率为每周或每月时，此属性适用。
endDate	string	计划操作（UTC）的结束日期和时间。
frequency	ScheduleFrequency	计划的频率。
hourOfDay	integer	将通过电子邮件发送成本分析数据的 UTC 时间。
startDate	string	计划操作的开始日期和时间（UTC）。
weeksOfMonth	WeeksOfMonth[]	将通过电子邮件发送成本分析数据的周数。当频率为 Monthly 且与 daysOfWeek 结合使用时，此属性适用。

systemData

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

WeeksOfMonth

月数周。

名称	类型	说明
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

其他资源