Network Status - List By Location
Ruft den Konnektivitätsstatus für die externen Ressourcen ab, von denen der Api Management-Dienst innerhalb des Clouddiensts abhängt. Dadurch werden auch die DNS-Server als für den CloudService sichtbar zurückgegeben.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus?api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
location
|
path | True |
string |
Speicherort, an dem der API Management-Dienst bereitgestellt wird. Dies ist eine der Azure-Regionen wie "USA, Westen", "USA, Osten" und "USA, Süden-Mitte". |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. Regex pattern: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Ruft die Details des Netzwerk-status ab. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementServiceGetNetworkStatusByLocation
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/locations/North Central US/networkstatus?api-version=2022-08-01
Sample Response
{
"dnsServers": [
"10.82.98.10"
],
"connectivityStatus": [
{
"name": "apimgmtst6tnxxxxxxxxxxx.blob.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:14.7035899Z",
"lastStatusChange": "2020-11-20T07:54:55.9365931Z",
"resourceType": "BlobStorage",
"isOptional": false
},
{
"name": "apimgmtst6tnxxxxxxxxxxx.file.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:41.5322463Z",
"lastStatusChange": "2020-11-20T07:54:55.9265938Z",
"resourceType": "FileStorage",
"isOptional": true
},
{
"name": "apimgmtst6tnxxxxxxxxxxx.queue.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:30.645994Z",
"lastStatusChange": "2020-11-20T07:54:55.8410477Z",
"resourceType": "Queue",
"isOptional": true
},
{
"name": "apimgmtst6tnxxxxxxxxxxx.table.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:23.8789171Z",
"lastStatusChange": "2020-11-20T07:54:55.9365931Z",
"resourceType": "TableStorage",
"isOptional": false
},
{
"name": "gcs.prod.monitoring.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:57:34.8666833Z",
"lastStatusChange": "2020-11-20T08:07:37.5486932Z",
"resourceType": "Monitoring",
"isOptional": true
},
{
"name": "https://gcs.ppe.warm.ingestion.monitoring.azure.com",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:26.1870188Z",
"lastStatusChange": "2020-11-20T07:54:56.1060523Z",
"resourceType": "Monitoring",
"isOptional": true
},
{
"name": "https://global.metrics.nsatc.net/",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:35.9620612Z",
"lastStatusChange": "2020-11-20T07:54:56.0510519Z",
"resourceType": "Monitoring",
"isOptional": true
},
{
"name": "https://login.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:30.8047708Z",
"lastStatusChange": "2020-11-20T07:54:56.1060523Z",
"resourceType": "AzureActiveDirectory",
"isOptional": true
},
{
"name": "https://prod2.metrics.nsatc.net:1886/RecoveryService",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:45.2095302Z",
"lastStatusChange": "2020-11-20T07:54:56.2796235Z",
"resourceType": "Metrics",
"isOptional": true
},
{
"name": "LocalGatewayRedis",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:15.1345836Z",
"lastStatusChange": "2020-11-20T07:54:55.9365931Z",
"resourceType": "InternalCache",
"isOptional": true
},
{
"name": "prod.warmpath.msftcloudes.com",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:57.8992141Z",
"lastStatusChange": "2020-11-20T07:54:55.8410477Z",
"resourceType": "Monitoring",
"isOptional": false
},
{
"name": "Scm",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T23:03:57.6187917Z",
"lastStatusChange": "2020-11-20T07:54:57.325384Z",
"resourceType": "SourceControl",
"isOptional": true
},
{
"name": "smtpi-xxx.msn.com:25028",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:58:22.2430074Z",
"lastStatusChange": "2020-11-20T07:54:56.3510577Z",
"resourceType": "Email",
"isOptional": true
},
{
"name": "zwcvuxxxx.database.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:44.3582171Z",
"lastStatusChange": "2020-11-20T07:54:56.0410467Z",
"resourceType": "SQLDatabase",
"isOptional": false
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Connectivity |
Details zur Konnektivität mit einer Ressource. |
Connectivity |
Statusbezeichner der Ressourcenkonnektivität. |
Error |
Fehler Feldvertrag. |
Error |
Fehlerantwort. |
Network |
Details zum Netzwerkstatus. |
ConnectivityStatusContract
Details zur Konnektivität mit einer Ressource.
Name | Typ | Beschreibung |
---|---|---|
error |
string |
Fehlerdetails der Konnektivität mit der Ressource. |
isOptional |
boolean |
Gibt an, ob dies optional ist. |
lastStatusChange |
string |
Das Datum, an dem die Ressourcenkonnektivität zuletzt status Geändert von Erfolg zu Fehler oder umgekehrt. Das Datum entspricht dem folgenden Format: |
lastUpdated |
string |
Das Datum, an dem die Ressourcenkonnektivität status zuletzt aktualisiert wurde. Diese status sollte alle 15 Minuten aktualisiert werden. Wenn diese status nicht aktualisiert wurde, bedeutet dies, dass der Dienst die Netzwerkkonnektivität mit der Ressource innerhalb des Virtual Network verloren hat. Das Datum entspricht dem folgenden Format: |
name |
string |
Der Hostname der Ressource, von der der Dienst abhängt. Dies kann die Datenbank, der Speicher oder jede andere Azure-Ressource sein, von der der Dienst abhängt. |
resourceType |
string |
Ressourcentyp. |
status |
Statusbezeichner der Ressourcenkonnektivität. |
ConnectivityStatusType
Statusbezeichner der Ressourcenkonnektivität.
Name | Typ | Beschreibung |
---|---|---|
failure |
string |
|
initializing |
string |
|
success |
string |
ErrorFieldContract
Fehler Feldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
NetworkStatusContract
Details zum Netzwerkstatus.
Name | Typ | Beschreibung |
---|---|---|
connectivityStatus |
Ruft die Liste des Konnektivitätsstatus für die Ressourcen ab, von denen der Dienst abhängt. |
|
dnsServers |
string[] |
Ruft die Liste der IPV4-Adressen der DNS-Server ab. |