Network Status - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

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=2024-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	NetworkStatusContractByLocation[]	Gets the list Network status details for all regions in which service is deployed.
Other Status Codes	ErrorResponse	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

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/networkstatus?api-version=2024-05-01

Sample response

Status code:: 200

[
  {
    "location": "Central US EUAP",
    "networkStatus": {
      "dnsServers": [
        "168.63.129.16"
      ],
      "connectivityStatus": [
        {
          "name": "apimst8rlxXXXXX7.queue.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:44.6399168Z",
          "lastStatusChange": "2023-05-25T03:53:44.1786214Z",
          "resourceType": "SmtpQueue",
          "isOptional": true
        },
        {
          "name": "apimstm5lkXXXXX4kky0.blob.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:39:33.9426753Z",
          "lastStatusChange": "2023-05-25T03:53:44.1786214Z",
          "resourceType": "BlobStorage",
          "isOptional": false
        },
        {
          "name": "apimstm5lkXXXXX4kky0.file.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:38.9993574Z",
          "lastStatusChange": "2023-05-25T03:53:43.8953621Z",
          "resourceType": "FileStorage",
          "isOptional": true
        },
        {
          "name": "apimstm5lkXXXXX4kky0.queue.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:38.4368875Z",
          "lastStatusChange": "2023-05-25T03:53:44.2081238Z",
          "resourceType": "Queue",
          "isOptional": true
        },
        {
          "name": "apimstm5lkXXXXX4kky0.table.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:17.4762359Z",
          "lastStatusChange": "2023-05-25T03:53:43.9734877Z",
          "resourceType": "TableStorage",
          "isOptional": false
        },
        {
          "name": "apirpsqlmgsXXXXXXic45.database.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:50.2954792Z",
          "lastStatusChange": "2023-05-25T03:53:44.0704109Z",
          "resourceType": "SQLDatabase",
          "isOptional": false
        },
        {
          "name": "gcs.prod.monitoring.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:09.8448385Z",
          "lastStatusChange": "2023-05-25T03:53:43.8484895Z",
          "resourceType": "Monitoring",
          "isOptional": false
        },
        {
          "name": "https://apikv-XXXXXXurugl3.vault.azure.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:17.3447288Z",
          "lastStatusChange": "2023-06-02T06:54:45.7125288Z",
          "resourceType": "AzureKeyVault",
          "isOptional": false
        },
        {
          "name": "https://centraluseuap.login.microsoft.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:01.6660359Z",
          "lastStatusChange": "2023-05-25T03:53:44.1490292Z",
          "resourceType": "RegionalAzureActiveDirectory",
          "isOptional": true
        },
        {
          "name": "https://gcs.prod.warm.ingestion.monitoring.azure.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:42:08.0050056Z",
          "lastStatusChange": "2023-05-26T14:09:26.2508948Z",
          "resourceType": "Monitoring",
          "isOptional": true
        },
        {
          "name": "https://global.prod.microsoftmetrics.com/",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:12.9698299Z",
          "lastStatusChange": "2023-05-25T03:53:44.1297766Z",
          "resourceType": "Monitoring",
          "isOptional": true
        },
        {
          "name": "https://login.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:43.4048644Z",
          "lastStatusChange": "2023-06-04T11:10:16.1041673Z",
          "resourceType": "AzureActiveDirectory",
          "isOptional": true
        },
        {
          "name": "https://partner.prod.repmap.microsoft.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:40:32.6067213Z",
          "lastStatusChange": "2023-05-25T03:53:44.2081238Z",
          "resourceType": "CaptchaEndpoint",
          "isOptional": true
        },
        {
          "name": "https://xxxxx.prod.microsoftmetrics.com:1886/RecoveryService",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:42:33.8566303Z",
          "lastStatusChange": "2023-05-25T03:53:44.3488261Z",
          "resourceType": "Metrics",
          "isOptional": true
        },
        {
          "name": "https://samir-XXXXXXX.management.azure-api.net:3443/servicestatus?api-version=2018-01-01",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:42:10.3954682Z",
          "lastStatusChange": "2023-06-08T16:42:10.3954682Z",
          "resourceType": "ApiManagement Control Plane - inbound",
          "isOptional": false
        },
        {
          "name": "LocalGatewayRedis",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:39:30.184537Z",
          "lastStatusChange": "2023-05-25T03:53:44.2081238Z",
          "resourceType": "InternalCache",
          "isOptional": true
        },
        {
          "name": "Scm",
          "status": "success",
          "error": "",
          "lastUpdated": "2023-06-08T16:41:24.6623693Z",
          "lastStatusChange": "2023-05-25T03:32:02.6480516Z",
          "resourceType": "SourceControl",
          "isOptional": true
        }
      ]
    }
  }
]

Definitions

Name	Description
ConnectivityStatusContract	Details about connectivity to a resource.
ConnectivityStatusType	Resource Connectivity Status Type identifier.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
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.
isOptional	boolean	Whether this is optional.
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.
resourceType	string	Resource Type.
status	ConnectivityStatusType	Resource Connectivity Status Type identifier.

ConnectivityStatusType

Resource Connectivity Status Type identifier.

Name	Type	Description
failure	string
initializing	string
success	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NetworkStatusContract

Network Status details.

Name	Type	Description
connectivityStatus	ConnectivityStatusContract[]	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	NetworkStatusContract	Network status in Location

Udostępnij za pośrednictwem