availability_statuses

Creates, updates, deletes, gets or lists an availability_statuses resource.

Overview

Name	availability_statuses
Type	Resource
Id	azure.resource_health.availability_statuses

Fields

The following fields are returned by SELECT queries:

list_by_resource_group

Name	Datatype	Description
id	string	Azure Resource Manager Identity for the availabilityStatuses resource.
name	string	:vartype name: str
articleId	string	The Article Id.
availabilityState	string	Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event. Known values are: "Available", "Unavailable", "Degraded", and "Unknown". (Available, Unavailable, Degraded, Unknown)
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.
location	string	Azure Resource Manager geo location of the resource.
occuredTime	string (date-time)	Timestamp for when last change in health status occurred.
reasonChronicity	string	Chronicity of the availability transition. Known values are: "Transient" and "Persistent". (Transient, Persistent)
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	object	An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned.
recommendedActions	array	Lists actions the user can take based on the current availabilityState of the resource.
reportedTime	string (date-time)	Timestamp for when the health was last checked.
resolutionETA	string (date-time)	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 (date-time)	When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.
serviceImpactingEvents	array	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.
type	string	Microsoft.ResourceHealth/AvailabilityStatuses.

list

Name	Datatype	Description
id	string	Azure Resource Manager Identity for the availabilityStatuses resource.
name	string	:vartype name: str
articleId	string	The Article Id.
availabilityState	string	Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event. Known values are: "Available", "Unavailable", "Degraded", and "Unknown". (Available, Unavailable, Degraded, Unknown)
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.
location	string	Azure Resource Manager geo location of the resource.
occuredTime	string (date-time)	Timestamp for when last change in health status occurred.
reasonChronicity	string	Chronicity of the availability transition. Known values are: "Transient" and "Persistent". (Transient, Persistent)
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	object	An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned.
recommendedActions	array	Lists actions the user can take based on the current availabilityState of the resource.
reportedTime	string (date-time)	Timestamp for when the health was last checked.
resolutionETA	string (date-time)	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 (date-time)	When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.
serviceImpactingEvents	array	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.
type	string	Microsoft.ResourceHealth/AvailabilityStatuses.

list_by_subscription_id

Name	Datatype	Description
id	string	Azure Resource Manager Identity for the availabilityStatuses resource.
name	string	:vartype name: str
articleId	string	The Article Id.
availabilityState	string	Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event. Known values are: "Available", "Unavailable", "Degraded", and "Unknown". (Available, Unavailable, Degraded, Unknown)
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.
location	string	Azure Resource Manager geo location of the resource.
occuredTime	string (date-time)	Timestamp for when last change in health status occurred.
reasonChronicity	string	Chronicity of the availability transition. Known values are: "Transient" and "Persistent". (Transient, Persistent)
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	object	An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned.
recommendedActions	array	Lists actions the user can take based on the current availabilityState of the resource.
reportedTime	string (date-time)	Timestamp for when the health was last checked.
resolutionETA	string (date-time)	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 (date-time)	When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.
serviceImpactingEvents	array	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.
type	string	Microsoft.ResourceHealth/AvailabilityStatuses.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $expand	Lists the current availability status for all the resources in the resource group.
list	select	resource_uri	$filter, $expand	Lists all historical availability transitions and impacting events for a single resource.
list_by_subscription_id	select	subscription_id	$filter, $expand	Lists the current availability status for all the resources in the subscription.
get_by_resource	exec	resource_uri	$filter, $expand	Gets current availability status for a single resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.
subscription_id	string
$expand	string	Setting $expand=recommendedactions in url query expands the recommendedactions in the response. Default value is None.
$filter	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 _. Default value is None.

SELECT examples

list_by_resource_group

Lists the current availability status for all the resources in the resource group.

SELECT
id,
name,
articleId,
availabilityState,
category,
context,
detailedStatus,
healthEventCategory,
healthEventCause,
healthEventId,
healthEventType,
location,
occuredTime,
reasonChronicity,
reasonType,
recentlyResolved,
recommendedActions,
reportedTime,
resolutionETA,
rootCauseAttributionTime,
serviceImpactingEvents,
summary,
title,
type
FROM azure.resource_health.availability_statuses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $expand = '{{ $expand }}'
;

list

Lists all historical availability transitions and impacting events for a single resource.

SELECT
id,
name,
articleId,
availabilityState,
category,
context,
detailedStatus,
healthEventCategory,
healthEventCause,
healthEventId,
healthEventType,
location,
occuredTime,
reasonChronicity,
reasonType,
recentlyResolved,
recommendedActions,
reportedTime,
resolutionETA,
rootCauseAttributionTime,
serviceImpactingEvents,
summary,
title,
type
FROM azure.resource_health.availability_statuses
WHERE resource_uri = '{{ resource_uri }}' -- required
AND $filter = '{{ $filter }}'
AND $expand = '{{ $expand }}'
;

list_by_subscription_id

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

SELECT
id,
name,
articleId,
availabilityState,
category,
context,
detailedStatus,
healthEventCategory,
healthEventCause,
healthEventId,
healthEventType,
location,
occuredTime,
reasonChronicity,
reasonType,
recentlyResolved,
recommendedActions,
reportedTime,
resolutionETA,
rootCauseAttributionTime,
serviceImpactingEvents,
summary,
title,
type
FROM azure.resource_health.availability_statuses
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $expand = '{{ $expand }}'
;

Lifecycle Methods

get_by_resource

Gets current availability status for a single resource.

EXEC azure.resource_health.availability_statuses.get_by_resource 
@resource_uri='{{ resource_uri }}' --required, 
@$filter='{{ $filter }}', 
@$expand='{{ $expand }}'
;