你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Events - List By Single Resource
Lists给定资源的当前服务运行状况事件。
GET https://management.azure.com/{resourceUri}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01&$filter={$filter}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源的完全限定 ID,包括资源名称和资源类型。 目前,API 不支持嵌套和一种嵌套级别资源类型:/subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}/和 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
$filter
|
query |
string |
要应用于操作的筛选器。 有关详细信息,请参阅 https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
给定资源的当前服务运行状况事件列表 |
|
Other Status Codes |
DefaultErrorResponse |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
ListEventsBySingleResource
示例请求
GET https://management.azure.com/subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.Compute/virtualMachines/rhctestenvV1PI/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01
示例响应
{
"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}"
],
"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": "active"
}
}
],
"nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}"
}
定义
名称 | 说明 |
---|---|
Actions |
针对服务运行状况事件的建议操作。 |
Additional |
其他信息 |
Article |
事件项目。 |
created |
创建资源的标识类型。 |
Display |
显示链接的文本。 |
Error |
错误详细信息。 |
event |
服务运行状况 事件 |
Event |
事件级别。 |
events |
列出事件操作响应。 |
Event |
事件的源。 |
Event |
事件的当前状态。 |
Event |
事件类型。 |
faq |
服务运行状况事件的常见问题 |
impact |
受服务运行状况事件影响的 Azure 服务。 |
impacted |
受服务运行状况事件影响的 Azure 区域。 |
Level |
见解级别。 |
link |
服务运行状况事件的有用链接。 |
Link |
链接的类型。 |
Recommended |
事件的建议操作。 |
system |
与资源的创建和上次修改相关的元数据。 |
update |
服务运行状况事件的更新。 |
Actions
针对服务运行状况事件的建议操作。
名称 | 类型 | 说明 |
---|---|---|
actionText |
string |
建议的操作文本 |
groupId |
integer |
服务运行状况事件的建议操作组 ID。 |
AdditionalInformation
其他信息
名称 | 类型 | 说明 |
---|---|---|
message |
string |
其他信息 消息 |
Article
事件项目。
名称 | 类型 | 说明 |
---|---|---|
articleContent |
string |
事件的文章内容。 |
articleId |
string |
文章 ID |
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 |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties.additionalInformation |
其他信息 |
|
properties.article |
事件项目。 |
|
properties.description |
string |
包含事件的通信消息,其中可能包括摘要、根本原因和其他详细信息。 |
properties.duration |
integer |
持续时间(秒) |
properties.enableChatWithUs |
boolean |
告知我们是要为此事件启用或禁用Microsoft 支持部门。 |
properties.enableMicrosoftSupport |
boolean |
告知我们是要为此事件启用或禁用Microsoft 支持部门。 |
properties.eventLevel |
事件级别。 |
|
properties.eventSource |
事件的源。 |
|
properties.eventType |
事件类型。 |
|
properties.externalIncidentId |
string |
事件的 ID |
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 |
见解级别。 |
|
properties.links |
link[] |
事件的有用链接。 |
properties.platformInitiated |
boolean |
如果事件是平台启动的,则为 true。 |
properties.priority |
integer |
事件的优先级。 值为 0 到 23。 0 是最高优先级。 服务问题事件具有更高的优先级,然后是计划内维护和运行状况公告。 关键事件的优先级更高,后跟错误、警告和信息性。 此外,活动事件的优先级高于已解决的优先级。 |
properties.reason |
string |
事件的原因 |
properties.recommendedActions |
事件的建议操作。 |
|
properties.status |
事件的当前状态。 |
|
properties.summary |
string |
事件的摘要文本。 |
properties.title |
string |
事件的标题文本。 |
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
EventLevelValues
事件级别。
名称 | 类型 | 说明 |
---|---|---|
Critical |
string |
|
Error |
string |
|
Informational |
string |
|
Warning |
string |
events
列出事件操作响应。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
要提取下一页事件的 URI。 使用此 URI 调用 ListNext () 以获取下一页事件。 |
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 |
列出受服务运行状况事件影响的区域。 |
|
impactedService |
string |
受影响的服务名称。 |
impactedServiceGuid |
string |
受影响的服务 guid。 这是受影响服务的永久标识符。 |
impactedServiceRegion
受服务运行状况事件影响的 Azure 区域。
名称 | 类型 | 说明 |
---|---|---|
impactedRegion |
string |
受影响的区域名称。 |
impactedSubscriptions |
string[] |
列出受服务运行状况事件影响的订阅。 |
impactedTenants |
string[] |
列出受服务运行状况事件影响的租户。 |
lastUpdateTime |
string |
它提供服务运行状况事件上次更新的时间戳。 |
status |
区域中事件的当前状态。 |
|
updates |
update[] |
给定服务运行状况事件的更新列表。 |
LevelValues
见解级别。
名称 | 类型 | 说明 |
---|---|---|
Critical |
string |
|
Warning |
string |
link
服务运行状况事件的有用链接。
名称 | 类型 | 说明 |
---|---|---|
bladeName |
string |
它提供门户扩展边栏选项卡的名称,以生成给定服务运行状况事件的链接。 |
displayText |
显示链接的文本。 |
|
extensionName |
string |
它提供门户扩展的名称,用于生成给定服务运行状况事件的链接。 |
parameters |
object |
它为门户扩展边栏选项卡提供参数名称和值的映射,以便为给定的服务运行状况事件生成 lik。 |
type |
链接的类型。 |
LinkTypeValues
链接的类型。
名称 | 类型 | 说明 |
---|---|---|
Button |
string |
|
Hyperlink |
string |
RecommendedActions
事件的建议操作。
名称 | 类型 | 说明 |
---|---|---|
actions |
Actions[] |
针对服务运行状况事件的建议操作。 |
localeCode |
string |
服务运行状况事件的建议操作区域设置。 |
message |
string |
服务运行状况事件的建议操作标题。 |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源的创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |
update
服务运行状况事件的更新。
名称 | 类型 | 说明 |
---|---|---|
summary |
string |
服务运行状况事件的给定更新的摘要文本。 |
updateDateTime |
string |
它为服务运行状况事件的给定更新提供时间戳。 |