Network Status - List By Location

參考

Service:: API Management

API Version:: 2022-08-01

取得 Api 管理服務從雲端服務內部相依的外部資源連線狀態。這也會將 DNS 伺服器傳回為 CloudService 可見。

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

URI 參數

名稱	位於	必要	類型	Description
locationName	path	True	string	部署 API 管理服務的位置。這是其中一個 Azure 區域，例如美國西部、美國東部、美國中南部。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
serviceName	path	True	string	API 管理服務的名稱。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	NetworkStatusContract	取得網路狀態詳細數據。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

/** Samples for NetworkStatus ListByLocation. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json
     */
    /**
     * Sample code: ApiManagementServiceGetNetworkStatusByLocation.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementServiceGetNetworkStatusByLocation(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .networkStatus()
            .listByLocationWithResponse("rg1", "apimService1", "North Central US", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_get_network_status_by_location.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.network_status.list_by_location(
        resource_group_name="rg1",
        service_name="apimService1",
        location_name="North Central US",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json
func ExampleNetworkStatusClient_ListByLocation() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNetworkStatusClient().ListByLocation(ctx, "rg1", "apimService1", "North Central US", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NetworkStatusContract = armapimanagement.NetworkStatusContract{
	// 	ConnectivityStatus: []*armapimanagement.ConnectivityStatusContract{
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.blob.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.936Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:14.703Z"); return t}()),
	// 			ResourceType: to.Ptr("BlobStorage"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.file.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.926Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:41.532Z"); return t}()),
	// 			ResourceType: to.Ptr("FileStorage"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.queue.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.841Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:30.645Z"); return t}()),
	// 			ResourceType: to.Ptr("Queue"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.table.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.936Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:23.878Z"); return t}()),
	// 			ResourceType: to.Ptr("TableStorage"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("gcs.prod.monitoring.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T08:07:37.548Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:57:34.866Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://gcs.ppe.warm.ingestion.monitoring.azure.com"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.106Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:26.187Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://global.metrics.nsatc.net/"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.051Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:35.962Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://login.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.106Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:30.804Z"); return t}()),
	// 			ResourceType: to.Ptr("AzureActiveDirectory"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://prod2.metrics.nsatc.net:1886/RecoveryService"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.279Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:45.209Z"); return t}()),
	// 			ResourceType: to.Ptr("Metrics"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("LocalGatewayRedis"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.936Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:15.134Z"); return t}()),
	// 			ResourceType: to.Ptr("InternalCache"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("prod.warmpath.msftcloudes.com"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.841Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:57.899Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("Scm"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:57.325Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T23:03:57.618Z"); return t}()),
	// 			ResourceType: to.Ptr("SourceControl"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("smtpi-xxx.msn.com:25028"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.351Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:58:22.243Z"); return t}()),
	// 			ResourceType: to.Ptr("Email"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("zwcvuxxxx.database.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.041Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:44.358Z"); return t}()),
	// 			ResourceType: to.Ptr("SQLDatabase"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 	}},
	// 	DNSServers: []*string{
	// 		to.Ptr("10.82.98.10")},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json
 */
async function apiManagementServiceGetNetworkStatusByLocation() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const locationName = "North Central US";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.networkStatus.listByLocation(
    resourceGroupName,
    serviceName,
    locationName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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
    }
  ]
}

定義

名稱	Description
ConnectivityStatusContract	資源連線的詳細數據。
ConnectivityStatusType	資源連線狀態類型標識碼。
ErrorFieldContract	錯誤欄位合約。
ErrorResponse	錯誤回應。
NetworkStatusContract	網路狀態詳細數據。

ConnectivityStatusContract

資源連線的詳細數據。

名稱	類型	Description
error	string	資源連線的錯誤詳細數據。
isOptional	boolean	這是否為選擇性。
lastStatusChange	string	資源連線狀態上次從成功變更為失敗的日期，反之亦然。日期符合下列格式： `yyyy-MM-ddTHH:mm:ssZ` 如 ISO 8601 標準所指定。
lastUpdated	string	上次更新資源連線狀態的日期。此狀態應該每隔 15 分鐘更新一次。如果此狀態尚未更新，則表示服務已從虛擬網路內遺失與資源的網路連線。日期符合下列格式：`yyyy-MM-ddTHH:mm:ssZ`如 ISO 8601 標準所指定。
name	string	服務相依之資源的主機名。這可以是資料庫、記憶體或任何其他服務相依的 Azure 資源。
resourceType	string	資源類型。
status	ConnectivityStatusType	資源連線狀態類型標識碼。

ConnectivityStatusType

資源連線狀態類型標識碼。

名稱	類型	Description
failure	string
initializing	string
success	string

ErrorFieldContract

錯誤欄位合約。

名稱	類型	Description
code	string	屬性層級錯誤碼。
message	string	人類可讀取的屬性層級錯誤表示法。
target	string	屬性名稱。

ErrorResponse

錯誤回應。

名稱	類型	Description
error.code	string	服務定義的錯誤碼。此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。
error.details	ErrorFieldContract[]	要求中傳送無效欄位的清單，以防發生驗證錯誤。
error.message	string	人類可閱讀的錯誤表示法。

NetworkStatusContract

網路狀態詳細數據。

名稱	類型	Description
connectivityStatus	ConnectivityStatusContract[]	取得服務相依之資源的連線狀態清單。
dnsServers	string[]	取得 DNS 伺服器 IPV4 位址的清單。

Share via

Network Status - List By Location

URI 參數

回應

安全性

azure_auth

Scopes

範例

ApiManagementServiceGetNetworkStatusByLocation

Sample Request

Sample Response

定義

ConnectivityStatusContract

ConnectivityStatusType

ErrorFieldContract

ErrorResponse

NetworkStatusContract

其他資源