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	Область, связанная с запланированными операциями действий. Это включает в себя "подписки/{subscriptionId}" для области подписки. "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для области resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" для области учетной записи выставления счетов, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId}" для области отдела", "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}" для области внешней учетной записи выставления счетов и "поставщики/Майкрософт". 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	Адрес электронной почты точки контакта, который должен получать запросы и уведомления об отмене подписки.
properties.scope		string	Для частных запланированных действий (создание или обновление) область будет пуста. Для общего запланированного действия (создание или обновление по области) область управления затратами может быть "subscriptions/{subscriptionId}" для области подписки. "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для области resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" для области учетной записи выставления счетов, "providers/Microsoft.Billing/billingAccountS/{billingAccountId}/departmentId}" для области отдела "поставщики/Майкрософт". Выставление счетов,выставление счетов/выставление счетов/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' для области EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" для области BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/accountSections/{invoiceSectionId}" для области InvoiceSection, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" для параметра "/Providers/Microsoft.CostManagement/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

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

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[]	Массив адресов электронной почты.