Network Status - List By Service

  • Riferimento
Service:
API Management
API Version:
2022-08-01

Ottiene lo stato della connettività alle risorse esterne da cui dipende il servizio Gestione API dall'interno del servizio cloud. In questo modo i server DNS vengono restituiti come visibili a CloudService.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus?api-version=2022-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName
 path True

string

Nome del servizio di Gestione API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

NetworkStatusContractByLocation[]

Ottiene l'elenco Dettagli stato rete per tutte le aree in cui viene distribuito il servizio.
Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementServiceGetNetworkStatus

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/networkstatus?api-version=2022-08-01

Sample Response

Status code:
200 
[
  {
    "location": "West US",
    "networkStatus": {
      "dnsServers": [
        "10.82.98.10"
      ],
      "connectivityStatus": [
        {
          "name": "apimgmtst6xxxxxxxxxxx.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": "apimgmtst6xxxxxxxxxxx.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": "apimgmtst6xxxxxxxxxxx.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": "apimgmtst6xxxxxxxxxxx.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:01:24.0553684Z",
          "lastStatusChange": "2019-07-20T02:25:48.7066996Z",
          "resourceType": "SourceControl",
          "isOptional": true
        },
        {
          "name": "smtpi-ch1.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
        }
      ]
    }
  }
]

Definizioni

Nome Descrizione
ConnectivityStatusContract

Informazioni dettagliate sulla connettività a una risorsa.
ConnectivityStatusType

Identificatore del tipo di stato della connettività della risorsa.
ErrorFieldContract

Contratto campo di errore.
ErrorResponse

Risposta errore.
NetworkStatusContract

Dettagli sullo stato della rete.
NetworkStatusContractByLocation

Stato della rete nel percorso

ConnectivityStatusContract

Informazioni dettagliate sulla connettività a una risorsa.

Nome Tipo Descrizione
error

string

Dettagli dell'errore della connettività alla risorsa.
isOptional

boolean

Indica se è facoltativo.
lastStatusChange

string

Data in cui lo stato di connettività della risorsa è stato modificato dall'esito positivo all'esito negativo o viceversa. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
lastUpdated

string

Data dell'ultimo aggiornamento dello stato di connettività della risorsa. Questo stato deve essere aggiornato ogni 15 minuti. Se questo stato non è stato aggiornato, significa che il servizio ha perso la connettività di rete alla risorsa, dall'interno del Rete virtuale. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
name

string

Nome host della risorsa da cui dipende il servizio. Può trattarsi del database, dell'archiviazione o di qualsiasi altra risorsa di Azure da cui dipende il servizio.
resourceType

string

Tipo di risorsa.
status

ConnectivityStatusType

Identificatore del tipo di stato della connettività della risorsa.

ConnectivityStatusType

Identificatore del tipo di stato della connettività della risorsa.

Nome Tipo Descrizione
failure

string

initializing

string

success

string

ErrorFieldContract

Contratto campo di errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.
message

string

Rappresentazione leggibile dell'errore a livello di proprietà.
target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message

string

Rappresentazione leggibile dell'errore.

NetworkStatusContract

Dettagli sullo stato della rete.

Nome Tipo Descrizione
connectivityStatus

ConnectivityStatusContract[]

Ottiene l'elenco dello stato di connettività alle risorse da cui dipende il servizio.
dnsServers

string[]

Ottiene l'elenco di indirizzi IPV4 dei server DNS.

NetworkStatusContractByLocation

Stato della rete nel percorso

Nome Tipo Descrizione
location

string

Posizione del servizio
networkStatus

NetworkStatusContract

Stato della rete nel percorso