Availability Statuses - Get By Resource

リファレンス

サービス:: Resource Health

API バージョン:: 2024-02-01

1 つのリソースの現在の可用性状態を取得します

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 パラメーター

名前	/	必須	型	説明
resourceUri	path	True	string	リソース名とリソースの種類を含む、リソースの完全修飾 ID。現在、API は入れ子ではなく、1 つの入れ子レベルのリソースの種類をサポートしています: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name } and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$expand	query		string	url クエリで $expand=recommendedactions を設定すると、応答の recommendedactions が展開されます。
$filter	query		string	操作に適用するフィルター。詳細については、https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN を参照してください。

応答

名前	型	説明
200 OK	availabilityStatus	1 つのリソースの現在の可用性の状態
Other Status Codes	ErrorResponse	DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
      }
    ]
  }
}

定義

名前	説明
AvailabilityStateValues	リソースの影響を受けたリソースの状態。
availabilityStatus	リソースの availabilityStatus。
ErrorResponse	エラーの詳細。
IncidentProperties	サービスに影響を与えるイベントのプロパティ。
Properties	可用性状態のプロパティ。
reasonChronicityTypes	可用性遷移の慢性性。
RecentlyResolved	availabilityState から Available from Unavailable への変更を説明する注釈。reasonType 型は Unplanned
recommendedAction	リソースの現在の availabilityState に基づいてユーザーが実行できるアクションを一覧表示します。
serviceImpactingEvent	リソースの正常性に影響を与える可能性があるイベントに影響を与えるサービスを一覧表示します。
Status	サービスに影響を与えるイベントの状態。

AvailabilityStateValues

列挙

リソースの影響を受けたリソースの状態。

値	説明
Available
Degraded
Unavailable
Unknown

availabilityStatus

Object

リソースの availabilityStatus。

名前	型	説明
id	string	availabilityStatuses リソースの Azure Resource Manager ID。
location	string	リソースの Azure Resource Manager の地理的な場所。
name	string	現在の。
properties	Properties	可用性状態のプロパティ。
type	string	Microsoft.ResourceHealth/AvailabilityStatuses。

ErrorResponse

Object

エラーの詳細。

名前	型	説明
code	string	エラーコード。
details	string	エラーの詳細。
message	string	エラーメッセージ。

IncidentProperties

Object

サービスに影響を与えるイベントのプロパティ。

名前	型	説明
incidentType	string	イベントの種類。
region	string	イベントの影響を受けたリージョン。
service	string	イベントの影響を受けたサービス。
title	string	インシデントのタイトル。

Properties

Object

可用性状態のプロパティ。

名前	型	説明
articleId	string	アーティクル ID
availabilityState	AvailabilityStateValues	リソースの可用性の状態。 null の場合、この availabilityStatus オブジェクトは可用性に影響を与えるイベントを表します
category	string	コンテキストフィールドが [プラットフォーム] に設定されている場合、このフィールドには、イベントが計画されたか計画されていないかが反映されます。コンテキストフィールドの値が Platform でない場合、このフィールドは無視されます。
context	string	イベントが作成されると、顧客またはリソースのプラットフォームによってイベントをトリガーすることができ、このフィールドはそれを示します。このフィールドは、このオブジェクトのカテゴリフィールドに接続されています。
detailedStatus	string	可用性の状態の詳細。
healthEventCategory	string	可用性に影響を与えるイベントの場合は、PlatformInitiated 正常性に影響を与えるイベントのカテゴリが記述されます。たとえば、計画済み、計画外などです。
healthEventCause	string	可用性に影響を与えるイベントの場合は、正常性に影響を与えるイベントが発生した場所について説明します。例として、PlatformInitiated、UserInitiated などがあります。
healthEventId	string	イベントを識別する一意の ID です
healthEventType	string	可用性に影響を与えるイベントの場合、正常性に影響を与えるイベントが発生したタイミングが記述されます。たとえば、ライフサイクル、ダウンタイム、障害分析などです。
occuredTime	string (date-time)	正常性状態の最後の変更が発生したときのタイムスタンプ。
reasonChronicity	reasonChronicityTypes	可用性遷移の慢性性。
reasonType	string	リソースの availabilityState が使用不可の場合、正常性に影響を与えるイベントが発生した場所が記述されます。たとえば、計画済み、計画外、ユーザーによる開始、停止などがあります。
recentlyResolved	RecentlyResolved	availabilityState から Available from Unavailable への変更を説明する注釈。reasonType 型は Unplanned
recommendedActions	recommendedAction[]	リソースの現在の availabilityState に基づいてユーザーが実行できるアクションを一覧表示します。
reportedTime	string (date-time)	正常性が最後にチェックされた日時のタイムスタンプ。
resolutionETA	string (date-time)	リソースの availabilityState が使用不可で、reasonType がユーザー開始ではない場合、問題が解決されると予想される日時が提供されます。
rootCauseAttributionTime	string (date-time)	リソースの availabilityState が使用不可の場合、正常性に影響を与えるイベントがいつ受信されたかのタイムスタンプが提供されます。
serviceImpactingEvents	serviceImpactingEvent[]	リソースの正常性に影響を与える可能性があるイベントに影響を与えるサービスを一覧表示します。
summary	string	可用性の状態の概要の説明。
title	string	可用性の状態のタイトルの説明。

reasonChronicityTypes

列挙

可用性遷移の慢性性。

値	説明
Persistent
Transient

RecentlyResolved

Object

availabilityState から Available from Unavailable への変更を説明する注釈。reasonType 型は Unplanned

名前	型	説明
resolvedTime	string (date-time)	availabilityState が Available に変更されたときのタイムスタンプ。
unavailableOccuredTime	string (date-time)	availabilityState が Unavailable に変更されたときのタイムスタンプ
unavailableSummary	string	リソースが使用できなくなった原因の簡単な説明。

recommendedAction

Object

リソースの現在の availabilityState に基づいてユーザーが実行できるアクションを一覧表示します。

名前	型	説明
_ActionUrl.Comment	string	アクションのコメント
action	string	推奨されるアクション。
actionUrl	string	アクションへのリンク
actionUrlText	string	アクションの部分文字列。アクション URL をホストするテキストを記述します。

serviceImpactingEvent

Object

リソースの正常性に影響を与える可能性があるイベントに影響を与えるサービスを一覧表示します。

名前	型	説明
correlationId	string	イベントの関連付け ID
eventStartTime	string (date-time)	イベントが開始されたときのタイムスタンプ。
eventStatusLastModifiedTime	string (date-time)	イベントが送信/検出された日時のタイムスタンプ。
incidentProperties	IncidentProperties	サービスに影響を与えるイベントのプロパティ。
status	Status	サービスに影響を与えるイベントの状態。

Status

Object

サービスに影響を与えるイベントの状態。

名前	型	説明
value	string	イベントの現在の状態

次の方法で共有

Availability Statuses - Get By Resource

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

GetCurrentHealthByResource

要求のサンプル

応答のサンプル

定義

AvailabilityStateValues

availabilityStatus

ErrorResponse

IncidentProperties

Properties

reasonChronicityTypes

RecentlyResolved

recommendedAction

serviceImpactingEvent

Status

その他のリソース