Availability Statuses - Get By Resource

Référence

Service:: Resource Health

Version d'API:: 2024-02-01

Obtient l’état de disponibilité actuel d’une ressource unique

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceUri	path	True	string	ID complet de la ressource, y compris le nom de la ressource et le type de ressource. Actuellement, l’API ne prend pas en charge les types de ressources de niveau imbrication : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} et /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$expand	query		string	La définition $expand=recommendedactions dans la requête d’URL développe les actions recommandées dans la réponse.
$filter	query		string	Filtre à appliquer sur l’opération. Pour plus d’informations, consultez https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Réponses

Nom	Type	Description
200 OK	availabilityStatus	État de disponibilité actuel d’une seule ressource
Other Status Codes	ErrorResponse	DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

GetCurrentHealthByResource

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
      }
    ]
  }
}

Définitions

Nom	Description
AvailabilityStateValues	État de la ressource impactée de la ressource.
availabilityStatus	availabilityStatus d’une ressource.
ErrorResponse	Détails de l’erreur.
IncidentProperties	Propriétés de l’événement impactant le service.
Properties	Propriétés de l’état de disponibilité.
reasonChronicityTypes	Chronicité de la transition de disponibilité.
RecentlyResolved	Annotation décrivant une modification de availabilityState à Disponible à partir d’indisponible avec un reasonType de type Non planifié
recommendedAction	Répertorie les actions que l’utilisateur peut effectuer en fonction de l’état de disponibilité actuel de la ressource.
serviceImpactingEvent	Répertorie les événements impactant le service qui peuvent affecter l’intégrité de la ressource.
Status	État de l’événement impactant le service.

AvailabilityStateValues

Énumération

État de la ressource impactée de la ressource.

Valeur	Description
Available
Degraded
Unavailable
Unknown

availabilityStatus

Object

availabilityStatus d’une ressource.

Nom	Type	Description
id	string	Identité Azure Resource Manager pour la ressource availabilityStatuses.
location	string	Emplacement géographique Azure Resource Manager de la ressource.
name	string	courant.
properties	Properties	Propriétés de l’état de disponibilité.
type	string	Microsoft.ResourceHealth/AvailabilityStatuses.

ErrorResponse

Object

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	string	Détails de l’erreur.
message	string	Message d’erreur.

IncidentProperties

Object

Propriétés de l’événement impactant le service.

Nom	Type	Description
incidentType	string	Type d’événement.
region	string	Région affectée par l’événement.
service	string	Service affecté par l’événement.
title	string	Titre de l’incident.

Properties

Object

Propriétés de l’état de disponibilité.

Nom	Type	Description
articleId	string	ID de l’article
availabilityState	AvailabilityStateValues	État de disponibilité de la ressource. Lorsqu’il est null, cet objet availabilityStatus représente un événement impactant la disponibilité
category	string	Lorsqu’un champ de contexte est défini sur Plateforme, ce champ reflète si l’événement a été planifié ou non planifié. Si le champ de contexte n’a pas de valeur de plateforme, ce champ est ignoré.
context	string	Lorsqu’un événement est créé, il peut être déclenché par un client ou la plateforme de la ressource et ce champ illustre cela. Ce champ est connecté au champ de catégorie de cet objet.
detailedStatus	string	Détails de l’état de disponibilité.
healthEventCategory	string	En cas d’événement impactant la disponibilité, il décrit la catégorie d’un événement d’impact sur l’intégrité PlatformInitiated. Les exemples sont planifiés, non planifiés, etc.
healthEventCause	string	En cas d’événement impactant la disponibilité, il décrit l’origine de l’événement d’impact sur l’intégrité. Par exemple, PlatformInitiated, UserInitiated, etc.
healthEventId	string	Il s’agit d’un ID unique qui identifie l’événement
healthEventType	string	En cas d’événement impactant la disponibilité, il décrit quand l’événement d’impact sur l’intégrité a été généré. Par exemple, le cycle de vie, le temps d’arrêt, l’analyse des erreurs, etc.
occuredTime	string (date-time)	Horodatage pour le moment où la dernière modification de l’état d’intégrité s’est produite.
reasonChronicity	reasonChronicityTypes	Chronicité de la transition de disponibilité.
reasonType	string	Lorsque l’état de disponibilité de la ressource n’est pas disponible, il décrit l’origine de l’événement d’impact sur l’intégrité. Les exemples sont planifiés, non planifiés, initiés par l’utilisateur ou une panne, etc.
recentlyResolved	RecentlyResolved	Annotation décrivant une modification de availabilityState à Disponible à partir d’indisponible avec un reasonType de type Non planifié
recommendedActions	recommendedAction[]	Répertorie les actions que l’utilisateur peut effectuer en fonction de l’état de disponibilité actuel de la ressource.
reportedTime	string (date-time)	Horodatage de la dernière vérification de l’intégrité.
resolutionETA	string (date-time)	Lorsque l’état de disponibilité de la ressource n’est pas disponible et que le reasonType n’est pas initié par l’utilisateur, il fournit la date et l’heure de résolution du problème.
rootCauseAttributionTime	string (date-time)	Lorsque l’état de disponibilité de la ressource n’est pas disponible, il fournit l’horodatage lorsque l’événement d’impact sur l’intégrité a été reçu.
serviceImpactingEvents	serviceImpactingEvent[]	Répertorie les événements impactant le service qui peuvent affecter l’intégrité de la ressource.
summary	string	Description récapitulative de l’état de disponibilité.
title	string	Description du titre de l’état de disponibilité.

reasonChronicityTypes

Énumération

Chronicité de la transition de disponibilité.

Valeur	Description
Persistent
Transient

RecentlyResolved

Object

Annotation décrivant une modification de availabilityState à Disponible à partir d’indisponible avec un reasonType de type Non planifié

Nom	Type	Description
resolvedTime	string (date-time)	Horodatage lorsque l’état de disponibilité passe à Available.
unavailableOccuredTime	string (date-time)	Horodatage pour lequel l’état de disponibilité est passé à Indisponible
unavailableSummary	string	Brève description de la cause de l’indisponibilité de la ressource.

recommendedAction

Object

Répertorie les actions que l’utilisateur peut effectuer en fonction de l’état de disponibilité actuel de la ressource.

Nom	Type	Description
_ActionUrl.Comment	string	commentaire de l’action
action	string	Action recommandée.
actionUrl	string	Lien vers l’action
actionUrlText	string	Sous-chaîne d’action, il décrit le texte qui doit héberger l’URL de l’action.

serviceImpactingEvent

Object

Répertorie les événements impactant le service qui peuvent affecter l’intégrité de la ressource.

Nom	Type	Description
correlationId	string	ID de corrélation de l’événement
eventStartTime	string (date-time)	Horodatage pour le démarrage de l’événement.
eventStatusLastModifiedTime	string (date-time)	Horodatage pour le moment où l’événement a été envoyé/détecté.
incidentProperties	IncidentProperties	Propriétés de l’événement impactant le service.
status	Status	État de l’événement impactant le service.

Status

Object

État de l’événement impactant le service.

Nom	Type	Description
value	string	État actuel de l’événement

Partager via

Availability Statuses - Get By Resource

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

GetCurrentHealthByResource

Exemple de requête

Exemple de réponse

Définitions

AvailabilityStateValues

availabilityStatus

ErrorResponse

IncidentProperties

Properties

reasonChronicityTypes

RecentlyResolved

recommendedAction

serviceImpactingEvent

Status

Ressources supplémentaires