Поделиться через

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}" для область подписки, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для resourceGroup область, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" для учетной записи выставления счетов область, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" для отдела область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' для EnrollmentAccount область, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" for BillingProfile область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" для InvoiceSection область, "providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" для внешней учетной записи выставления счетов область и "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

Представление анализа затрат. Идентификатор, используемый для запланированного действия. Например, "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Тип запланированного действия.
properties.fileDestination

FileDestination

Формат назначения данных представления. Водить описание не обязательно.
properties.notificationEmail

string

Email адрес контактного лица, который должен получать запросы на отмену подписки и уведомления по электронной почте.
properties.scope

string

Для закрытого запланированного действия (создание или обновление) область будет пустым.
Для общего запланированного действия (создание или обновление по области) область управления затратами может быть "subscriptions/{subscriptionId}" для область подписки, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для resourceGroup область, "providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}" для учетной записи выставления счетов область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department область, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" для enrollmentAccount область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' для BillingProfile область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' для область InvoiceSection, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" для ExternalBillingAccount область и "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" для ExternalSubscription область.

Ответы

Имя Тип Описание
200 OK

ScheduledAction

Все в порядке. Запрос выполнен успешно.
201 Created

ScheduledAction

Создан.
Other Status Codes

ErrorResponseWithNestedDetails

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Образец запроса

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

Образец запроса

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

Тип удостоверения, создавшего ресурс.
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 не требуется.
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

Email адрес контактного лица, который должен получать запросы на отмену подписки и уведомления по электронной почте.
properties.schedule

ScheduleProperties

Расписание запланированного действия.
properties.scope

string

Для закрытого запланированного действия (создание или обновление) область будет пустым.
Для общего запланированного действия (создание или обновление по области) область управления затратами может быть "subscriptions/{subscriptionId}" для область подписки, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для resourceGroup область, "providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}" для учетной записи выставления счетов область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department область, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" для enrollmentAccount область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' для BillingProfile область, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' для область InvoiceSection, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" для ExternalBillingAccount область и "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" для ExternalSubscription область.
properties.status

ScheduledActionStatus

Состояние запланированного действия.
properties.viewId

string

Представление анализа затрат. Идентификатор, используемый для запланированного действия. Например, "/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. Это свойство применимо, если 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