Availability Statuses - Get By Resource

Referência

Serviço:: Resource Health

Versão da API:: 2024-02-01

Obtém status de disponibilidade atuais para um único recurso

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceUri	path	True	string	A ID totalmente qualificada do recurso, incluindo o nome e o tipo de recurso. Atualmente, a API não dá suporte a tipos de recursos aninhados e de nível de aninhamento: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} e /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
api-version	query	True	string	A versão da API a ser usada para esta operação.
$expand	query		string	Definir $expand=recommendedactions na consulta url expande as recomendações na resposta.
$filter	query		string	O filtro a ser aplicado na operação. Para obter mais informações, consulte https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Respostas

Nome	Tipo	Description
200 OK	availabilityStatus	O status de disponibilidade atual para um único recurso
Other Status Codes	ErrorResponse	DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GetCurrentHealthByResource

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
      }
    ]
  }
}

Definições

Nome	Description
AvailabilityStateValues	Recurso afetado status do recurso.
availabilityStatus	availabilityStatus de um recurso.
ErrorResponse	Detalhes do erro.
IncidentProperties	Propriedades do evento de impacto do serviço.
Properties	Propriedades do estado de disponibilidade.
reasonChronicityTypes	Cronidade da transição de disponibilidade.
RecentlyResolved	Uma anotação que descreve uma alteração no availabilityState para Disponível de Indisponível com um reasonType do tipo Não planejado
recommendedAction	Listas ações que o usuário pode executar com base na disponibilidade atualState do recurso.
serviceImpactingEvent	Listas o serviço que afeta eventos que podem estar afetando a integridade do recurso.
Status	Status do evento de impacto do serviço.

AvailabilityStateValues

Recurso afetado status do recurso.

Nome	Tipo	Description
Available	string
Degraded	string
Unavailable	string
Unknown	string

availabilityStatus

availabilityStatus de um recurso.

Nome	Tipo	Description
id	string	Azure Resource Manager Identity para o recurso availabilityStatuses.
location	string	O Azure Resource Manager localização geográfica do recurso.
name	string	Atual.
properties	Properties	Propriedades do estado de disponibilidade.
type	string	Microsoft.ResourceHealth/AvailabilityStatuses.

ErrorResponse

Detalhes do erro.

Nome	Tipo	Description
code	string	O código de erro.
details	string	Os detalhes do erro.
message	string	A mensagem de erro.

IncidentProperties

Propriedades do evento de impacto do serviço.

Nome	Tipo	Description
incidentType	string	Tipo de evento.
region	string	Região afetada pelo evento.
service	string	Serviço afetado pelo evento.
title	string	Título do incidente.

Properties

Propriedades do estado de disponibilidade.

Nome	Tipo	Description
articleId	string	A ID do artigo
availabilityState	AvailabilityStateValues	Status de disponibilidade do recurso. Quando é nulo, esse objeto availabilityStatus representa um evento que afeta a disponibilidade
category	string	Quando um campo de contexto é definido como Plataforma, esse campo refletirá se o evento foi planejado ou não planejado. Se o campo de contexto não tiver um valor de Plataforma, esse campo será ignorado.
context	string	Quando um evento é criado, ele pode ser disparado por um cliente ou pela plataforma do recurso e esse campo ilustra isso. Esse campo está conectado ao campo de categoria neste objeto.
detailedStatus	string	Detalhes do status de disponibilidade.
healthEventCategory	string	No caso de um evento que afeta a disponibilidade, ele descreve a categoria de um evento de impacto na integridade platformInitiated. Os exemplos são Planejado, Não Planejado etc.
healthEventCause	string	No caso de um evento que afeta a disponibilidade, ele descreve onde o evento que afeta a integridade foi originado. Os exemplos são PlatformInitiated, UserInitiated etc.
healthEventId	string	É uma ID exclusiva que identifica o evento
healthEventType	string	No caso de um evento que afeta a disponibilidade, ele descreve quando o evento que afeta a integridade foi originado. Exemplos são Ciclo de Vida, Tempo de Inatividade, Análise de Falhas etc.
occuredTime	string	Carimbo de data/hora de quando ocorreu a última alteração na status de integridade.
reasonChronicity	reasonChronicityTypes	Cronidade da transição de disponibilidade.
reasonType	string	Quando availabilityState do recurso está indisponível, ele descreve onde o evento que afeta a integridade foi originado. Exemplos são planejados, não planejados, iniciados pelo usuário ou uma interrupção etc.
recentlyResolved	RecentlyResolved	Uma anotação que descreve uma alteração no availabilityState para Disponível de Indisponível com um reasonType do tipo Não planejado
recommendedActions	recommendedAction[]	Listas ações que o usuário pode executar com base na disponibilidade atualState do recurso.
reportedTime	string	Carimbo de data/hora de quando a integridade foi verificada pela última vez.
resolutionETA	string	Quando availabilityState do recurso está indisponível e o reasonType não é Iniciado pelo Usuário, ele fornece a data e a hora para quando o problema deve ser resolvido.
rootCauseAttributionTime	string	Quando availabilityState do recurso está indisponível, ele fornece o carimbo de data/hora para quando o evento de impacto à integridade foi recebido.
serviceImpactingEvents	serviceImpactingEvent[]	Listas o serviço que afeta eventos que podem estar afetando a integridade do recurso.
summary	string	Descrição resumida do status de disponibilidade.
title	string	Descrição do título do status de disponibilidade.

reasonChronicityTypes

Cronidade da transição de disponibilidade.

Nome	Tipo	Description
Persistent	string
Transient	string

RecentlyResolved

Uma anotação que descreve uma alteração no availabilityState para Disponível de Indisponível com um reasonType do tipo Não planejado

Nome	Tipo	Description
resolvedTime	string	Carimbo de data/hora quando availabilityState é alterado para Disponível.
unavailableOccuredTime	string	Carimbo de data/hora para quando o availabilityState foi alterado para Indisponível
unavailableSummary	string	Breve descrição da causa do recurso ficar indisponível.

recommendedAction

Listas ações que o usuário pode executar com base na disponibilidade atualState do recurso.

Nome	Tipo	Description
_ActionUrl.Comment	string	o comentário para a Ação
action	string	Ação recomendada.
actionUrl	string	Vincular à ação
actionUrlText	string	A subcadeia de caracteres de ação descreve qual texto deve hospedar a URL da ação.

serviceImpactingEvent

Listas o serviço que afeta eventos que podem estar afetando a integridade do recurso.

Nome	Tipo	Description
correlationId	string	ID de correlação para o evento
eventStartTime	string	Carimbo de data/hora para quando o evento foi iniciado.
eventStatusLastModifiedTime	string	Carimbo de data/hora para quando o evento foi enviado/detectado.
incidentProperties	IncidentProperties	Propriedades do evento de impacto do serviço.
status	Status	Status do evento de impacto do serviço.

Status

Status do evento de impacto do serviço.

Nome	Tipo	Description
value	string	Status atual do evento

Compartilhar via