Perform Connectivity Check Async - Perform Connectivity Check Async

Service:

API Management

API Version:

2024-05-01

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.

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

URI Parameters

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

Request Body

Name	Required	Type	Description
destination	True	Destination	The connectivity check operation destination.
source	True	Source	Definitions about the connectivity check origin.
preferredIPVersion		PreferredIPVersion	The IP version to be used. Only IPv4 is supported for now.
protocol		ConnectivityCheckProtocol	The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.
protocolConfiguration		ProtocolConfiguration	Protocol-specific configuration.

Responses

Name	Type	Description
200 OK	ConnectivityCheckResponse	Connectivity Check Request was completed.
202 Accepted		Request was accepted and is currently running. Location header contains the URL where the status of the long running operation can be checked and the result eventually retrieved. Headers location: string
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

HTTP Connectivity Check

TCP Connectivity Check

HTTP Connectivity Check

Sample request

HTTP

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

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

Java

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/2024-05-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("Bearer myPreciousToken"))))),
            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

Python

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="00000000-0000-0000-0000-000000000000",
    )

    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": "Bearer myPreciousToken"}],
                    "method": "GET",
                    "validStatusCodes": [200, 204],
                }
            },
            "source": {"region": "northeurope"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-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

Go

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-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("Bearer myPreciousToken"),
					}},
				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/00000000-0000-0000-0000-000000000000/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

JavaScript

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

/**
 * 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/2024-05-01/examples/ApiManagementPerformConnectivityCheckHttpConnect.json
 */
async function httpConnectivityCheck() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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: "Bearer myPreciousToken" }],
        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

dotnet

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.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-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 = "00000000-0000-0000-0000-000000000000";
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", 3306L))
{
    Protocol = ConnectivityCheckProtocol.Https,
    ProtocolHttpConfiguration = new ConnectivityCheckRequestHttpConfiguration
    {
        Method = HttpMethodConfiguration.Get,
        ValidStatusCodes = { 200L, 204L },
        Headers = { new HttpHeaderConfiguration("Authorization", "Bearer myPreciousToken") },
    },
};
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

Sample response

Status code:

202

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

Status code:

200

{
  "hops": [
    {
      "type": "Source",
      "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2",
      "address": "20.82.216.48",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/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

Sample request

HTTP

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

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

Java

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/2024-05-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

Python

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="00000000-0000-0000-0000-000000000000",
    )

    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/2024-05-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

Go

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-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/00000000-0000-0000-0000-000000000000/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

JavaScript

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

/**
 * 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/2024-05-01/examples/ApiManagementPerformConnectivityCheck.json
 */
async function tcpConnectivityCheck() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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

dotnet

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.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-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 = "00000000-0000-0000-0000-000000000000";
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", 53L))
{
    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

Sample response

Status code:

202

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

Status code:

200

{
  "hops": [
    {
      "type": "Source",
      "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
      "address": "10.1.1.4",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/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
}

Definitions

Name	Description
ConnectionStatus	The connection status.
ConnectivityCheckProtocol	The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.
ConnectivityCheckRequest	A request to perform the connectivity check operation on a API Management service.
ConnectivityCheckResponse	Information on the connectivity status.
ConnectivityHop	Information about a hop between the source and the destination.
ConnectivityIssue	Information about an issue encountered in the process of checking for connectivity.
Destination	The connectivity check operation destination.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HTTPConfiguration	Configuration for HTTP or HTTPS requests.
HTTPHeader	HTTP header and it's value.
IssueType	The type of issue.
Method	The HTTP method to be used.
Origin	The origin of the issue.
PreferredIPVersion	The IP version to be used. Only IPv4 is supported for now.
ProtocolConfiguration	Protocol-specific configuration.
Severity	The severity of the issue.
Source	Definitions about the connectivity check origin.

ConnectionStatus

Enumeration

The connection status.

Value	Description
Unknown
Connected
Disconnected
Degraded

ConnectivityCheckProtocol

Enumeration

The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.

Value	Description
TCP
HTTP
HTTPS

ConnectivityCheckRequest

Object

A request to perform the connectivity check operation on a API Management service.

Name	Type	Description
destination	Destination	The connectivity check operation destination.
preferredIPVersion	PreferredIPVersion	The IP version to be used. Only IPv4 is supported for now.
protocol	ConnectivityCheckProtocol	The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.
protocolConfiguration	ProtocolConfiguration	Protocol-specific configuration.
source	Source	Definitions about the connectivity check origin.

ConnectivityCheckResponse

Object

Information on the connectivity status.

Name	Type	Description
avgLatencyInMs	integer (int64)	Average latency in milliseconds.
connectionStatus	ConnectionStatus	The connection status.
hops	ConnectivityHop[]	List of hops between the source and the destination.
maxLatencyInMs	integer (int64)	Maximum latency in milliseconds.
minLatencyInMs	integer (int64)	Minimum latency in milliseconds.
probesFailed	integer (int64)	Number of failed probes.
probesSent	integer (int64)	Total number of probes sent.

ConnectivityHop

Object

Information about a hop between the source and the destination.

Name	Type	Description
address	string	The IP address of the hop.
id	string	The ID of the hop.
issues	ConnectivityIssue[]	List of issues.
nextHopIds	string[]	List of next hop identifiers.
resourceId	string	The ID of the resource corresponding to this hop.
type	string	The type of the hop.

ConnectivityIssue

Object

Information about an issue encountered in the process of checking for connectivity.

Name	Type	Description
context	object[]	Provides additional context on the issue.
origin	Origin	The origin of the issue.
severity	Severity	The severity of the issue.
type	IssueType	The type of issue.

Destination

Object

The connectivity check operation destination.

Name	Type	Description
address	string	Destination address. Can either be an IP address or a FQDN.
port	integer (int64)	Destination port.

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HTTPConfiguration

Object

Configuration for HTTP or HTTPS requests.

Name	Type	Description
headers	HTTPHeader[]	List of headers to be included in the request.
method	Method	The HTTP method to be used.
validStatusCodes	integer[] (int64)	List of HTTP status codes considered valid for the request response.

HTTPHeader

Object

HTTP header and it's value.

Name	Type	Description
name	string	Header name.
value	string	Header value.

IssueType

Enumeration

The type of issue.

Value	Description
Unknown
AgentStopped
GuestFirewall
DnsResolution
SocketBind
NetworkSecurityRule
UserDefinedRoute
PortThrottled
Platform

Method

Enumeration

The HTTP method to be used.

Value	Description
GET
POST

Origin

Enumeration

The origin of the issue.

Value	Description
Local
Inbound
Outbound

PreferredIPVersion

Enumeration

The IP version to be used. Only IPv4 is supported for now.

Value	Description
IPv4

ProtocolConfiguration

Object

Protocol-specific configuration.

Name	Type	Description
HTTPConfiguration	HTTPConfiguration	Configuration for HTTP or HTTPS requests.

Severity

Enumeration

The severity of the issue.

Value	Description
Error
Warning

Source

Object

Definitions about the connectivity check origin.

Name	Type	Description
instance	integer (int64)	The particular VMSS instance from which to fire the request.
region	string	The API Management service region from where to start the connectivity check operation.