Scheduled Actions - Create Or Update By Scope

リファレンス

サービス:: Cost Management

API バージョン:: 2023-11-01

指定されたスコープ内で共有のスケジュールされたアクションを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	スケジュールされたアクション名。
scope	path	True	string	スケジュールされたアクション操作に関連付けられているスコープ。これには、サブスクリプションスコープの 'subscriptions/{subscriptionId}' が含まれます。 resourceGroup スコープの場合は 'subscriptions/{subscriptionId}/{resourceGroupName}'、課金アカウントスコープの場合は 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}'、Department スコープの場合は 'providers/Microsoft.Billing/billingAccountId}/{billingAccountId}/{billingAccountId}'、部門スコープの場合は 'providers/Microsoft.Billing/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}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. 注: Insight アラートは、サブスクリプションスコープでのみ使用できます。
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	Email登録解除要求と通知メールを受け取る必要がある連絡先のアドレス。
properties.scope		string	プライベートスケジュールされたアクション (作成または更新) の場合、スコープは空になります。共有スケジュールされたアクション (スコープによる作成または更新) の場合、Cost Management スコープはサブスクリプションスコープの 'subscriptions/{subscriptionId}' にすることができます。 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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}' 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}' for InvoiceSection scope, 'externalBillingAccountName}'ExternalSubscription スコープの ExternalBillingAccount スコープ、および '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}'。

応答

名前	型	説明
200 OK	ScheduledAction	OK です。要求は成功しました。
201 Created	ScheduledAction	作成されました。
Other Status Codes	ErrorResponseWithNestedDetails	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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=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"
  }
}

応答のサンプル

状態コード:: 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=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"
  }
}

応答のサンプル

状態コード:: 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	リソースを作成した ID の種類。
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

リソースを作成した ID の種類。

名前	型	説明
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' 呼び出しを行い、更新の実行中に要求本文または 'If-Match' ヘッダーの一部として最新の eTag を含めることで、リソースの 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	プライベートスケジュールされたアクション (作成または更新) の場合、スコープは空になります。共有スケジュールされたアクション (スコープによる作成または更新) の場合、Cost Management スコープはサブスクリプションスコープの 'subscriptions/{subscriptionId}' にすることができます。 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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}' 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}' for InvoiceSection scope, 'externalBillingAccountName}'ExternalSubscription スコープの ExternalBillingAccount スコープ、および '/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	コストの異常情報が電子メールで送信されます。 1 日の頻度でサブスクリプションスコープでのみ使用できます。リソースで異常が検出されない場合、電子メールは送信されません。

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	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

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

その他のリソース