Region Healths - Get

Dienst:

Azure Stack Admin

API-Version:

2016-05-01

Gibt den angeforderten Integritätsstatus eines Bereichs zurück.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}?api-version=2016-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string	Name der Region
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	RegionHealth	OKAY

Sicherheit

azure_auth

Die Autorisierung verwendet einen Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Returns the requested health status of a region.

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local?api-version=2016-05-01

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local",
  "name": "local",
  "type": "Microsoft.InfrastructureInsights.Admin/regionHealths",
  "location": "local",
  "tags": {},
  "properties": {
    "usageMetrics": [
      {
        "name": "Physical memory",
        "metricsValue": [
          {
            "name": "Used",
            "unit": "GB",
            "value": 76.24941635131836
          },
          {
            "name": "Available",
            "unit": "GB",
            "value": 181.7333984375
          }
        ]
      },
      {
        "name": "Physical storage",
        "metricsValue": [
          {
            "name": "Used",
            "unit": "TB",
            "value": 0.22170669212937355
          },
          {
            "name": "Available",
            "unit": "TB",
            "value": 2.2449070774018764
          }
        ]
      },
      {
        "name": "Public IP address pools",
        "metricsValue": [
          {
            "name": "Used",
            "unit": "One",
            "value": 31
          },
          {
            "name": "Available",
            "unit": "One",
            "value": 480
          }
        ]
      }
    ],
    "alertSummary": {
      "criticalAlertCount": 0,
      "warningAlertCount": 2
    }
  }
}

Definitionen

Name	Beschreibung
AlertSummary	Zusammenfassung der Warnungen.
Metrics	Metriken für eine Quelle.
MetricsSourceType	Der Ursprung der Metrik.
MetricsUnit	Die Einheit der Metrik.
RegionHealth	Enthält Informationen zur Integrität einer Region.
UsageMetrics	Metriken der Ressourcennutzung.

AlertSummary

Objekt

Zusammenfassung der Warnungen.

Name	Typ	Beschreibung
criticalAlertCount	integer	Die Anzahl der kritischen Warnungen für den Dienst.
warningAlertCount	integer	Die Anzahl der Warnungen für den Dienst.

Metrics

Objekt

Metriken für eine Quelle.

Name	Typ	Beschreibung
maCounterName	string	Name des Zählers.
name	string	Name der Verwendungsmetrik.
observedTimestamp	string (date-time)	Der Zeitzähler wurde beobachtet.
sourceName	MetricsSourceType	Name der Quelle.
sourceType	string	Typ der Quelle.
unit	MetricsUnit	Einheit für die Metrik.
value	number (double)	Name der Verwendungsmetrik.

MetricsSourceType

Enumeration

Der Ursprung der Metrik.

Wert	Beschreibung
PhysicalNode
VirtualMachine
ResourceProvider

MetricsUnit

Enumeration

Die Einheit der Metrik.

Wert	Beschreibung
One
Percentage
B
KB
MB
GB
TB

RegionHealth

Objekt

Enthält Informationen zur Integrität einer Region.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource
location	string	Die Azure-Region, in der sich die Ressource befindet
name	string	Der Name der Ressource
properties.alertSummary	AlertSummary	Zusammenfassung der Warnungen.
properties.usageMetrics	UsageMetrics[]	Liste der Nutzungsmetriken für die Region.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource.

UsageMetrics

Objekt

Metriken der Ressourcennutzung.

Name	Typ	Beschreibung
metricsValue	Metrics[]	Liste der Verwendungsmetriken.
name	string	Name der Verwendungsmetrik.