Network Status - List By Service

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

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

api-version
query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

Gets the list Network status details for all regions in which service is deployed.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementServiceGetNetworkStatus

Sample Request

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

Sample Response

[
  {
    "location": "North Central US",
    "networkStatus": {
      "dnsServers": [
        "100.78.90.70"
      ],
      "connectivityStatus": [
        {
          "name": "apimgmtst6mtxxxxxxxx.blob.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:31:07.3274887Z",
          "lastStatusChange": "2018-06-13T20:31:06.6590782Z"
        },
        {
          "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:31:08.54627Z",
          "lastStatusChange": "2018-06-13T20:31:06.8934611Z"
        },
        {
          "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:31:08.6556497Z",
          "lastStatusChange": "2018-06-13T20:31:06.7529128Z"
        },
        {
          "name": "https://prod3.metrics.nsatc.net:1886/RecoveryService",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:31:08.5618943Z",
          "lastStatusChange": "2018-06-13T20:31:07.1125257Z"
        },
        {
          "name": "n20fxxxxxxxx.database.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:31:09.3275394Z",
          "lastStatusChange": "2018-06-13T20:31:07.0968711Z"
        },
        {
          "name": "Scm",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:31:28.0942291Z",
          "lastStatusChange": "2018-06-13T20:41:09.8627827Z"
        }
      ]
    }
  },
  {
    "location": "South Central US",
    "networkStatus": {
      "dnsServers": [
        "100.92.34.14"
      ],
      "connectivityStatus": [
        {
          "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:36:26.6522053Z",
          "lastStatusChange": "2018-06-13T21:36:24.6042279Z"
        },
        {
          "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:36:25.9959344Z",
          "lastStatusChange": "2018-06-13T21:36:24.1587528Z"
        },
        {
          "name": "apimgmtstufddxxxxxxxx.blob.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:36:25.0115192Z",
          "lastStatusChange": "2018-06-13T21:36:24.5104599Z"
        },
        {
          "name": "https://prod2.metrics.nsatc.net:1886/RecoveryService",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:36:26.042817Z",
          "lastStatusChange": "2018-06-13T21:36:24.0962419Z"
        },
        {
          "name": "n20fxxxxxxxx.database.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2018-06-13T22:36:26.7615872Z",
          "lastStatusChange": "2018-06-13T21:36:24.80737Z"
        }
      ]
    }
  }
]

Definitions

ConnectivityStatusContract

Details about connectivity to a resource.

ConnectivityStatusType

Resource Connectivity Status Type identifier.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

NetworkStatusContract

Network Status details.

NetworkStatusContractByLocation

Network Status in the Location

ConnectivityStatusContract

Details about connectivity to a resource.

Name Type Description
error
  • string

Error details of the connectivity to the resource.

lastStatusChange
  • string

The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

lastUpdated
  • string

The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

name
  • string

The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.

status

Resource Connectivity Status Type identifier.

ConnectivityStatusType

Resource Connectivity Status Type identifier.

Name Type Description
failure
  • string
initializing
  • string
success
  • string

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

NetworkStatusContract

Network Status details.

Name Type Description
connectivityStatus

Gets the list of Connectivity Status to the Resources on which the service depends upon.

dnsServers
  • string[]

Gets the list of DNS servers IPV4 addresses.

NetworkStatusContractByLocation

Network Status in the Location

Name Type Description
location
  • string

Location of service

networkStatus

Network status in Location