Partager via


Availability Statuses - Get By Resource

Obtient les status de disponibilité actuelles pour une seule ressource

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}

Paramètres URI

Nom Dans Obligatoire Type Description
resourceUri
path True

string

Identifiant complet de la ressource, y compris le nom et le type de la ressource. Actuellement, la prise en charge de l’API n’est pas imbriquée et les types de ressources de niveau d’imbrication sont les suivants : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/{resource-name}/{resource-name}/{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 de $expand=recommendedactions dans la requête URL développe les actions recommandées dans la réponse.

$filter
query

string

Filtre à appliquer à 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

Le status de disponibilité actuel pour 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

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

Exemple de réponse

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

Ressource impactée status 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 à Available from Available with a reasonType of type Unplanned

recommendedAction

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

serviceImpactingEvent

Listes le service ayant un impact sur les événements susceptibles d’affecter l’intégrité de la ressource.

Status

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

AvailabilityStateValues

Ressource impactée status de la ressource.

Valeur Description
Available
Degraded
Unavailable
Unknown

availabilityStatus

availabilityStatus d’une ressource.

Nom Type Description
id

string

Azure Resource Manager Identity pour la ressource availabilityStatuses.

location

string

Azure Resource Manager emplacement géographique de la ressource.

name

string

Actuelle.

properties

Properties

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

type

string

Microsoft.ResourceHealth/AvailabilityStatuses.

ErrorResponse

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

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

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

Nom Type Description
articleId

string

ID de l’article

availabilityState

AvailabilityStateValues

Disponibilité status de la ressource. Lorsqu’il a la valeur 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 indique si l’événement a été planifié ou non. Si le champ de contexte n’a pas la valeur Plateforme, ce champ est ignoré.

context

string

Lorsqu’un événement est créé, il peut être déclenché par un client ou par la plateforme de la ressource et ce champ l’illustre. Ce champ est connecté au champ catégorie dans cet objet.

detailedStatus

string

Détails de la status de disponibilité.

healthEventCategory

string

Dans le cas d’un événement impactant la disponibilité, il décrit la catégorie d’un événement impactant l’intégrité PlatformInitiated. Les exemples sont Planifiés, Non planifiés, etc.

healthEventCause

string

Dans le cas d’un événement impactant la disponibilité, il décrit l’origine de l’événement impactant l’intégrité. Par exemple, PlatformInitiated, UserInitiated, etc.

healthEventId

string

Il s’agit d’un ID unique qui identifie l’événement

healthEventType

string

Dans le cas d’un événement impactant la disponibilité, il décrit à quel moment l’événement impactant l’intégrité a été généré. Par exemple, cycle de vie, temps d’arrêt, analyse des erreurs, etc.

occuredTime

string (date-time)

Horodatage de la date de la dernière modification de l’status d’intégrité.

reasonChronicity

reasonChronicityTypes

Chronicité de la transition de disponibilité.

reasonType

string

Lorsque l’état availabilityState de la ressource est Indisponible, il décrit l’origine de l’événement impactant l’intégrité. Les exemples sont planifiés, non planifiés, lancés par l’utilisateur ou une panne, etc.

recentlyResolved

RecentlyResolved

Annotation décrivant une modification de availabilityState à Available from Available with a reasonType of type Unplanned

recommendedActions

recommendedAction[]

Listes 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 availabilityState de la ressource est Indisponible et que le reasonType n’est pas initié par l’utilisateur, il fournit la date et l’heure auxquelles le problème est censé être résolu.

rootCauseAttributionTime

string (date-time)

Lorsque l’état availabilityState de la ressource est Indisponible, il fournit l’horodatage de la réception de l’événement impactant l’intégrité.

serviceImpactingEvents

serviceImpactingEvent[]

Listes le service ayant un impact sur les événements susceptibles d’affecter l’intégrité de la ressource.

summary

string

Description récapitulative du status de disponibilité.

title

string

Description du titre du status de disponibilité.

reasonChronicityTypes

Chronicité de la transition de disponibilité.

Valeur Description
Persistent
Transient

RecentlyResolved

Annotation décrivant une modification de availabilityState à Available from Available with a reasonType of type Unplanned

Nom Type Description
resolvedTime

string (date-time)

Horodatage lorsque availabilityState passe à Disponible.

unavailableOccuredTime

string (date-time)

Horodatage du moment où availabilityState est passé à Indisponible

unavailableSummary

string

Brève description de la cause de l’indisponibilité de la ressource.

recommendedAction

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

Nom Type Description
_ActionUrl.Comment

string

commentaire pour 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

Listes le service ayant un impact sur les événements susceptibles d’affecter l’intégrité de la ressource.

Nom Type Description
correlationId

string

ID de corrélation pour l’événement

eventStartTime

string (date-time)

Horodatage du démarrage de l’événement.

eventStatusLastModifiedTime

string (date-time)

Horodatage de l’envoi/de la détection de l’événement.

incidentProperties

IncidentProperties

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

status

Status

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

Status

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

Nom Type Description
value

string

Status actuelle de l’événement