你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Perform Connectivity Check Async - Perform Connectivity Check Async

参考

服务:: API Management

API 版本:: 2022-08-01

在 API 管理服务和给定目标之间执行连接检查，并返回连接的指标，以及尝试建立连接时遇到的错误。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
destination	True	Destination	连接检查作目标。
source	True	Source	有关连接检查源的定义。
preferredIPVersion		PreferredIPVersion	要使用的 IP 版本。目前仅支持 IPv4。
protocol		ConnectivityCheckProtocol	请求的协议。可以根据此选择使用特定的协议配置。指定的目标地址必须与此值一致。
protocolConfiguration		ProtocolConfiguration	特定于协议的配置。

响应

名称	类型	说明
200 OK	ConnectivityCheckResponse	连接检查请求已完成。
202 Accepted		请求已接受且当前正在运行。位置标头包含 URL，可在其中检查长时间运行作的状态，并最终检索结果。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

HTTP Connectivity Check

TCP Connectivity Check

HTTP Connectivity Check

示例请求

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

{
  "source": {
    "region": "northeurope"
  },
  "destination": {
    "address": "https://microsoft.com",
    "port": 3306
  },
  "protocol": "HTTPS",
  "protocolConfiguration": {
    "HTTPConfiguration": {
      "method": "GET",
      "validStatusCodes": [
        200,
        204
      ],
      "headers": [
        {
          "name": "Authorization",
          "value": "******"
        }
      ]
    }
  }
}


import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckProtocol;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequest;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestDestination;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestProtocolConfiguration;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestProtocolConfigurationHttpConfiguration;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestSource;
import com.azure.resourcemanager.apimanagement.models.HttpHeader;
import com.azure.resourcemanager.apimanagement.models.Method;
import java.util.Arrays;

/**
 * Samples for ResourceProvider PerformConnectivityCheckAsync.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/
     * ApiManagementPerformConnectivityCheckHttpConnect.json
     */
    /**
     * Sample code: HTTP Connectivity Check.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void hTTPConnectivityCheck(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.resourceProviders().performConnectivityCheckAsync("rg1", "apimService1",
            new ConnectivityCheckRequest().withSource(new ConnectivityCheckRequestSource().withRegion("northeurope"))
                .withDestination(
                    new ConnectivityCheckRequestDestination().withAddress("https://microsoft.com").withPort(3306L))
                .withProtocol(ConnectivityCheckProtocol.HTTPS)
                .withProtocolConfiguration(new ConnectivityCheckRequestProtocolConfiguration()
                    .withHttpConfiguration(new ConnectivityCheckRequestProtocolConfigurationHttpConfiguration()
                        .withMethod(Method.GET).withValidStatusCodes(Arrays.asList(200L, 204L))
                        .withHeaders(Arrays.asList(new HttpHeader().withName("Authorization").withValue("******"))))),
            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 typing import Any, IO, Union

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_perform_connectivity_check_http_connect.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.begin_perform_connectivity_check_async(
        resource_group_name="rg1",
        service_name="apimService1",
        connectivity_check_request_params={
            "destination": {"address": "https://microsoft.com", "port": 3306},
            "protocol": "HTTPS",
            "protocolConfiguration": {
                "HTTPConfiguration": {
                    "headers": [{"name": "Authorization", "value": "******"}],
                    "method": "GET",
                    "validStatusCodes": [200, 204],
                }
            },
            "source": {"region": "northeurope"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheckHttpConnect.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/azcore/to"
	"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/ApiManagementPerformConnectivityCheckHttpConnect.json
func ExampleClient_BeginPerformConnectivityCheckAsync_httpConnectivityCheck() {
	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)
	}
	poller, err := clientFactory.NewClient().BeginPerformConnectivityCheckAsync(ctx, "rg1", "apimService1", armapimanagement.ConnectivityCheckRequest{
		Destination: &armapimanagement.ConnectivityCheckRequestDestination{
			Address: to.Ptr("https://microsoft.com"),
			Port:    to.Ptr[int64](3306),
		},
		ProtocolConfiguration: &armapimanagement.ConnectivityCheckRequestProtocolConfiguration{
			HTTPConfiguration: &armapimanagement.ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration{
				Method: to.Ptr(armapimanagement.MethodGET),
				Headers: []*armapimanagement.HTTPHeader{
					{
						Name:  to.Ptr("Authorization"),
						Value: to.Ptr("******"),
					}},
				ValidStatusCodes: []*int64{
					to.Ptr[int64](200),
					to.Ptr[int64](204)},
			},
		},
		Source: &armapimanagement.ConnectivityCheckRequestSource{
			Region: to.Ptr("northeurope"),
		},
		Protocol: to.Ptr(armapimanagement.ConnectivityCheckProtocolHTTPS),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.ConnectivityCheckResponse = armapimanagement.ConnectivityCheckResponse{
	// 	AvgLatencyInMs: to.Ptr[int64](260),
	// 	ConnectionStatus: to.Ptr(armapimanagement.ConnectionStatus("Reachable")),
	// 	Hops: []*armapimanagement.ConnectivityHop{
	// 		{
	// 			Type: to.Ptr("Source"),
	// 			Address: to.Ptr("20.82.216.48"),
	// 			ID: to.Ptr("c60e2296-5ebc-48cc-80e8-7e6d2981e7b2"),
	// 			Issues: []*armapimanagement.ConnectivityIssue{
	// 			},
	// 			NextHopIDs: []*string{
	// 				to.Ptr("26aa44e7-04f1-462f-aa5d-5951957b5650")},
	// 				ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 			},
	// 			{
	// 				Type: to.Ptr("Internet"),
	// 				Address: to.Ptr("40.113.200.201"),
	// 				ID: to.Ptr("26aa44e7-04f1-462f-aa5d-5951957b5650"),
	// 				Issues: []*armapimanagement.ConnectivityIssue{
	// 				},
	// 				NextHopIDs: []*string{
	// 				},
	// 		}},
	// 		MaxLatencyInMs: to.Ptr[int64](281),
	// 		MinLatencyInMs: to.Ptr[int64](250),
	// 		ProbesFailed: to.Ptr[int64](0),
	// 		ProbesSent: to.Ptr[int64](3),
	// 	}
}

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 Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 *
 * @summary Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheckHttpConnect.json
 */
async function httpConnectivityCheck() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const connectivityCheckRequestParams = {
    destination: { address: "https://microsoft.com", port: 3306 },
    protocolConfiguration: {
      httpConfiguration: {
        method: "GET",
        headers: [{ name: "Authorization", value: "******" }],
        validStatusCodes: [200, 204],
      },
    },
    source: { region: "northeurope" },
    protocol: "HTTPS",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.beginPerformConnectivityCheckAsyncAndWait(
    resourceGroupName,
    serviceName,
    connectivityCheckRequestParams
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheckHttpConnect.json
// this example is just showing the usage of "PerformConnectivityCheckAsync" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ConnectivityCheckContent content = new ConnectivityCheckContent(new ConnectivityCheckRequestSource("northeurope"), new ConnectivityCheckRequestDestination("https://microsoft.com", 3306))
{
    Protocol = ConnectivityCheckProtocol.Https,
    ProtocolHttpConfiguration = new ConnectivityCheckRequestHttpConfiguration()
    {
        Method = HttpMethodConfiguration.Get,
        ValidStatusCodes =
        {
        200,204
        },
        Headers =
        {
        new HttpHeaderConfiguration("Authorization","******")
        },
    },
};
ArmOperation<ConnectivityCheckResult> lro = await apiManagementService.PerformConnectivityCheckAsyncAsync(WaitUntil.Completed, content);
ConnectivityCheckResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:: 202

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

状态代码:: 200

{
  "hops": [
    {
      "type": "Source",
      "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2",
      "address": "20.82.216.48",
      "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
      "nextHopIds": [
        "26aa44e7-04f1-462f-aa5d-5951957b5650"
      ],
      "issues": []
    },
    {
      "type": "Internet",
      "id": "26aa44e7-04f1-462f-aa5d-5951957b5650",
      "address": "40.113.200.201",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Reachable",
  "avgLatencyInMs": 260,
  "minLatencyInMs": 250,
  "maxLatencyInMs": 281,
  "probesSent": 3,
  "probesFailed": 0
}

TCP Connectivity Check

示例请求

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

{
  "source": {
    "region": "northeurope"
  },
  "destination": {
    "address": "8.8.8.8",
    "port": 53
  },
  "preferredIPVersion": "IPv4"
}


import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequest;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestDestination;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestSource;
import com.azure.resourcemanager.apimanagement.models.PreferredIpVersion;

/**
 * Samples for ResourceProvider PerformConnectivityCheckAsync.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/
     * ApiManagementPerformConnectivityCheck.json
     */
    /**
     * Sample code: TCP Connectivity Check.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void tCPConnectivityCheck(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.resourceProviders().performConnectivityCheckAsync("rg1", "apimService1",
            new ConnectivityCheckRequest().withSource(new ConnectivityCheckRequestSource().withRegion("northeurope"))
                .withDestination(new ConnectivityCheckRequestDestination().withAddress("8.8.8.8").withPort(53L))
                .withPreferredIpVersion(PreferredIpVersion.IPV4),
            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 typing import Any, IO, Union

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_perform_connectivity_check.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.begin_perform_connectivity_check_async(
        resource_group_name="rg1",
        service_name="apimService1",
        connectivity_check_request_params={
            "destination": {"address": "8.8.8.8", "port": 53},
            "preferredIPVersion": "IPv4",
            "source": {"region": "northeurope"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheck.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/azcore/to"
	"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/ApiManagementPerformConnectivityCheck.json
func ExampleClient_BeginPerformConnectivityCheckAsync_tcpConnectivityCheck() {
	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)
	}
	poller, err := clientFactory.NewClient().BeginPerformConnectivityCheckAsync(ctx, "rg1", "apimService1", armapimanagement.ConnectivityCheckRequest{
		Destination: &armapimanagement.ConnectivityCheckRequestDestination{
			Address: to.Ptr("8.8.8.8"),
			Port:    to.Ptr[int64](53),
		},
		PreferredIPVersion: to.Ptr(armapimanagement.PreferredIPVersionIPv4),
		Source: &armapimanagement.ConnectivityCheckRequestSource{
			Region: to.Ptr("northeurope"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.ConnectivityCheckResponse = armapimanagement.ConnectivityCheckResponse{
	// 	AvgLatencyInMs: to.Ptr[int64](1),
	// 	ConnectionStatus: to.Ptr(armapimanagement.ConnectionStatusConnected),
	// 	Hops: []*armapimanagement.ConnectivityHop{
	// 		{
	// 			Type: to.Ptr("Source"),
	// 			Address: to.Ptr("10.1.1.4"),
	// 			ID: to.Ptr("7dbbe7aa-60ba-4650-831e-63d775d38e9e"),
	// 			Issues: []*armapimanagement.ConnectivityIssue{
	// 			},
	// 			NextHopIDs: []*string{
	// 				to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9")},
	// 				ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 			},
	// 			{
	// 				Type: to.Ptr("Internet"),
	// 				Address: to.Ptr("8.8.8.8"),
	// 				ID: to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9"),
	// 				Issues: []*armapimanagement.ConnectivityIssue{
	// 				},
	// 				NextHopIDs: []*string{
	// 				},
	// 		}},
	// 		MaxLatencyInMs: to.Ptr[int64](4),
	// 		MinLatencyInMs: to.Ptr[int64](1),
	// 		ProbesFailed: to.Ptr[int64](0),
	// 		ProbesSent: to.Ptr[int64](100),
	// 	}
}

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 Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 *
 * @summary Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheck.json
 */
async function tcpConnectivityCheck() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const connectivityCheckRequestParams = {
    destination: { address: "8.8.8.8", port: 53 },
    preferredIPVersion: "IPv4",
    source: { region: "northeurope" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.beginPerformConnectivityCheckAsyncAndWait(
    resourceGroupName,
    serviceName,
    connectivityCheckRequestParams
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheck.json
// this example is just showing the usage of "PerformConnectivityCheckAsync" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ConnectivityCheckContent content = new ConnectivityCheckContent(new ConnectivityCheckRequestSource("northeurope"), new ConnectivityCheckRequestDestination("8.8.8.8", 53))
{
    PreferredIPVersion = PreferredIPVersion.IPv4,
};
ArmOperation<ConnectivityCheckResult> lro = await apiManagementService.PerformConnectivityCheckAsyncAsync(WaitUntil.Completed, content);
ConnectivityCheckResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:: 202

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

状态代码:: 200

{
  "hops": [
    {
      "type": "Source",
      "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
      "address": "10.1.1.4",
      "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
      "nextHopIds": [
        "75c8d819-b208-4584-a311-1aa45ce753f9"
      ],
      "issues": []
    },
    {
      "type": "Internet",
      "id": "75c8d819-b208-4584-a311-1aa45ce753f9",
      "address": "8.8.8.8",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Connected",
  "avgLatencyInMs": 1,
  "minLatencyInMs": 1,
  "maxLatencyInMs": 4,
  "probesSent": 100,
  "probesFailed": 0
}

定义

名称	说明
ConnectionStatus	连接状态。
ConnectivityCheckProtocol	请求的协议。可以根据此选择使用特定的协议配置。指定的目标地址必须与此值一致。
ConnectivityCheckRequest	对 API 管理服务执行连接检查作的请求。
ConnectivityCheckResponse	有关连接状态的信息。
ConnectivityHop	有关源和目标之间的跃点的信息。
ConnectivityIssue	有关在检查连接过程中遇到的问题的信息。
Destination	连接检查作目标。
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应。
HTTPConfiguration	HTTP 或 HTTPS 请求的配置。
HTTPHeader	HTTP 标头及其值。
IssueType	问题的类型。
Method	要使用的 HTTP 方法。
Origin	问题的起源。
PreferredIPVersion	要使用的 IP 版本。目前仅支持 IPv4。
ProtocolConfiguration	特定于协议的配置。
Severity	问题的严重性。
Source	有关连接检查源的定义。

ConnectionStatus

枚举

连接状态。

值	说明
Connected
Degraded
Disconnected
Unknown

ConnectivityCheckProtocol

枚举

请求的协议。可以根据此选择使用特定的协议配置。指定的目标地址必须与此值一致。

值	说明
HTTP
HTTPS
TCP

ConnectivityCheckRequest

Object

对 API 管理服务执行连接检查作的请求。

名称	类型	说明
destination	Destination	连接检查作目标。
preferredIPVersion	PreferredIPVersion	要使用的 IP 版本。目前仅支持 IPv4。
protocol	ConnectivityCheckProtocol	请求的协议。可以根据此选择使用特定的协议配置。指定的目标地址必须与此值一致。
protocolConfiguration	ProtocolConfiguration	特定于协议的配置。
source	Source	有关连接检查源的定义。

ConnectivityCheckResponse

Object

有关连接状态的信息。

名称	类型	说明
avgLatencyInMs	integer (int64)	平均延迟（以毫秒为单位）。
connectionStatus	ConnectionStatus	连接状态。
hops	ConnectivityHop[]	源和目标之间的跃点列表。
maxLatencyInMs	integer (int64)	最大延迟（以毫秒为单位）。
minLatencyInMs	integer (int64)	最小延迟（以毫秒为单位）。
probesFailed	integer (int64)	失败的探测数。
probesSent	integer (int64)	发送的探测总数。

ConnectivityHop

Object

有关源和目标之间的跃点的信息。

名称	类型	说明
address	string	跃点的 IP 地址。
id	string	跃点的 ID。
issues	ConnectivityIssue[]	问题列表。
nextHopIds	string[]	下一跃点标识符的列表。
resourceId	string	与此跃点对应的资源的 ID。
type	string	跃点的类型。

ConnectivityIssue

Object

有关在检查连接过程中遇到的问题的信息。

名称	类型	说明
context	object[]	提供有关此问题的其他上下文。
origin	Origin	问题的起源。
severity	Severity	问题的严重性。
type	IssueType	问题的类型。

Destination

Object

连接检查作目标。

名称	类型	说明
address	string	目标地址。可以是 IP 地址或 FQDN。
port	integer (int64)	目标端口。

ErrorFieldContract

Object

错误字段协定。

名称	类型	说明
code	string	属性级别错误代码。
message	string	属性级错误的人工可读表示形式。
target	string	属性名称。

ErrorResponse

Object

错误响应。

名称	类型	说明
error.code	string	服务定义的错误代码。此代码充当响应中指定的 HTTP 错误代码的子状态。
error.details	ErrorFieldContract[]	请求中发送的无效字段列表（如果出现验证错误）。
error.message	string	错误的人工可读表示形式。

HTTPConfiguration

Object

HTTP 或 HTTPS 请求的配置。

名称	类型	说明
headers	HTTPHeader[]	要包含在请求中的标头列表。
method	Method	要使用的 HTTP 方法。
validStatusCodes	integer[] (int64)	被视为对请求响应有效的 HTTP 状态代码列表。

HTTPHeader

Object

HTTP 标头及其值。

名称	类型	说明
name	string	标头名称。
value	string	标头值。

IssueType

枚举

问题的类型。

值	说明
AgentStopped
DnsResolution
GuestFirewall
NetworkSecurityRule
Platform
PortThrottled
SocketBind
Unknown
UserDefinedRoute

Method

枚举

要使用的 HTTP 方法。

值	说明
GET
POST

Origin

枚举

问题的起源。

值	说明
Inbound
Local
Outbound

PreferredIPVersion

枚举

要使用的 IP 版本。目前仅支持 IPv4。

值	说明
IPv4

ProtocolConfiguration

Object

特定于协议的配置。

名称	类型	说明
HTTPConfiguration	HTTPConfiguration	HTTP 或 HTTPS 请求的配置。

Severity

枚举

问题的严重性。

值	说明
Error
Warning

Source

Object

有关连接检查源的定义。

名称	类型	说明
instance	integer (int64)	要从中触发请求的特定 VMSS 实例。
region	string	从何处启动连接检查作的 API 管理服务区域。

通过

Perform Connectivity Check Async - Perform Connectivity Check Async

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

HTTP Connectivity Check

示例请求

示例响应

TCP Connectivity Check

示例请求

示例响应

定义

ConnectionStatus

ConnectivityCheckProtocol

ConnectivityCheckRequest

ConnectivityCheckResponse

ConnectivityHop

ConnectivityIssue

Destination

ErrorFieldContract

ErrorResponse

HTTPConfiguration

HTTPHeader

IssueType

Method

Origin

PreferredIPVersion

ProtocolConfiguration

Severity

Source