Availability Statuses - List By Subscription Id

Lists the current availability status for all the resources in the subscription.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

$expand
query

string

Setting $expand=recommendedactions in url query expands the recommendedactions in the response.

$filter
query

string

The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Responses

Name Type Description
200 OK

availabilityStatusListResult

The list of current availability status for all the resources in the subscription

Other Status Codes

ErrorResponse

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ListHealthBySubscriptionId

Sample request

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

Sample response

{
  "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}"
}

Definitions

Name Description
AvailabilityStateValues

Impacted resource status of the resource.

availabilityStatus

availabilityStatus of a resource.

availabilityStatusListResult

The List availabilityStatus operation response.

ErrorResponse

Error details.

IncidentProperties

Properties of the service impacting event.

Properties

Properties of availability state.

reasonChronicityTypes

Chronicity of the availability transition.

RecentlyResolved

An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned

recommendedAction

Lists actions the user can take based on the current availabilityState of the resource.

serviceImpactingEvent

Lists the service impacting events that may be affecting the health of the resource.

Status

Status of the service impacting event.

AvailabilityStateValues

Impacted resource status of the resource.

Name Type Description
Available

string

Degraded

string

Unavailable

string

Unknown

string

availabilityStatus

availabilityStatus of a resource.

Name Type Description
id

string

Azure Resource Manager Identity for the availabilityStatuses resource.

location

string

Azure Resource Manager geo location of the resource.

name

string

current.

properties

Properties

Properties of availability state.

type

string

Microsoft.ResourceHealth/AvailabilityStatuses.

availabilityStatusListResult

The List availabilityStatus operation response.

Name Type Description
nextLink

string

The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses.

value

availabilityStatus[]

The list of availabilityStatuses.

ErrorResponse

Error details.

Name Type Description
code

string

The error code.

details

string

The error details.

message

string

The error message.

IncidentProperties

Properties of the service impacting event.

Name Type Description
incidentType

string

Type of Event.

region

string

Region impacted by the event.

service

string

Service impacted by the event.

title

string

Title of the incident.

Properties

Properties of availability state.

Name Type Description
articleId

string

The Article Id

availabilityState

AvailabilityStateValues

Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event

category

string

When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored.

context

string

When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object.

detailedStatus

string

Details of the availability status.

healthEventCategory

string

In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc.

healthEventCause

string

In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc.

healthEventId

string

It is a unique Id that identifies the event

healthEventType

string

In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc.

occuredTime

string

Timestamp for when last change in health status occurred.

reasonChronicity

reasonChronicityTypes

Chronicity of the availability transition.

reasonType

string

When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc.

recentlyResolved

RecentlyResolved

An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned

recommendedActions

recommendedAction[]

Lists actions the user can take based on the current availabilityState of the resource.

reportedTime

string

Timestamp for when the health was last checked.

resolutionETA

string

When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.

rootCauseAttributionTime

string

When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.

serviceImpactingEvents

serviceImpactingEvent[]

Lists the service impacting events that may be affecting the health of the resource.

summary

string

Summary description of the availability status.

title

string

Title description of the availability status.

reasonChronicityTypes

Chronicity of the availability transition.

Name Type Description
Persistent

string

Transient

string

RecentlyResolved

An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned

Name Type Description
resolvedTime

string

Timestamp when the availabilityState changes to Available.

unavailableOccuredTime

string

Timestamp for when the availabilityState changed to Unavailable

unavailableSummary

string

Brief description of cause of the resource becoming unavailable.

recommendedAction

Lists actions the user can take based on the current availabilityState of the resource.

Name Type Description
_ActionUrl.Comment

string

the comment for the Action

action

string

Recommended action.

actionUrl

string

Link to the action

actionUrlText

string

Substring of action, it describes which text should host the action URL.

serviceImpactingEvent

Lists the service impacting events that may be affecting the health of the resource.

Name Type Description
correlationId

string

Correlation id for the event

eventStartTime

string

Timestamp for when the event started.

eventStatusLastModifiedTime

string

Timestamp for when event was submitted/detected.

incidentProperties

IncidentProperties

Properties of the service impacting event.

status

Status

Status of the service impacting event.

Status

Status of the service impacting event.

Name Type Description
value

string

Current status of the event