Network Watchers - Check Connectivity

Service:

Network Watcher

API Version:

2023-09-01

Überprüft die Möglichkeit, eine direkte TCP-Verbindung zwischen einem virtuellen Computer und einem angegebenen Endpunkt herzustellen, einschließlich mit anderen VMs oder einem freien Remoteserver.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkWatcherName	path	True	string	Der Name der Network Watcher-Ressource.
resourceGroupName	path	True	string	Der Name der Network Watcher-Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
destination	True	ConnectivityDestination	Das Ziel der Verbindung.
source	True	ConnectivitySource	Die Quelle der Verbindung.
preferredIPVersion		IPVersion	Bevorzugte IP-Version der Verbindung.
protocol		Protocol	Netzwerkprotokoll.
protocolConfiguration		ProtocolConfiguration	Konfiguration des Protokolls.

Antworten

Name	Typ	Beschreibung
200 OK	ConnectivityInformation	Erfolgreiche Anforderung zum Überprüfen der Konnektivität.
202 Accepted	ConnectivityInformation	Akzeptiert, und der Vorgang wird asynchron abgeschlossen.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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
}

Definitionen

Name	Beschreibung
ConnectionStatus	Die Verbindung status.
ConnectivityDestination	Parameter, die das Verbindungsziel definieren.
ConnectivityHop	Informationen zu einem Hop zwischen der Quelle und dem Ziel.
ConnectivityInformation	Informationen zur konnektivitäts-status.
ConnectivityIssue	Informationen zu einem Problem, das bei der Überprüfung auf Konnektivität aufgetreten ist.
ConnectivityParameters	Parameter, die bestimmen, wie die Konnektivitätsprüfung ausgeführt wird.
ConnectivitySource	Parameter, die die Quelle der Verbindung definieren.
ErrorDetails	Allgemeine Darstellung von Fehlerdetails.
ErrorResponse	Das Fehlerobjekt.
HopLink	Hoplink.
HTTPConfiguration	HTTP-Konfiguration der Konnektivitätsprüfung.
HTTPHeader	Der HTTP-Header.
HTTPMethod	HTTP-Methode.
IPVersion	IP-Adressversion.
IssueType	Der Typ des Problems.
Origin	Der Ursprung des Problems.
Protocol	Netzwerkprotokoll.
ProtocolConfiguration	Konfiguration des Protokolls.
Severity	Der Schweregrad des Problems.

ConnectionStatus

Die Verbindung status.

Name	Typ	Beschreibung
Connected	string
Degraded	string
Disconnected	string
Unknown	string

ConnectivityDestination

Parameter, die das Verbindungsziel definieren.

Name	Typ	Beschreibung
address	string	Die IP-Adresse oder der URI der Ressource, mit der eine Verbindung versucht wird.
port	integer	Port, an dem die Konnektivität überprüft wird.
resourceId	string	Die ID der Ressource, mit der eine Verbindung versucht wird.

ConnectivityHop

Informationen zu einem Hop zwischen der Quelle und dem Ziel.

Name	Typ	Beschreibung
address	string	Die IP-Adresse des Hops.
id	string	Die ID des Hops.
issues	ConnectivityIssue[]	Liste der Probleme.
links	HopLink[]	Liste der Hoplinks.
nextHopIds	string[]	Liste der Bezeichner des nächsten Hops.
previousHopIds	string[]	Liste der vorherigen Hopbezeichner.
previousLinks	HopLink[]	Liste der vorherigen Hoplinks.
resourceId	string	Die ID der Ressource, die diesem Hop entspricht.
type	string	Der Typ des Hops.

ConnectivityInformation

Informationen zur konnektivitäts-status.

Name	Typ	Beschreibung
avgLatencyInMs	integer	Durchschnittliche Latenz in Millisekunden.
connectionStatus	ConnectionStatus	Die Verbindung status.
hops	ConnectivityHop[]	Liste der Hops zwischen Quelle und Ziel.
maxLatencyInMs	integer	Maximale Latenz in Millisekunden.
minLatencyInMs	integer	Minimale Latenz in Millisekunden.
probesFailed	integer	Anzahl fehlerhafter Tests.
probesSent	integer	Gesamtzahl der gesendeten Tests.

ConnectivityIssue

Informationen zu einem Problem, das bei der Überprüfung auf Konnektivität aufgetreten ist.

Name	Typ	Beschreibung
context	object[]	Stellt zusätzlichen Kontext für das Problem bereit.
origin	Origin	Der Ursprung des Problems.
severity	Severity	Der Schweregrad des Problems.
type	IssueType	Der Typ des Problems.

ConnectivityParameters

Parameter, die bestimmen, wie die Konnektivitätsprüfung ausgeführt wird.

Name	Typ	Beschreibung
destination	ConnectivityDestination	Das Ziel der Verbindung.
preferredIPVersion	IPVersion	Bevorzugte IP-Version der Verbindung.
protocol	Protocol	Netzwerkprotokoll.
protocolConfiguration	ProtocolConfiguration	Konfiguration des Protokolls.
source	ConnectivitySource	Die Quelle der Verbindung.

ConnectivitySource

Parameter, die die Quelle der Verbindung definieren.

Name	Typ	Beschreibung
port	integer	Der Quellport, von dem aus eine Konnektivitätsprüfung durchgeführt wird.
resourceId	string	Die ID der Ressource, von der aus eine Konnektivitätsprüfung initiiert wird.

ErrorDetails

Allgemeine Darstellung von Fehlerdetails.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung.
target	string	Fehlerziel.

ErrorResponse

Das Fehlerobjekt.

Name	Typ	Beschreibung
error	ErrorDetails	Fehler Das Fehlerdetails-Objekt.

HopLink

Hoplink.

Name	Typ	Beschreibung
context	object	Stellt zusätzlichen Kontext für Links bereit.
issues	ConnectivityIssue[]	Liste der Probleme.
linkType	string	Linktyp.
nextHopId	string	Die ID des nächsten Hops.
properties.roundTripTimeAvg	integer	Durchschnittliche Roundtripzeit in Millisekunden.
properties.roundTripTimeMax	integer	Maximale Roundtripzeit in Millisekunden.
properties.roundTripTimeMin	integer	Minimale Roundtripzeit in Millisekunden.
resourceId	string	Ressourcen-ID

HTTPConfiguration

HTTP-Konfiguration der Konnektivitätsprüfung.

Name	Typ	Beschreibung
headers	HTTPHeader[]	Liste der HTTP-Header.
method	HTTPMethod	HTTP-Methode.
validStatusCodes	integer[]	Gültige status Codes.

HTTPHeader

Der HTTP-Header.

Name	Typ	Beschreibung
name	string	Der Name im HTTP-Header.
value	string	Der Wert im HTTP-Header.

HTTPMethod

HTTP-Methode.

Name	Typ	Beschreibung
Get	string

IPVersion

IP-Adressversion.

Name	Typ	Beschreibung
IPv4	string
IPv6	string

IssueType

Der Typ des Problems.

Name	Typ	Beschreibung
AgentStopped	string
DnsResolution	string
GuestFirewall	string
NetworkSecurityRule	string
Platform	string
PortThrottled	string
SocketBind	string
Unknown	string
UserDefinedRoute	string

Origin

Der Ursprung des Problems.

Name	Typ	Beschreibung
Inbound	string
Local	string
Outbound	string

Protocol

Netzwerkprotokoll.

Name	Typ	Beschreibung
Http	string
Https	string
Icmp	string
Tcp	string

ProtocolConfiguration

Konfiguration des Protokolls.

Name	Typ	Beschreibung
HTTPConfiguration	HTTPConfiguration	HTTP-Konfiguration der Konnektivitätsprüfung.

Severity

Der Schweregrad des Problems.

Name	Typ	Beschreibung
Error	string
Warning	string