Availability Statuses - Get By Resource

Reference

Služba:: Resource Health

Verze rozhraní API:: 2024-02-01

Získá aktuální stav dostupnosti pro jeden prostředek.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceUri	path	True	string	Plně kvalifikované ID prostředku, včetně názvu a typu prostředku. V současné době rozhraní API nepodporuje vnořené typy prostředků a jeden typ prostředků na úrovni vnoření: /subscriptions/{subscriptionId}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku } a /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{parentResourceType}/{parentResourceName}/{resourceType}/{název_prostředku}
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$expand	query		string	Nastavení $expand=recommendedactions v dotazu adresy URL rozšíří doporučené akce v odpovědi.
$filter	query		string	Filtr, který se má použít na operaci. Další informace najdete v tématu https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Odpovědi

Name	Typ	Description
200 OK	availabilityStatus	Aktuální stav dostupnosti pro jeden prostředek
Other Status Codes	ErrorResponse	DefaultErrorResponse

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetCurrentHealthByResource

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
      }
    ]
  }
}

Definice

Name	Description
AvailabilityStateValues	Ovlivněný stav prostředku
availabilityStatus	availabilityStatus prostředku.
ErrorResponse	Podrobnosti o chybě.
IncidentProperties	Vlastnosti služby, která má vliv na událost.
Properties	Vlastnosti stavu dostupnosti.
reasonChronicityTypes	Chronická dostupnost přechodu.
RecentlyResolved	Poznámka popisující změnu v availabilityState na Available z Unavailable s reasonType typu Neplánned
recommendedAction	Seznamy akce, které může uživatel provést na základě aktuálního stavu dostupnosti prostředku.
serviceImpactingEvent	Seznamy službu ovlivňující události, které můžou mít vliv na stav prostředku.
Status	Stav služby, která má vliv na událost.

AvailabilityStateValues

Ovlivněný stav prostředku

Name	Typ	Description
Available	string
Degraded	string
Unavailable	string
Unknown	string

availabilityStatus

availabilityStatus prostředku.

Name	Typ	Description
id	string	Azure Resource Manager Identity pro prostředek availabilityStatuses.
location	string	Azure Resource Manager geografické umístění prostředku.
name	string	Aktuální.
properties	Properties	Vlastnosti stavu dostupnosti.
type	string	Microsoft.ResourceHealth/AvailabilityStatuses.

ErrorResponse

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
details	string	Podrobnosti o chybě.
message	string	Chybová zpráva

IncidentProperties

Vlastnosti služby, která má vliv na událost.

Name	Typ	Description
incidentType	string	Typ události.
region	string	Oblast ovlivněná událostí
service	string	Služba ovlivněná událostí.
title	string	Název incidentu.

Properties

Vlastnosti stavu dostupnosti.

Name	Typ	Description
articleId	string	ID článku
availabilityState	AvailabilityStateValues	Stav dostupnosti prostředku. Pokud má hodnotu null, představuje tento objekt availabilityStatus událost, která ovlivňuje dostupnost.
category	string	Pokud je kontextové pole nastaveno na Platform (Platforma), bude toto pole odrážet, jestli byla událost naplánovaná nebo neplánovaná. Pokud kontextové pole nemá hodnotu Platforma, bude toto pole ignorováno.
context	string	Když se událost vytvoří, může ji aktivovat zákazník nebo platforma prostředku, což bude ilustrovat toto pole. Toto pole je připojeno k poli kategorie v tomto objektu.
detailedStatus	string	Podrobnosti o stavu dostupnosti
healthEventCategory	string	V případě události, která má vliv na dostupnost, popisuje kategorii události, která má vliv na stav iniciovaná platformou. Příklady jsou Plánované, Neplánované atd.
healthEventCause	string	V případě události, která má vliv na dostupnost, popisuje, odkud událost ovlivňující stav pochází. Příklady jsou PlatformInitiated (Iniciované platformou), UserInitiated (Iniciované uživatelem) atd.
healthEventId	string	Jedná se o jedinečné ID, které identifikuje událost.
healthEventType	string	V případě události, která má vliv na dostupnost, popisuje, kdy událost, která má vliv na stav, vznikla. Mezi příklady patří životní cyklus, výpadky, analýza chyb atd.
occuredTime	string	Časové razítko, kdy došlo k poslední změně stavu.
reasonChronicity	reasonChronicityTypes	Chronická dostupnost přechodu.
reasonType	string	Když je stav dostupnosti prostředku nedostupný, popisuje, odkud událost, která má vliv na stav, pochází. Příklady jsou plánované, neplánované, iniciované uživatelem nebo výpadek atd.
recentlyResolved	RecentlyResolved	Poznámka popisující změnu v availabilityState na Available z Unavailable s reasonType typu Neplánned
recommendedActions	recommendedAction[]	Seznamy akce, které může uživatel provést na základě aktuálního stavu dostupnosti prostředku.
reportedTime	string	Časové razítko poslední kontroly stavu
resolutionETA	string	Pokud je vlastnost availabilityState prostředku nedostupná a hodnota reasonType není iniciovaná uživatelem, zobrazí se datum a čas, kdy se má problém vyřešit.
rootCauseAttributionTime	string	Když je stav availabilityState prostředku nedostupný, poskytuje časové razítko, kdy byla přijata událost ovlivňující stav.
serviceImpactingEvents	serviceImpactingEvent[]	Seznamy službu ovlivňující události, které můžou mít vliv na stav prostředku.
summary	string	Souhrnný popis stavu dostupnosti
title	string	Popis názvu stavu dostupnosti

reasonChronicityTypes

Chronická dostupnost přechodu.

Name	Typ	Description
Persistent	string
Transient	string

RecentlyResolved

Poznámka popisující změnu v availabilityState na Available z Unavailable s reasonType typu Neplánned

Name	Typ	Description
resolvedTime	string	Časové razítko, kdy se availabilityState změní na K dispozici.
unavailableOccuredTime	string	Časové razítko, kdy se vlastnost availabilityState změnila na Nedostupná
unavailableSummary	string	Stručný popis příčiny nedostupnosti prostředku

recommendedAction

Seznamy akce, které může uživatel provést na základě aktuálního stavu dostupnosti prostředku.

Name	Typ	Description
_ActionUrl.Comment	string	komentář k akci
action	string	Doporučená akce.
actionUrl	string	Odkaz na akci
actionUrlText	string	Podřetěžce akce popisuje, který text by měl být hostitelem adresy URL akce.

serviceImpactingEvent

Seznamy službu ovlivňující události, které můžou mít vliv na stav prostředku.

Name	Typ	Description
correlationId	string	ID korelace události
eventStartTime	string	Časové razítko, kdy událost začala.
eventStatusLastModifiedTime	string	Časové razítko, kdy byla událost odeslána nebo zjištěna.
incidentProperties	IncidentProperties	Vlastnosti služby, která má vliv na událost.
status	Status	Stav služby, která má vliv na událost.

Status

Stav služby, která má vliv na událost.

Name	Typ	Description
value	string	Aktuální stav události

Sdílet prostřednictvím