你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Events - List By Subscription Id

参考

服务:: Resource Health

API 版本:: 2024-02-01

列出订阅中的服务运行状况事件。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01

具有可选参数:

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 minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
$filter	query		string	要应用于作的筛选器。有关详细信息，请参阅 https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
queryStartTime	query		string	根据 lastUpdateTime 属性指定从何时返回事件。例如，queryStartTime = 2020/7/24 OR queryStartTime=7%2F24%2F2020

响应

名称	类型	说明
200 OK	events	订阅中当前服务运行状况事件的列表
Other Status Codes	ErrorResponse	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ListEventsBySubscriptionId

示例请求

HTTP

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

示例响应

状态代码:: 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	List 事件作响应。
EventSourceValues	事件源。
EventStatusValues	事件的当前状态。
EventTypeValues	事件类型。
faq	服务运行状况事件的常见问题解答
impact	受服务运行状况事件影响的 Azure 服务。
impactedServiceRegion	受服务运行状况事件影响的 Azure 区域。
LevelValues	见解级别。
link	服务运行状况事件的有用链接。
LinkTypeValues	链接的类型。
RecommendedActions	建议的事件作。
systemData	与创建和上次修改资源相关的元数据。
update	服务运行状况事件的更新。

Actions

Object

针对服务运行状况事件的建议作。

名称	类型	说明
actionText	string	建议的作文本
groupId	integer (int32)	服务运行状况事件的建议作组 ID。

AdditionalInformation

Object

其他信息

名称	类型	说明
message	string	其他信息消息

Article

Object

事件文章。

名称	类型	说明
articleContent	string	事件的文章内容。
articleId	string	项目 ID
parameters	object	它提供参数名称和值的映射

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DisplayText

Object

显示链接的文本。

名称	类型	说明
localizedValue	string	链接的本地化显示文本。
value	string	显示链接的文本。

ErrorResponse

Object

错误详细信息。

名称	类型	说明
code	string	错误代码。
details	string	错误详细信息。
message	string	错误消息。

event

Object

服务运行状况事件

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.additionalInformation	AdditionalInformation	其他信息
properties.article	Article	事件文章。
properties.description	string	包含事件的通信消息，其中包括摘要、根本原因和其他详细信息。
properties.duration	integer (int32)	持续时间（以秒为单位）
properties.enableChatWithUs	boolean	告知我们是否要启用或禁用此事件的Microsoft支持。
properties.enableMicrosoftSupport	boolean	告知我们是否要启用或禁用此事件的Microsoft支持。
properties.eventLevel	EventLevelValues	事件级别。
properties.eventSource	EventSourceValues	事件源。
properties.eventType	EventTypeValues	事件类型。
properties.externalIncidentId	string	事件的 ID
properties.faqs	faq[]	服务运行状况事件的常见问题。
properties.header	string	事件的标头文本。
properties.hirStage	string	HIR 文档阶段
properties.impact	impact[]	列出受服务运行状况事件影响的服务。
properties.impactMitigationTime	string (date-time)	它为运行状况影响事件解析的时间提供时间戳。
properties.impactStartTime	string (date-time)	它提供运行状况影响事件启动时的时间戳。
properties.impactType	string	影响的类型
properties.isHIR	boolean	如果事件是高事件率事件，则提供信息。
properties.lastUpdateTime	string (date-time)	它提供上次更新运行状况影响事件的时间戳。
properties.level	LevelValues	见解级别。
properties.links	link[]	事件的有用链接。
properties.platformInitiated	boolean	如果事件已启动平台，则为 true。
properties.priority	integer (int32)	事件的优先级。值为 0 到 23。 0 是最高优先级。服务问题事件具有更高的优先级，然后是计划内维护和运行状况公告。关键事件具有更高的优先级，后跟错误、警告和信息。此外，活动事件优先级高于已解决的优先级。
properties.reason	string	事件的原因
properties.recommendedActions	RecommendedActions	建议的事件作。
properties.status	EventStatusValues	事件的当前状态。
properties.summary	string	事件的摘要文本。
properties.title	string	事件的标题文本。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

EventLevelValues

枚举

事件级别。

值	说明
Critical
Error
Informational
Warning

events

Object

List 事件作响应。

名称	类型	说明
nextLink	string	用于提取下一页事件的 URI。使用此 URI 调用 ListNext（），以提取下一页的事件。
value	event[]	事件列表。

EventSourceValues

枚举

事件源。

值	说明
ResourceHealth
ServiceHealth

EventStatusValues

枚举

事件的当前状态。

值	说明
Active
Resolved

EventTypeValues

枚举

事件类型。

值	说明
EmergingIssues
HealthAdvisory
PlannedMaintenance
RCA
SecurityAdvisory
ServiceIssue

faq

Object

服务运行状况事件的常见问题解答

名称	类型	说明
answer	string	服务运行状况事件的常见问题解答解答。
localeCode	string	服务运行状况事件的常见问题解答区域设置。
question	string	有关服务运行状况事件的常见问题解答。

impact

Object

受服务运行状况事件影响的 Azure 服务。

名称	类型	说明
impactedRegions	impactedServiceRegion[]	列出受服务运行状况事件影响的区域。
impactedService	string	受影响的服务名称。
impactedServiceGuid	string	受影响的服务 guid。这是受影响服务的永久标识符。

impactedServiceRegion

Object

受服务运行状况事件影响的 Azure 区域。

名称	类型	说明
impactedRegion	string	受影响的区域名称。
impactedSubscriptions	string[]	列出受服务运行状况事件影响的订阅。
impactedTenants	string[]	列出受服务运行状况事件影响的租户。
lastUpdateTime	string (date-time)	它提供服务运行状况事件上次更新时的时间戳。
status	EventStatusValues	区域中事件的当前状态。
updates	update[]	给定服务运行状况事件的更新列表。

LevelValues

枚举

见解级别。

值	说明
Critical
Warning

link

Object

服务运行状况事件的有用链接。

名称	类型	说明
bladeName	string	它提供门户扩展边栏选项卡的名称，以生成给定服务运行状况事件的链接。
displayText	DisplayText	显示链接的文本。
extensionName	string	它提供门户扩展的名称，以生成给定服务运行状况事件的链接。
parameters	object	它提供门户扩展边栏选项卡的参数名称和值的映射，以生成给定服务运行状况事件的利口。
type	LinkTypeValues	链接的类型。

LinkTypeValues

枚举

链接的类型。

值	说明
Button
Hyperlink

RecommendedActions

Object

建议的事件作。

名称	类型	说明
actions	Actions[]	针对服务运行状况事件的建议作。
localeCode	string	针对服务运行状况事件的建议作区域设置。
message	string	服务运行状况事件的建议作标题。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

update

Object

服务运行状况事件的更新。

名称	类型	说明
summary	string	服务运行状况事件的给定更新的摘要文本。
updateDateTime	string (date-time)	它为服务运行状况事件的给定更新提供时间戳。

通过

Events - List By Subscription Id

URI 参数

响应

安全性

azure_auth

作用域

示例

ListEventsBySubscriptionId

示例请求

示例响应

定义

Actions

AdditionalInformation

Article

createdByType

DisplayText

ErrorResponse

event

EventLevelValues

events

EventSourceValues

EventStatusValues

EventTypeValues

faq

impact

impactedServiceRegion

LevelValues

link

LinkTypeValues

RecommendedActions

systemData

update

其他资源