Share via


ApiManagementServiceResource.PerformConnectivityCheckAsync Method

Definition

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck
  • Operation Id: PerformConnectivityCheckAsync
  • Default Api Version: 2023-03-01-preview
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.Models.ConnectivityCheckResult> PerformConnectivityCheckAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.ApiManagement.Models.ConnectivityCheckContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member PerformConnectivityCheckAsync : Azure.WaitUntil * Azure.ResourceManager.ApiManagement.Models.ConnectivityCheckContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.Models.ConnectivityCheckResult>
override this.PerformConnectivityCheckAsync : Azure.WaitUntil * Azure.ResourceManager.ApiManagement.Models.ConnectivityCheckContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.Models.ConnectivityCheckResult>
Public Overridable Function PerformConnectivityCheckAsync (waitUntil As WaitUntil, content As ConnectivityCheckContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of ConnectivityCheckResult)

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
ConnectivityCheckContent

Connectivity Check request parameters.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to