Share via


NetworkWatcherResource.CheckConnectivity Method

Definition

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck
  • Operation Id: NetworkWatchers_CheckConnectivity
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.ConnectivityInformation> CheckConnectivity (Azure.WaitUntil waitUntil, Azure.ResourceManager.Network.Models.ConnectivityContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member CheckConnectivity : Azure.WaitUntil * Azure.ResourceManager.Network.Models.ConnectivityContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.ConnectivityInformation>
override this.CheckConnectivity : Azure.WaitUntil * Azure.ResourceManager.Network.Models.ConnectivityContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.ConnectivityInformation>
Public Overridable Function CheckConnectivity (waitUntil As WaitUntil, content As ConnectivityContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of ConnectivityInformation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

content
ConnectivityContent

Parameters that determine how the connectivity check will be performed.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to