Availability Statuses - List By Subscription Id

リファレンス

Service:: Resource Health

API Version:: 2024-02-01

サブスクリプション内のすべてのリソースの現在の可用性状態をListsします。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
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

応答

名前	型	説明
200 OK	availabilityStatusListResult	サブスクリプション内のすべてのリソースの現在の可用性状態の一覧
Other Status Codes	ErrorResponse	DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ListHealthBySubscriptionId

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "<resourceId>/providers/Microsoft.ResourceHealth/AvailabilityStatueses/current",
      "name": "current",
      "type": "Microsoft.ResourceHealth/AvailabilityStatuses",
      "location": "eastus",
      "properties": {
        "availabilityState": "Available",
        "title": "Available",
        "summary": "Vm is available",
        "reasonType": "Unplanned",
        "reasonChronicity": "Persistent",
        "context": "Platform Initiated",
        "category": "Unplanned",
        "detailedStatus": "We have not seen any issues with your virtual machine",
        "occuredTime": "2016-03-29T09:12:00Z",
        "reportedTime": "2016-05-04T14:11:29.7598931Z",
        "recentlyResolved": {
          "unavailableOccuredTime": "2017-02-28T00:48:00Z",
          "resolvedTime": "2017-02-28T00:49:00Z",
          "unavailableSummary": "We are sorry your SQL database is unavailable"
        },
        "recommendedActions": [
          {
            "action": "To start this virtualmachine, open the resource blade and click Start",
            "actionUrl": "<#ResourceBlade>",
            "actionUrlText": "resourceblade"
          }
        ]
      }
    },
    {
      "id": "<resourceId>/providers/Microsoft.ResourceHealth/AvailabilityStatueses/current",
      "name": "current",
      "type": "Microsoft.ResourceHealth/AvailabilityStatuses",
      "location": "eastus",
      "properties": {
        "availabilityState": "Unavailable",
        "title": "Unavailable",
        "summary": "We are sorry, we couldn't automatically recovery our virtualmachine",
        "reasonType": "Unplanned",
        "reasonChronicity": "Persistent",
        "detailedStatus": "Diskproblemsarepreventingusfromautomaticallyrecoveringyourvirtualmachine",
        "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 virtualmachine, open the resource blade",
            "actionUrl": "<#ResourceBlade>",
            "actionUrlText": "resourceblade"
          },
          {
            "action": "If you are experiencing problems you believe are caused by Azure, contact support",
            "actionUrl": "<#SupportCase>",
            "actionUrlText": "contactsupport"
          }
        ]
      }
    }
  ],
  "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}"
}

定義

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

AvailabilityStateValues

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

名前	型	説明
Available	string
Degraded	string
Unavailable	string
Unknown	string

availabilityStatus

リソースの availabilityStatus。

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

availabilityStatusListResult

List availabilityStatus 操作の応答。

名前	型	説明
nextLink	string	availabilityStatuses の次のページをフェッチする URI。この URI で ListNext() を呼び出して、availabilityStatuses の次のページをフェッチします。
value	availabilityStatus[]	availabilityStatuses の一覧。

ErrorResponse

エラーの詳細。

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

IncidentProperties

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

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

Properties

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

名前	型	説明
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	正常性状態の最後の変更が発生したときのタイムスタンプ。
reasonChronicity	reasonChronicityTypes	可用性遷移の慢性。
reasonType	string	リソースの availabilityState が [使用不可] の場合、正常性に影響を与えるイベントが発生した場所が記述されます。たとえば、計画、計画外、ユーザーの開始、停止などがあります。
recentlyResolved	RecentlyResolved	availabilityState から Available from Unavailable への変更を説明する注釈。reasonType 型は計画外です
recommendedActions	recommendedAction[]	ユーザーがリソースの現在の availabilityState に基づいて実行できるアクションをListsします。
reportedTime	string	正常性が最後にチェックされた日時のタイムスタンプ。
resolutionETA	string	リソースの availabilityState が [使用不可] で reasonType が [ユーザー開始] でない場合、問題が解決されると予想される日時が提供されます。
rootCauseAttributionTime	string	リソースの availabilityState が [使用不可] の場合、正常性に影響を与えるイベントが受信されたときのタイムスタンプが提供されます。
serviceImpactingEvents	serviceImpactingEvent[]	リソースの正常性に影響を与える可能性があるイベントに影響を与えるサービスをListsします。
summary	string	可用性の状態の概要の説明。
title	string	可用性の状態のタイトルの説明。

reasonChronicityTypes

可用性遷移の慢性。

名前	型	説明
Persistent	string
Transient	string

RecentlyResolved

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

名前	型	説明
resolvedTime	string	availabilityState が [利用可能] に変更されたときのタイムスタンプ。
unavailableOccuredTime	string	availabilityState が [使用不可] に変更されたときのタイムスタンプ
unavailableSummary	string	リソースが使用できなくなる原因の簡単な説明。

recommendedAction

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

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

serviceImpactingEvent

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

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

Status

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

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