Events - List By Single Resource

參考

Service:: Resource Health

API Version:: 2024-02-01

清單指定資源的目前服務健康情況事件。

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

With optional parameters:

GET https://management.azure.com/{resourceUri}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01&$filter={$filter}

URI 參數

名稱	位於	必要	類型	Description
resourceUri	path	True	string	資源的完整標識碼，包括資源名稱和資源類型。目前 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

回應

名稱	類型	Description
200 OK	events	指定資源的目前服務健康情況事件清單
Other Status Codes	ErrorResponse	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ListEventsBySingleResource

Sample Request

HTTP

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

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}"
                ],
                "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}"
}

定義

名稱	Description
Actions	服務健康情況事件的建議動作。
AdditionalInformation	其他資訊
Article	事件文章。
createdByType	建立資源的身分識別類型。
DisplayText	顯示連結的文字。
ErrorResponse	錯誤詳細數據。
event	服務健康情況事件
EventLevelValues	事件層級。
events	列出事件作業回應。
EventSourceValues	事件來源。
EventStatusValues	事件的目前狀態。
EventTypeValues	事件類別。
faq	服務健康情況事件的常見問題
impact	受服務健康情況事件影響的 Azure 服務。
impactedServiceRegion	受服務健康情況事件影響的 Azure 區域。
LevelValues	深入解析層級。
link	服務健康情況事件的實用連結。
LinkTypeValues	連結的類型。
RecommendedActions	事件的建議動作。
systemData	與建立和上次修改資源相關的元數據。
update	更新服務健康情況事件。

Actions

服務健康情況事件的建議動作。

名稱	類型	Description
actionText	string	建議的動作文字
groupId	integer	服務健康情況事件的建議動作群組標識符。

AdditionalInformation

其他資訊

名稱	類型	Description
message	string	其他資訊訊息

Article

事件文章。

名稱	類型	Description
articleContent	string	事件的文章內容。
articleId	string	發行項標識碼
parameters	object	它提供參數名稱和值的對應

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DisplayText

顯示連結的文字。

名稱	類型	Description
localizedValue	string	連結的當地語系化顯示文字。
value	string	顯示連結的文字。

ErrorResponse

錯誤詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	string	錯誤詳細資料。
message	string	錯誤訊息。

event

服務健康情況事件

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /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	告知我們是否要啟用或停用此事件的 Microsoft 支援服務。
properties.enableMicrosoftSupport	boolean	告知我們是否要啟用或停用此事件的 Microsoft 支援服務。
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

事件層級。

名稱	類型	Description
Critical	string
Error	string
Informational	string
Warning	string

events

列出事件作業回應。

名稱	類型	Description
nextLink	string	要擷取下一頁事件的 URI。使用此 URI 呼叫 ListNext () ，以擷取下一頁的事件。
value	event[]	事件清單。

EventSourceValues

事件來源。

名稱	類型	Description
ResourceHealth	string
ServiceHealth	string

EventStatusValues

事件的目前狀態。

名稱	類型	Description
Active	string
Resolved	string

EventTypeValues

事件類別。

名稱	類型	Description
EmergingIssues	string
HealthAdvisory	string
PlannedMaintenance	string
RCA	string
SecurityAdvisory	string
ServiceIssue	string

faq

服務健康情況事件的常見問題

名稱	類型	Description
answer	string	服務健康情況事件的常見問題解答。
localeCode	string	服務健康情況事件的常見問題地區設定。
question	string	服務健康情況事件的常見問題。

impact

受服務健康情況事件影響的 Azure 服務。

名稱	類型	Description
impactedRegions	impactedServiceRegion[]	列出受服務健康情況事件影響的區域。
impactedService	string	受影響的服務名稱。
impactedServiceGuid	string	受影響的服務 GUID。這是受影響服務的永久標識碼。

impactedServiceRegion

受服務健康情況事件影響的 Azure 區域。

名稱	類型	Description
impactedRegion	string	受影響的區域名稱。
impactedSubscriptions	string[]	列出受服務健康情況事件影響的訂用帳戶。
impactedTenants	string[]	列出受服務健康情況事件影響的租使用者。
lastUpdateTime	string	它會提供服務健康狀態事件上次更新時的時間戳。
status	EventStatusValues	區域中事件的目前狀態。
updates	update[]	指定服務健康情況事件的更新清單。

LevelValues

深入解析層級。

名稱	類型	Description
Critical	string
Warning	string

link

服務健康情況事件的實用連結。

名稱	類型	Description
bladeName	string	它會提供入口網站擴充功能刀鋒視窗的名稱，以產生給定服務健康情況事件的連結。
displayText	DisplayText	顯示連結的文字。
extensionName	string	它提供入口網站延伸模組的名稱，以產生給定服務健康情況事件的連結。
parameters	object	它會提供入口網站延伸模組刀鋒視窗的參數名稱和值的對應，以產生指定服務健康情況事件的 Lik。
type	LinkTypeValues	連結的類型。

LinkTypeValues

連結的類型。

名稱	類型	Description
Button	string
Hyperlink	string

RecommendedActions

事件的建議動作。

名稱	類型	Description
actions	Actions[]	服務健康情況事件的建議動作。
localeCode	string	服務健康情況事件的建議動作地區設定。
message	string	服務健康狀態事件的建議動作標題。

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

update

更新服務健康情況事件。

名稱	類型	Description
summary	string	服務健康情況事件指定更新的摘要文字。
updateDateTime	string	它會為服務健康情況事件提供指定更新的時間戳。