Alerts - Get

Ссылка

Служба:: Cost Management

Версия API:: 2024-08-01

Возвращает оповещение для области по идентификатору оповещения.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}?api-version=2024-08-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
alertId	path	True	string	Идентификатор оповещения
scope	path	True	string	Область, связанная с операциями оповещений. Это включает в себя "/subscriptions/{subscriptionId}/" для области подписки, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для области resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' для области учетной записи выставления счетов и "/поставщики/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId}" для области отдела, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' для области EnrollmentAccount, "/providers/Microsoft.Management/managementGroups/{managementGroupId} для области группы управления, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" для области выставления счетов, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceProfileId/accountSections/{invoiceSectionId}" для области выставления счетов и "/поставщики/Майкрософт". Выставление счетов,выставление счетов/выставление счетов/{billingAccountId}/customers/{customerId}" для партнеров.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	Alert	ХОРОШО. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

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

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2024-08-01

Пример ответа

Код состояния:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Active",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

SingleSubscriptionAlerts

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

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2024-08-01

Пример ответа

Код состояния:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Active",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

Определения

Имя	Описание
Alert	Отдельное оповещение.
AlertCategory	Категория оповещений
AlertCriteria	Критерии, активировающие оповещение
AlertOperator	оператор, используемый для сравнения currentSpend с суммой
AlertSource	Источник оповещений
AlertStatus	Состояние оповещения
AlertTimeGrainType	Тип каденции timegrain
AlertType	тип оповещения
Definition	определяет тип оповещения
Details	Сведения о оповещении
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
TagFilter	теги для фильтрации по

Alert

Отдельное оповещение.

Имя	Тип	Описание
eTag	string	eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию или нет.
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.closeTime	string	dateTime, в котором было закрыто оповещение
properties.costEntityId	string	связанный бюджет
properties.creationTime	string	dateTime, в которой было создано оповещение
properties.definition	Definition	определяет тип оповещения
properties.description	string	Описание оповещения
properties.details	Details	Сведения о оповещении
properties.modificationTime	string	dateTime, в котором оповещение было изменено в последний раз
properties.source	AlertSource	Источник оповещений
properties.status	AlertStatus	Состояние оповещения
properties.statusModificationTime	string	dateTime, в котором последнее изменение состояния оповещения
properties.statusModificationUserName	string	Пользователь, который последний раз изменил оповещение
type	string	Тип ресурса.

AlertCategory

Категория оповещений

Имя	Тип	Описание
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

Критерии, активировающие оповещение

Имя	Тип	Описание
CostThresholdExceeded	string
CreditThresholdApproaching	string
CreditThresholdReached	string
CrossCloudCollectionError	string
CrossCloudNewDataAvailable	string
ForecastCostThresholdExceeded	string
ForecastUsageThresholdExceeded	string
GeneralThresholdError	string
InvoiceDueDateApproaching	string
InvoiceDueDateReached	string
MultiCurrency	string
QuotaThresholdApproaching	string
QuotaThresholdReached	string
UsageThresholdExceeded	string

AlertOperator

оператор, используемый для сравнения currentSpend с суммой

Имя	Тип	Описание
EqualTo	string
GreaterThan	string
GreaterThanOrEqualTo	string
LessThan	string
LessThanOrEqualTo	string
None	string

AlertSource

Источник оповещений

Имя	Тип	Описание
Preset	string
User	string

AlertStatus

Состояние оповещения

Имя	Тип	Описание
Active	string
Dismissed	string
None	string
Overridden	string
Resolved	string

AlertTimeGrainType

Тип каденции timegrain

Имя	Тип	Описание
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
None	string
Quarterly	string

AlertType

тип оповещения

Имя	Тип	Описание
Budget	string
BudgetForecast	string
Credit	string
General	string
Invoice	string
Quota	string
xCloud	string

Definition

определяет тип оповещения

Имя	Тип	Описание
category	AlertCategory	Категория оповещений
criteria	AlertCriteria	Критерии, активировающие оповещение
type	AlertType	тип оповещения

Details

Сведения о оповещении

Имя	Тип	Описание
amount	number	Сумма порогового значения бюджета
companyName	string	название компании
contactEmails	string[]	список сообщений электронной почты для контакта
contactGroups	string[]	список групп действий для трансляции
contactRoles	string[]	список ролей контактов
currentSpend	number	текущие расходы
departmentName	string	Имя отдела
enrollmentEndDate	string	datetime of enrollmentEndDate
enrollmentNumber	string	номер регистрации
enrollmentStartDate	string	datetime of enrollmentStartDate
invoicingThreshold	number	Пороговое значение для выставления счетов
meterFilter	AlertProperties.details.MeterFilter[]	массив метров для фильтрации по
operator	AlertOperator	оператор, используемый для сравнения currentSpend с суммой
overridingAlert	string	Переопределение оповещений
periodStartDate	string	datetime of periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	массив ресурсов для фильтрации по
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	массив групп ресурсов для фильтрации по
tagFilter	TagFilter	теги для фильтрации по
threshold	number	Процент порогового значения уведомления в виде десятичного значения, активируемого этим оповещением
timeGrainType	AlertTimeGrainType	Тип каденции timegrain
triggeredBy	string	notificationId, активировав это оповещение
unit	string	единица используемой валюты

ErrorDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке.

TagFilter

теги для фильтрации по

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

Alerts - Get

Параметры URI

Ответы

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

azure_auth

Области

Примеры

SingleResourceGroupAlerts

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

Пример ответа

SingleSubscriptionAlerts

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

Пример ответа

Определения

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

Дополнительные ресурсы