Network Watchers - Check Connectivity

Service:

Network Watcher

API Version:

2023-09-01

Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
networkWatcherName	path	True	string	The name of the network watcher resource.
resourceGroupName	path	True	string	The name of the network watcher resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Request Body

Name	Required	Type	Description
destination	True	ConnectivityDestination	The destination of connection.
source	True	ConnectivitySource	The source of the connection.
preferredIPVersion		IPVersion	Preferred IP version of the connection.
protocol		Protocol	Network protocol.
protocolConfiguration		ProtocolConfiguration	Configuration of the protocol.

Responses

Name	Type	Description
200 OK	ConnectivityInformation	Successful request for checking connectivity.
202 Accepted	ConnectivityInformation	Accepted and the operation will complete asynchronously.
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

Check connectivity

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectivityCheck?api-version=2023-09-01

{
  "source": {
    "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"
  },
  "destination": {
    "address": "192.168.100.4",
    "port": 3389
  },
  "preferredIPVersion": "IPv4"
}

Java

import com.azure.resourcemanager.network.models.ConnectivityDestination;
import com.azure.resourcemanager.network.models.ConnectivityParameters;
import com.azure.resourcemanager.network.models.ConnectivitySource;
import com.azure.resourcemanager.network.models.IpVersion;

/**
 * Samples for NetworkWatchers CheckConnectivity.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * NetworkWatcherConnectivityCheck.json
     */
    /**
     * Sample code: Check connectivity.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkConnectivity(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkWatchers().checkConnectivity("rg1", "nw1",
            new ConnectivityParameters()
                .withSource(new ConnectivitySource().withResourceId(
                    "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"))
                .withDestination(new ConnectivityDestination().withAddress("192.168.100.4").withPort(3389))
                .withPreferredIpVersion(IpVersion.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.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_watcher_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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.network_watchers.begin_check_connectivity(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        parameters={
            "destination": {"address": "192.168.100.4", "port": 3389},
            "preferredIPVersion": "IPv4",
            "source": {
                "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherConnectivityCheck.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 armnetwork_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/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherConnectivityCheck.json
func ExampleWatchersClient_BeginCheckConnectivity() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWatchersClient().BeginCheckConnectivity(ctx, "rg1", "nw1", armnetwork.ConnectivityParameters{
		Destination: &armnetwork.ConnectivityDestination{
			Address: to.Ptr("192.168.100.4"),
			Port:    to.Ptr[int32](3389),
		},
		PreferredIPVersion: to.Ptr(armnetwork.IPVersionIPv4),
		Source: &armnetwork.ConnectivitySource{
			ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
		},
	}, 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.ConnectivityInformation = armnetwork.ConnectivityInformation{
	// 	AvgLatencyInMs: to.Ptr[int32](1),
	// 	ConnectionStatus: to.Ptr(armnetwork.ConnectionStatusConnected),
	// 	Hops: []*armnetwork.ConnectivityHop{
	// 		{
	// 			Type: to.Ptr("Source"),
	// 			Address: to.Ptr("10.1.1.4"),
	// 			ID: to.Ptr("7dbbe7aa-60ba-4650-831e-63d775d38e9e"),
	// 			Issues: []*armnetwork.ConnectivityIssue{
	// 			},
	// 			NextHopIDs: []*string{
	// 				to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9")},
	// 				ResourceID: to.Ptr("subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1"),
	// 			},
	// 			{
	// 				Type: to.Ptr("VirtualNetwork"),
	// 				Address: to.Ptr("192.168.100.4"),
	// 				ID: to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9"),
	// 				Issues: []*armnetwork.ConnectivityIssue{
	// 				},
	// 				NextHopIDs: []*string{
	// 				},
	// 				ResourceID: to.Ptr("subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1"),
	// 		}},
	// 		MaxLatencyInMs: to.Ptr[int32](4),
	// 		MinLatencyInMs: to.Ptr[int32](1),
	// 		ProbesFailed: to.Ptr[int32](0),
	// 		ProbesSent: to.Ptr[int32](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 { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.
 *
 * @summary Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherConnectivityCheck.json
 */
async function checkConnectivity() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const parameters = {
    destination: { address: "192.168.100.4", port: 3389 },
    preferredIPVersion: "IPv4",
    source: {
      resourceId:
        "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkWatchers.beginCheckConnectivityAndWait(
    resourceGroupName,
    networkWatcherName,
    parameters,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherConnectivityCheck.json
// this example is just showing the usage of "NetworkWatchers_CheckConnectivity" 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 NetworkWatcherResource created on azure
// for more information of creating NetworkWatcherResource, please refer to the document of NetworkWatcherResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
ResourceIdentifier networkWatcherResourceId = NetworkWatcherResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName);
NetworkWatcherResource networkWatcher = client.GetNetworkWatcherResource(networkWatcherResourceId);

// invoke the operation
ConnectivityContent content = new ConnectivityContent(new ConnectivitySource(new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1")), new ConnectivityDestination()
{
    Address = "192.168.100.4",
    Port = 3389,
})
{
    PreferredIPVersion = NetworkIPVersion.IPv4,
};
ArmOperation<ConnectivityInformation> lro = await networkWatcher.CheckConnectivityAsync(WaitUntil.Completed, content);
ConnectivityInformation 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:

200

{
  "hops": [
    {
      "type": "Source",
      "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
      "address": "10.1.1.4",
      "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1",
      "nextHopIds": [
        "75c8d819-b208-4584-a311-1aa45ce753f9"
      ],
      "issues": []
    },
    {
      "type": "VirtualNetwork",
      "id": "75c8d819-b208-4584-a311-1aa45ce753f9",
      "address": "192.168.100.4",
      "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Connected",
  "avgLatencyInMs": 1,
  "minLatencyInMs": 1,
  "maxLatencyInMs": 4,
  "probesSent": 100,
  "probesFailed": 0
}

Status code:

202

Location: https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectivityCheck?api-version=2023-09-01

Response Body

{
  "hops": [
    {
      "type": "Source",
      "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
      "address": "10.1.1.4",
      "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1",
      "nextHopIds": [
        "75c8d819-b208-4584-a311-1aa45ce753f9"
      ],
      "issues": []
    },
    {
      "type": "VirtualNetwork",
      "id": "75c8d819-b208-4584-a311-1aa45ce753f9",
      "address": "192.168.100.4",
      "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Connected",
  "avgLatencyInMs": 1,
  "minLatencyInMs": 1,
  "maxLatencyInMs": 4,
  "probesSent": 100,
  "probesFailed": 0
}

Definitions

Name	Description
ConnectionStatus	The connection status.
ConnectivityDestination	Parameters that define destination of connection.
ConnectivityHop	Information about a hop between the source and the destination.
ConnectivityInformation	Information on the connectivity status.
ConnectivityIssue	Information about an issue encountered in the process of checking for connectivity.
ConnectivityParameters	Parameters that determine how the connectivity check will be performed.
ConnectivitySource	Parameters that define the source of the connection.
ErrorDetails	Common error details representation.
ErrorResponse	The error object.
HopLink	Hop link.
HTTPConfiguration	HTTP configuration of the connectivity check.
HTTPHeader	The HTTP header.
HTTPMethod	HTTP method.
IPVersion	IP address version.
IssueType	The type of issue.
Origin	The origin of the issue.
Protocol	Network protocol.
ProtocolConfiguration	Configuration of the protocol.
Severity	The severity of the issue.

ConnectionStatus

The connection status.

Name	Type	Description
Connected	string
Degraded	string
Disconnected	string
Unknown	string

ConnectivityDestination

Parameters that define destination of connection.

Name	Type	Description
address	string	The IP address or URI the resource to which a connection attempt will be made.
port	integer	Port on which check connectivity will be performed.
resourceId	string	The ID of the resource to which a connection attempt will be made.

ConnectivityHop

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.
links	HopLink[]	List of hop links.
nextHopIds	string[]	List of next hop identifiers.
previousHopIds	string[]	List of previous hop identifiers.
previousLinks	HopLink[]	List of previous hop links.
resourceId	string	The ID of the resource corresponding to this hop.
type	string	The type of the hop.

ConnectivityInformation

Information on the connectivity status.

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

ConnectivityIssue

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.

ConnectivityParameters

Parameters that determine how the connectivity check will be performed.

Name	Type	Description
destination	ConnectivityDestination	The destination of connection.
preferredIPVersion	IPVersion	Preferred IP version of the connection.
protocol	Protocol	Network protocol.
protocolConfiguration	ProtocolConfiguration	Configuration of the protocol.
source	ConnectivitySource	The source of the connection.

ConnectivitySource

Parameters that define the source of the connection.

Name	Type	Description
port	integer	The source port from which a connectivity check will be performed.
resourceId	string	The ID of the resource from which a connectivity check will be initiated.

ErrorDetails

Common error details representation.

Name	Type	Description
code	string	Error code.
message	string	Error message.
target	string	Error target.

ErrorResponse

The error object.

Name	Type	Description
error	ErrorDetails	Error The error details object.

HopLink

Hop link.

Name	Type	Description
context	object	Provides additional context on links.
issues	ConnectivityIssue[]	List of issues.
linkType	string	Link type.
nextHopId	string	The ID of the next hop.
properties.roundTripTimeAvg	integer	Average roundtrip time in milliseconds.
properties.roundTripTimeMax	integer	Maximum roundtrip time in milliseconds.
properties.roundTripTimeMin	integer	Minimum roundtrip time in milliseconds.
resourceId	string	Resource ID.

HTTPConfiguration

HTTP configuration of the connectivity check.

Name	Type	Description
headers	HTTPHeader[]	List of HTTP headers.
method	HTTPMethod	HTTP method.
validStatusCodes	integer[]	Valid status codes.

HTTPHeader

The HTTP header.

Name	Type	Description
name	string	The name in HTTP header.
value	string	The value in HTTP header.

HTTPMethod

HTTP method.

Name	Type	Description
Get	string

IPVersion

IP address version.

Name	Type	Description
IPv4	string
IPv6	string

IssueType

The type of issue.

Name	Type	Description
AgentStopped	string
DnsResolution	string
GuestFirewall	string
NetworkSecurityRule	string
Platform	string
PortThrottled	string
SocketBind	string
Unknown	string
UserDefinedRoute	string

Origin

The origin of the issue.

Name	Type	Description
Inbound	string
Local	string
Outbound	string

Protocol

Network protocol.

Name	Type	Description
Http	string
Https	string
Icmp	string
Tcp	string

ProtocolConfiguration

Configuration of the protocol.

Name	Type	Description
HTTPConfiguration	HTTPConfiguration	HTTP configuration of the connectivity check.

Severity

The severity of the issue.

Name	Type	Description
Error	string
Warning	string