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

Scheduled Actions - List By Scope

列出给定范围内的所有共享计划操作。

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions?api-version=2023-11-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions?api-version=2023-11-01&$filter={$filter}

URI 参数

名称 必需 类型 说明
scope
path True

string

与计划操作关联的范围。 这包括订阅范围的“subscriptions/{subscriptionId}” resourceGroup 范围的“subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”,“providers/Microsoft.Billing/billingAccounts/{billingAccountId}”为计费帐户范围,“providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccounts/{departmentId}”,'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId},对于 EnrollmentAccount 范围,“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}”,对于 BillingProfile 范围, 对于 InvoiceSection 范围,“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}”、“providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}”和“providers/Microsoft”。外部订阅范围的 CostManagement/externalSubscriptions/{externalSubscriptionName}' 。 注意:见解警报仅在订阅范围内可用。

api-version
query True

string

要用于此操作的 API 版本。

$filter
query

string

可用于按 properties/viewId 筛选计划操作。 支持的运算符为“eq”。

响应

名称 类型 说明
200 OK

ScheduledActionListResult

没问题。 请求已成功。

Other Status Codes

ErrorResponseWithNestedDetails

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ScheduledActionsListByScope
ScheduledActionsListByScopeFilterByViewId

ScheduledActionsListByScope

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions?api-version=2023-11-01

示例响应

{
  "value": [
    {
      "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",
        "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
        "status": "Enabled",
        "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample",
        "schedule": {
          "frequency": "Monthly",
          "weeksOfMonth": [
            "First",
            "Third"
          ],
          "daysOfWeek": [
            "Monday"
          ],
          "hourOfDay": 10,
          "startDate": "2020-06-19T22:21:51.1287144Z",
          "endDate": "2021-06-19T22:21:51.1287144Z"
        },
        "notification": {
          "to": [
            "user@gmail.com",
            "team@gmail.com"
          ],
          "subject": "Cost by resource this month"
        }
      }
    },
    {
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource",
      "name": "dailyCostByResource",
      "type": "Microsoft.CostManagement/ScheduledActions",
      "kind": "Email",
      "eTag": "\"1d4ff9fe66f1d15\"",
      "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 Cost By Resource",
        "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
        "status": "Disabled",
        "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample",
        "schedule": {
          "frequency": "Daily",
          "hourOfDay": 12,
          "startDate": "2020-06-19T22:21:51.1287144Z",
          "endDate": "2021-06-19T22:21:51.1287144Z"
        },
        "notification": {
          "to": [
            "user@gmail.com",
            "team@gmail.com"
          ],
          "subject": "Daily Cost By Resource"
        }
      }
    }
  ],
  "nextLink": null
}

ScheduledActionsListByScopeFilterByViewId

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions?api-version=2023-11-01&$filter=properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'

示例响应

{
  "value": [
    {
      "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",
        "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
        "status": "Enabled",
        "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample",
        "schedule": {
          "frequency": "Monthly",
          "weeksOfMonth": [
            "First",
            "Third"
          ],
          "daysOfWeek": [
            "Monday"
          ],
          "hourOfDay": 10,
          "startDate": "2020-06-19T22:21:51.1287144Z",
          "endDate": "2021-06-19T22:21:51.1287144Z"
        },
        "notification": {
          "to": [
            "user@gmail.com",
            "team@gmail.com"
          ],
          "subject": "Cost by resource this month"
        }
      }
    },
    {
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource",
      "name": "dailyCostByResource",
      "type": "Microsoft.CostManagement/ScheduledActions",
      "kind": "Email",
      "eTag": "\"1d4ff9fe66f1d15\"",
      "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 Cost By Resource",
        "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
        "status": "Disabled",
        "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample",
        "schedule": {
          "frequency": "Daily",
          "hourOfDay": 12,
          "startDate": "2020-06-19T22:21:51.1287144Z",
          "endDate": "2021-06-19T22:21:51.1287144Z"
        },
        "notification": {
          "to": [
            "user@gmail.com",
            "team@gmail.com"
          ],
          "subject": "Daily Cost By Resource"
        }
      }
    }
  ],
  "nextLink": null
}

定义

名称 说明
createdByType

创建资源的标识类型。

DaysOfWeek

周中的天数。

ErrorDetailsWithNestedDetails

错误的详细信息。

ErrorResponseWithNestedDetails

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

某些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 等待“Retry-After”标头中指定的时间后重试。

FileDestination

视图数据的目标。 此为可选项。 目前仅支持 CSV 格式。

FileFormat

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

NotificationProperties

计划操作通知的属性。

ScheduledAction

计划操作定义。

ScheduledActionKind

计划操作的类型。

ScheduledActionListResult

计划操作列表结果。 它包含计划操作的列表。

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 是可选的,可以指定 eTag 以实现乐观并发。 在执行更新时,先执行“GET”调用,然后将最新的 eTag 作为请求正文或“If-Match”标头的一部分来获取资源的 eTag。 对于创建调用,eTag 不是必需的。

id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

ScheduledActionKind

计划操作的类型。

name

string

资源的名称

properties.displayName

string

计划的操作名称。

properties.fileDestination

FileDestination

视图数据的目标格式。 此为可选项。

properties.notification

NotificationProperties

基于计划操作类型的通知属性。

properties.notificationEmail

string

Email应获取取消订阅请求和通知电子邮件的联系人地址。

properties.schedule

ScheduleProperties

计划操作的计划。

properties.scope

string

对于 (创建或更新) 的专用计划操作,范围将为空。
对于共享的计划操作, (按范围) 创建或更新, 对于订阅范围,成本管理范围可以是“subscriptions/{subscriptionId}”,对于 resourceGroup 范围,“subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”,对于计费帐户范围,“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{departmentId}”为“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}”,“providers/Microsoft”。Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}'for EnrollmentAccount 范围, BillingProfile 范围的“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}”,“providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}”,“/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

计划操作的类型。

名称 类型 说明
Email

string

成本分析数据将通过电子邮件发送。

InsightAlert

string

成本异常信息将通过电子邮件发送。 仅在订阅范围内以每日频率提供。 如果未在资源上检测到异常,则不会发送电子邮件。

ScheduledActionListResult

计划操作列表结果。 它包含计划操作的列表。

名称 类型 说明
nextLink

string

链接 (url) 到结果的下一页。

value

ScheduledAction[]

计划操作的列表。

ScheduledActionStatus

计划操作的状态。

名称 类型 说明
Disabled

string

已保存计划操作,但不会运行。

Enabled

string

计划的操作已保存并运行。

Expired

string

计划的操作已过期。

ScheduleFrequency

计划的频率。

名称 类型 说明
Daily

string

成本分析数据将每天通过电子邮件发送。

Monthly

string

成本分析数据将每月通过电子邮件发送一次。

Weekly

string

成本分析数据将每周通过电子邮件发送一次。

ScheduleProperties

计划的属性。

名称 类型 说明
dayOfMonth

integer

将通过电子邮件发送成本分析数据的 UTC 日。 必须介于 1 到 31 之间。 当 frequency 为 Monthly 且重写 weeksOfMonth 或 daysOfWeek 时,此属性适用。

daysOfWeek

DaysOfWeek[]

将通过电子邮件发送成本分析数据的英文日期名称。 当频率为“每周”或“每月”时,此属性适用。

endDate

string

计划操作的结束日期和时间 (UTC) 。

frequency

ScheduleFrequency

计划的频率。

hourOfDay

integer

将通过电子邮件发送成本分析数据的 UTC 时间。

startDate

string

计划操作的开始日期和时间 (UTC) 。

weeksOfMonth

WeeksOfMonth[]

通过电子邮件发送成本分析数据的周数。 当 frequency 为 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