Events - List By Subscription Id

  • Ссылка
Service:
Resource Health
API Version:
2024-02-01

Списки событий работоспособности служб в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01&$filter={$filter}&queryStartTime={queryStartTime}

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
 path True

string

Идентификатор целевой подписки.
api-version
 query True

string

Версия API, используемая для данной операции.
$filter
 query

string

Фильтр, применяемый к операции. Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
queryStartTime
 query

string

Указывает, когда следует возвращать события на основе свойства lastUpdateTime. Например, queryStartTime = 24.07.2020 ИЛИ queryStartTime=7%2F24%2F2020

Ответы

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

events

Список текущих событий работоспособности службы в подписке
Other Status Codes

ErrorResponse

DefaultErrorResponse

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

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

ListEventsBySubscriptionId

Sample Request

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01&$filter=service eq 'Virtual Machines' or region eq 'West US'&queryStartTime=7/24/2020

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ",
      "name": "BC_1-FXZ",
      "type": "/providers/Microsoft.ResourceHealth/events",
      "properties": {
        "eventType": "ServiceIssue",
        "eventSource": "ResourceHealth",
        "status": "Active",
        "title": "ACTIVE: Virtual machines in West US",
        "summary": "An outage alert is being investigated. More information will be provided as it is known.",
        "header": "Your service might have been impacted by an Azure service issue",
        "article": {
          "articleContent": "<html>An outage alert is being investigated. More information will be provided as it is known</html>"
        },
        "links": [
          {
            "type": "Hyperlink",
            "displayText": {
              "value": "Request RCA",
              "localizedValue": "Request RCA"
            },
            "extensionName": "Microsoft_Azure_Health",
            "bladeName": "RequestRCABlade",
            "parameters": {
              "trackingId": "BC_1-FXZ",
              "rcaRequested": "False"
            }
          },
          {
            "type": "Button",
            "displayText": {
              "value": "Sign up for updates",
              "localizedValue": "Sign up for updates"
            },
            "extensionName": "Microsoft_Azure_Health",
            "bladeName": "AzureHealthBrowseBlade",
            "parameters": {
              "trackingId": "BC_1-FXZ"
            }
          }
        ],
        "level": "Warning",
        "eventLevel": "Informational",
        "impactStartTime": "2018-11-07T00:00:00Z",
        "impactMitigationTime": "2018-11-08T00:00:00Z",
        "impact": [
          {
            "impactedService": "Virtual Machines",
            "impactedServiceGuid": "fd8065f5-ffd0-4756-8788-e6a11bf36257",
            "impactedRegions": [
              {
                "impactedRegion": "West US",
                "status": "Active",
                "impactedSubscriptions": [
                  "{subscriptionId}"
                ],
                "impactedTenants": [],
                "lastUpdateTime": "2017-12-05T21:05:00Z"
              }
            ]
          }
        ],
        "recommendedActions": {
          "message": "Recommended actions title",
          "actions": [
            {
              "groupId": 23243,
              "actionText": "action 1"
            },
            {
              "groupId": 23432,
              "actionText": "action 2"
            }
          ],
          "localeCode": "en"
        },
        "faqs": [
          {
            "question": "This is a question",
            "answer": "This is an answer",
            "localeCode": "en"
          }
        ],
        "isHIR": false,
        "enableMicrosoftSupport": true,
        "enableChatWithUs": false,
        "priority": 2,
        "lastUpdateTime": "2018-11-08T00:00:00Z",
        "hirStage": "resolved"
      }
    }
  ],
  "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}"
}

Определения

Имя Описание
Actions

Рекомендуемые действия для события работоспособности службы.
AdditionalInformation

Дополнительные сведения
Article

Статья события.
createdByType

Тип удостоверения, создавшего ресурс.
DisplayText

Отображение текста ссылки.
ErrorResponse

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

событие Работоспособность служб
EventLevelValues

Уровень события.
events

Ответ операции перечисления событий.
EventSourceValues

Источник события.
EventStatusValues

Текущее состояние события.
EventTypeValues

Тип события.
faq

Часто задаваемые вопросы о событии работоспособности службы
impact

Служба Azure, на которую влияет событие работоспособности службы.
impactedServiceRegion

Регион Azure, на который влияет событие работоспособности службы.
LevelValues

Уровень аналитики.
link

Полезные ссылки для события работоспособности службы.
LinkTypeValues

Тип ссылки
RecommendedActions

Рекомендуемые действия события.
systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.
update

Обновление для события работоспособности службы.

Actions

Рекомендуемые действия для события работоспособности службы.

Имя Тип Описание
actionText

string

Рекомендуемый текст действия
groupId

integer

Рекомендуемый идентификатор группы действий для события работоспособности службы.

AdditionalInformation

Дополнительные сведения

Имя Тип Описание
message

string

Сообщение с дополнительными сведениями

Article

Статья события.

Имя Тип Описание
articleContent

string

Содержимое статьи события.
articleId

string

Идентификатор статьи
parameters

object

Он предоставляет карту имени и значения параметра.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

DisplayText

Отображение текста ссылки.

Имя Тип Описание
localizedValue

string

Локализованный отображаемый текст ссылки.
value

string

Отображение текста ссылки.

ErrorResponse

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

Имя Тип Описание
code

string

Код ошибки.
details

string

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

string

Сообщение об ошибке.

event

событие Работоспособность служб

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса.
properties.additionalInformation

AdditionalInformation

Дополнительные сведения
properties.article

Article

Статья события.
properties.description

string

Содержит сообщение для сообщения о событии, которое может включать сводку, первопричину и другие сведения.
properties.duration

integer

длительность в секундах
properties.enableChatWithUs

boolean

Указывает, нужно ли включить или отключить служба поддержки Майкрософт для этого события.
properties.enableMicrosoftSupport

boolean

Указывает, нужно ли включить или отключить служба поддержки Майкрософт для этого события.
properties.eventLevel

EventLevelValues

Уровень события.
properties.eventSource

EventSourceValues

Источник события.
properties.eventType

EventTypeValues

Тип события.
properties.externalIncidentId

string

Идентификатор инцидента
properties.faqs

faq[]

Часто задаваемые вопросы о событии работоспособности службы.
properties.header

string

Текст заголовка события.
properties.hirStage

string

Этап для документа HIR
properties.impact

impact[]

Перечисление служб, затронутых событием работоспособности службы.
properties.impactMitigationTime

string

Он предоставляет метку времени для разрешения события, влияющего на работоспособности.
properties.impactStartTime

string

Он предоставляет метку времени для начала события, влияющего на работоспособности.
properties.impactType

string

Тип воздействия
properties.isHIR

boolean

Он предоставляет сведения о том, является ли событие событием высокой частоты инцидентов.
properties.lastUpdateTime

string

Он предоставляет метку времени для последнего обновления события, влияющего на работоспособности.
properties.level

LevelValues

Уровень аналитики.
properties.links

link[]

Полезные ссылки на событие.
properties.platformInitiated

boolean

Имеет значение true, если событие инициировано платформой.
properties.priority

integer

Уровень приоритета события. Имеет значение от 0 до 23. 0 является наивысшим приоритетом. События проблем со службами имеют более высокий приоритет, за которым следует плановое обслуживание и рекомендации по работоспособности. Критические события имеют более высокий приоритет, за которым следует ошибка, предупреждение и информация. Кроме того, активные события имеют более высокий приоритет, чем разрешенные.
properties.reason

string

Причина инцидента
properties.recommendedActions

RecommendedActions

Рекомендуемые действия события.
properties.status

EventStatusValues

Текущее состояние события.
properties.summary

string

Сводный текст события.
properties.title

string

Текст заголовка события.
systemData

systemData

Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

EventLevelValues

Уровень события.

Имя Тип Описание
Critical

string

Error

string

Informational

string

Warning

string

events

Ответ операции перечисления событий.

Имя Тип Описание
nextLink

string

Универсальный код ресурса (URI) для получения следующей страницы событий. Вызовите ListNext() с этим URI, чтобы получить следующую страницу событий.
value

event[]

Список событий.

EventSourceValues

Источник события.

Имя Тип Описание
ResourceHealth

string

ServiceHealth

string

EventStatusValues

Текущее состояние события.

Имя Тип Описание
Active

string

Resolved

string

EventTypeValues

Тип события.

Имя Тип Описание
EmergingIssues

string

HealthAdvisory

string

PlannedMaintenance

string

RCA

string

SecurityAdvisory

string

ServiceIssue

string

faq

Часто задаваемые вопросы о событии работоспособности службы

Имя Тип Описание
answer

string

Ответ на часто задаваемые вопросы о событии работоспособности службы.
localeCode

string

Языковой стандарт часто задаваемых вопросов для события работоспособности службы.
question

string

Вопросы и ответы о событии работоспособности службы.

impact

Служба Azure, на которую влияет событие работоспособности службы.

Имя Тип Описание
impactedRegions

impactedServiceRegion[]

Перечисление регионов, на которые влияет событие работоспособности службы.
impactedService

string

Имя затронутой службы.
impactedServiceGuid

string

Затронутый guid службы. Это постоянный идентификатор затронутой службы.

impactedServiceRegion

Регион Azure, на который влияет событие работоспособности службы.

Имя Тип Описание
impactedRegion

string

Имя затронутого региона.
impactedSubscriptions

string[]

Выведите список подписок, затронутых событием работоспособности службы.
impactedTenants

string[]

Вывод списка клиентов, затронутых событием работоспособности службы.
lastUpdateTime

string

Он предоставляет метку времени для последнего обновления события работоспособности службы.
status

EventStatusValues

Текущее состояние события в регионе.
updates

update[]

Список обновлений для заданного события работоспособности службы.

LevelValues

Уровень аналитики.

Имя Тип Описание
Critical

string

Warning

string

Полезные ссылки для события работоспособности службы.

Имя Тип Описание
bladeName

string

Он предоставляет имя колонки расширения портала для создания ссылки на заданное событие работоспособности службы.
displayText

DisplayText

Отображение текста ссылки.
extensionName

string

Оно предоставляет имя расширения портала для создания ссылки на данное событие работоспособности службы.
parameters

object

Он предоставляет карту имени и значения параметра для колонки расширения портала, чтобы создать lik для данного события работоспособности службы.
type

LinkTypeValues

Тип ссылки

LinkTypeValues

Тип ссылки

Имя Тип Описание
Button

string

Hyperlink

string

RecommendedActions

Рекомендуемые действия события.

Имя Тип Описание
actions

Actions[]

Рекомендуемые действия для события работоспособности службы.
localeCode

string

Рекомендуемый языковой стандарт действия для события работоспособности службы.
message

string

Заголовок рекомендуемого действия для события работоспособности службы.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.

update

Обновление для события работоспособности службы.

Имя Тип Описание
summary

string

Сводный текст для данного обновления для события работоспособности службы.
updateDateTime

string

Он предоставляет метку времени для данного обновления для события работоспособности службы.