Availability Statuses - Get By Resource

參考

服務:: Resource Health

API 版本:: 2024-02-01

取得單一資源的目前可用性狀態

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

含選擇性參數:

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

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 版本。
$expand	query		string	在 URL 查詢中設定 $expand=recommendedactions 會展開回應中的建議動作。
$filter	query		string	要套用至作業的篩選。如需詳細資訊，請參閱 https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

回應

名稱	類型	Description
200 OK	availabilityStatus	單一資源的目前可用性狀態
Other Status Codes	ErrorResponse	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

GetCurrentHealthByResource

範例要求

HTTP

GET https://management.azure.com/resourceUri/providers/Microsoft.ResourceHealth/availabilityStatuses/current?api-version=2024-02-01&$expand=recommendedactions

範例回覆

狀態碼:: 200

{
  "id": "/subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.ClassicCompute/virtualMachines /rhctestenvV1PI/providers/Microsoft.ResourceHealth/availabilityStatuses/current",
  "name": "current",
  "type": "Microsoft.ResourceHealth/AvailabilityStatuses",
  "location": "eastus",
  "properties": {
    "availabilityState": "Unavailable",
    "title": "Unavailable",
    "summary": "We're sorry, we couldn't automatically recover your virtual machine",
    "reasonType": "Unplanned",
    "context": "Platform Initiated",
    "category": "Unplanned",
    "reasonChronicity": "Persistent",
    "detailedStatus": "Disk problems are preventing us from automatically recovering your virtual machine",
    "occuredTime": "2016-03-29T09:12:00Z",
    "reportedTime": "2016-05-04T14:11:29.7598931Z",
    "rootCauseAttributionTime": "2016-03-29T09:13:00Z",
    "resolutionETA": "2016-03-29T09:37:00Z",
    "recommendedActions": [
      {
        "action": "To start this virtual machine, open the resource blade and click Start",
        "actionUrl": "<#ResourceBlade>",
        "actionUrlText": "resource blade"
      },
      {
        "action": "If you are experiencing problems you believe are caused by Azure, contact support",
        "actionUrl": "<#SupportCase>",
        "actionUrlText": "contact support"
      }
    ]
  }
}

定義

名稱	Description
AvailabilityStateValues	受影響的資源狀態。
availabilityStatus	資源的 availabilityStatus。
ErrorResponse	錯誤詳細數據。
IncidentProperties	服務影響事件的屬性。
Properties	可用性狀態的屬性。
reasonChronicityTypes	可用性轉換的持續性。
RecentlyResolved	描述 availabilityState 變更為 [無法使用] 的批注，其類型為 Unplanned
recommendedAction	清單使用者可以根據資源的目前 availabilityState 採取動作。
serviceImpactingEvent	清單影響可能會影響資源健康情況的事件的服務。
Status	服務影響事件的狀態。

AvailabilityStateValues

受影響的資源狀態。

名稱	類型	Description
Available	string
Degraded	string
Unavailable	string
Unknown	string

availabilityStatus

資源的 availabilityStatus。

名稱	類型	Description
id	string	availabilityStatuses 資源的 Azure Resource Manager 身分識別。
location	string	Azure Resource Manager 資源的地理位置。
name	string	當前。
properties	Properties	可用性狀態的屬性。
type	string	Microsoft.ResourceHealth/AvailabilityStatuses。

ErrorResponse

錯誤詳細數據。

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

IncidentProperties

服務影響事件的屬性。

名稱	類型	Description
incidentType	string	事件類型。
region	string	受事件影響的區域。
service	string	受事件影響的服務。
title	string	事件的標題。

Properties

可用性狀態的屬性。

名稱	類型	Description
articleId	string	發行項標識碼
availabilityState	AvailabilityStateValues	資源的可用性狀態。當它是 Null 時，這個 availabilityStatus 物件代表可用性影響事件
category	string	當內容欄位設定為 [平臺] 時，此欄位會反映是否已規劃或非計劃性事件。如果內容欄位沒有 Platform 的值，則會忽略此欄位。
context	string	建立事件時，可由客戶或資源的平臺觸發，而此字段將說明。此欄位會連線到此物件中的類別欄位。
detailedStatus	string	可用性狀態的詳細數據。
healthEventCategory	string	如果是可用性影響事件，它會描述 PlatformInitiated 健康情況影響事件的類別。範例包括計劃性、非計劃性等。
healthEventCause	string	如果是可用性影響事件，它會描述健康情況影響事件的來源。範例包括 PlatformInitiated、UserInitiated 等。
healthEventId	string	這是識別事件的唯一標識碼
healthEventType	string	如果是可用性影響事件，它會描述何時產生健康情況影響事件。範例包括生命週期、停機時間、錯誤分析等。
occuredTime	string	上次發生健康狀態變更的時間戳。
reasonChronicity	reasonChronicityTypes	可用性轉換的持續性。
reasonType	string	當資源的 availabilityState 無法使用時，它會描述健康情況影響事件的來源。範例包括計劃性、非計劃性、使用者起始或中斷等。
recentlyResolved	RecentlyResolved	描述 availabilityState 變更為 [無法使用] 的批注，其類型為 Unplanned
recommendedActions	recommendedAction[]	清單使用者可以根據資源的目前 availabilityState 採取動作。
reportedTime	string	上次檢查健康情況的時間戳。
resolutionETA	string	當資源的 availabilityState 無法使用且 reasonType 不是使用者起始時，它會提供預期解決問題的日期和時間。
rootCauseAttributionTime	string	當資源的 availabilityState 無法使用時，它會提供收到健康情況影響事件時的時間戳。
serviceImpactingEvents	serviceImpactingEvent[]	清單影響可能會影響資源健康情況的事件的服務。
summary	string	可用性狀態的摘要描述。
title	string	可用性狀態的標題描述。

reasonChronicityTypes

可用性轉換的持續性。

名稱	類型	Description
Persistent	string
Transient	string

RecentlyResolved

描述 availabilityState 變更為 [無法使用] 的批注，其類型為 Unplanned

名稱	類型	Description
resolvedTime	string	availabilityState 變更為 [可用] 時的時間戳。
unavailableOccuredTime	string	availabilityState 變更為 [無法使用] 的時間戳
unavailableSummary	string	資源變得無法使用之原因的簡短描述。

recommendedAction

清單使用者可以根據資源的目前 availabilityState 採取動作。

名稱	類型	Description
_ActionUrl.Comment	string	動作的批注
action	string	建議的動作。
actionUrl	string	動作的連結
actionUrlText	string	動作的子字串會描述哪些文字應該裝載動作 URL。

serviceImpactingEvent

清單影響可能會影響資源健康情況的事件的服務。

名稱	類型	Description
correlationId	string	事件的相互關聯標識碼
eventStartTime	string	事件啟動時的時間戳。
eventStatusLastModifiedTime	string	已提交/偵測到事件的時間戳。
incidentProperties	IncidentProperties	服務影響事件的屬性。
status	Status	服務影響事件的狀態。

Status

服務影響事件的狀態。

名稱	類型	Description
value	string	事件的目前狀態

共用方式為