Dela via


Availability Statuses - Get By Resource

Hämtar aktuell tillgänglighetsstatus för en enskild resurs

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}

URI-parametrar

Name I Obligatorisk Typ Description
resourceUri
path True

string

Resursens fullständigt kvalificerade ID, inklusive resursnamn och resurstyp. För närvarande stöder API:et inte kapslad och en kapslingsnivå för resurstyper: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} och /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

$expand
query

string

Inställningen $expand=recommendedactions i URL-frågan expanderar de rekommenderade åtgärderna i svaret.

$filter
query

string

Filtret som ska tillämpas på åtgärden. Mer information finns i https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Svar

Name Typ Description
200 OK

availabilityStatus

Aktuell tillgänglighetsstatus för en enskild resurs

Other Status Codes

ErrorResponse

DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

GetCurrentHealthByResource

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AvailabilityStateValues

Resursens resursstatus påverkas.

availabilityStatus

availabilityStatus för en resurs.

ErrorResponse

Felinformation.

IncidentProperties

Egenskaper för den tjänst som påverkar händelsen.

Properties

Egenskaper för tillgänglighetstillstånd.

reasonChronicityTypes

Kronisk tillgänglighetsövergång.

RecentlyResolved

En anteckning som beskriver en ändring i availabilityState till Tillgänglig från otillgänglig med en reasonType av typen Oplanerad

recommendedAction

Listor åtgärder som användaren kan vidta baserat på resursens aktuella tillgänglighetTillstånd.

serviceImpactingEvent

Listor tjänsten som påverkar händelser som kan påverka resursens hälsotillstånd.

Status

Status för den tjänst som påverkar händelsen.

AvailabilityStateValues

Resursens resursstatus påverkas.

Name Typ Description
Available

string

Degraded

string

Unavailable

string

Unknown

string

availabilityStatus

availabilityStatus för en resurs.

Name Typ Description
id

string

Azure Resource Manager Identity för resursen availabilityStatuses.

location

string

Azure Resource Manager geoplats för resursen.

name

string

Nuvarande.

properties

Properties

Egenskaper för tillgänglighetstillstånd.

type

string

Microsoft.ResourceHealth/AvailabilityStatuses.

ErrorResponse

Felinformation.

Name Typ Description
code

string

Felkoden.

details

string

Felinformationen.

message

string

Felmeddelandet.

IncidentProperties

Egenskaper för den tjänst som påverkar händelsen.

Name Typ Description
incidentType

string

Typ av händelse.

region

string

Region som påverkas av händelsen.

service

string

Tjänsten påverkas av händelsen.

title

string

Incidentens rubrik.

Properties

Egenskaper för tillgänglighetstillstånd.

Name Typ Description
articleId

string

Artikel-ID

availabilityState

AvailabilityStateValues

Resursens tillgänglighetsstatus. När det är null representerar det här availabilityStatus-objektet en tillgänglighet som påverkar händelsen

category

string

När ett kontextfält har angetts till Plattform återspeglar det här fältet om händelsen var planerad eller oplanerad. Om kontextfältet inte har värdet Plattform ignoreras det här fältet.

context

string

När en händelse skapas kan den antingen utlösas av en kund eller resursplattformen, och det här fältet visar det. Det här fältet är anslutet till kategorifältet i det här objektet.

detailedStatus

string

Information om tillgänglighetsstatus.

healthEventCategory

string

Om en tillgänglighet påverkar händelsen beskriver den kategorin för en plattformInitierad hälsopåverkande händelse. Exempel är Planerad, Oplanerad osv.

healthEventCause

string

Om en tillgänglighet påverkar händelsen beskrivs var den hälsopåverkande händelsen har sitt ursprung. Exempel är PlatformInitiated, UserInitiated osv.

healthEventId

string

Det är ett unikt ID som identifierar händelsen

healthEventType

string

Om en tillgänglighet påverkar händelsen beskrivs när den hälsopåverkande händelsen har sitt ursprung. Exempel är livscykel, stilleståndstid, felanalys osv.

occuredTime

string

Tidsstämpel för när den senaste ändringen i hälsostatusen inträffade.

reasonChronicity

reasonChronicityTypes

Kronisk tillgänglighetsövergång.

reasonType

string

När resursens tillgänglighetTillstånd inte är tillgängligt beskrivs var den hälsopåverkande händelsen har sitt ursprung. Exempel är planerade, oplanerade, användarinitierade eller avbrott osv.

recentlyResolved

RecentlyResolved

En anteckning som beskriver en ändring i availabilityState till Tillgänglig från otillgänglig med en reasonType av typen Oplanerad

recommendedActions

recommendedAction[]

Listor åtgärder som användaren kan vidta baserat på resursens aktuella tillgänglighetTillstånd.

reportedTime

string

Tidsstämpel för när hälsotillståndet senast kontrollerades.

resolutionETA

string

När resursens tillgänglighetTillstånd är otillgängligt och reasonType inte är användarinitierad, anger den datum och tid för när problemet förväntas lösas.

rootCauseAttributionTime

string

När resursens tillgänglighetTillstånd inte är tillgängligt tillhandahåller den tidsstämpeln för när den hälsopåverkande händelsen togs emot.

serviceImpactingEvents

serviceImpactingEvent[]

Listor tjänsten som påverkar händelser som kan påverka resursens hälsotillstånd.

summary

string

Sammanfattning av tillgänglighetsstatus.

title

string

Beskrivning av tillgänglighetsstatus.

reasonChronicityTypes

Kronisk tillgänglighetsövergång.

Name Typ Description
Persistent

string

Transient

string

RecentlyResolved

En anteckning som beskriver en ändring i availabilityState till Tillgänglig från otillgänglig med en reasonType av typen Oplanerad

Name Typ Description
resolvedTime

string

Tidsstämpel när availabilityState ändras till Tillgänglig.

unavailableOccuredTime

string

Tidsstämpel för när availabilityState ändrades till Ej tillgänglig

unavailableSummary

string

Kort beskrivning av orsaken till att resursen blir otillgänglig.

recommendedAction

Listor åtgärder som användaren kan vidta baserat på resursens aktuella tillgänglighetTillstånd.

Name Typ Description
_ActionUrl.Comment

string

kommentaren för åtgärden

action

string

Rekommenderad åtgärd.

actionUrl

string

Länka till åtgärden

actionUrlText

string

Delsträngen av åtgärden beskriver vilken text som ska vara värd för åtgärds-URL:en.

serviceImpactingEvent

Listor tjänsten som påverkar händelser som kan påverka resursens hälsotillstånd.

Name Typ Description
correlationId

string

Korrelations-ID för händelsen

eventStartTime

string

Tidsstämpel för när händelsen startade.

eventStatusLastModifiedTime

string

Tidsstämpel för när händelsen skickades/identifierades.

incidentProperties

IncidentProperties

Egenskaper för den tjänst som påverkar händelsen.

status

Status

Status för den tjänst som påverkar händelsen.

Status

Status för den tjänst som påverkar händelsen.

Name Typ Description
value

string

Aktuell status för händelsen