ApiManagementClient.BeginPerformConnectivityCheckAsyncWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

Microsoft.Azure.Management.ApiManagement v8.0.0-preview

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.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.ConnectivityCheckResponse>> BeginPerformConnectivityCheckAsyncWithHttpMessagesAsync (string resourceGroupName, string serviceName, Microsoft.Azure.Management.ApiManagement.Models.ConnectivityCheckRequest connectivityCheckRequestParams, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BeginPerformConnectivityCheckAsyncWithHttpMessagesAsync : string * string * Microsoft.Azure.Management.ApiManagement.Models.ConnectivityCheckRequest * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.ConnectivityCheckResponse>>
override this.BeginPerformConnectivityCheckAsyncWithHttpMessagesAsync : string * string * Microsoft.Azure.Management.ApiManagement.Models.ConnectivityCheckRequest * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.ConnectivityCheckResponse>>

Public Function BeginPerformConnectivityCheckAsyncWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, connectivityCheckRequestParams As ConnectivityCheckRequest, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of ConnectivityCheckResponse))

Parameters

resourceGroupName

String

The name of the resource group.

serviceName

String

The name of the API Management service.

connectivityCheckRequestParams

ConnectivityCheckRequest

Connectivity Check request parameters.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ConnectivityCheckResponse>>

Implements

BeginPerformConnectivityCheckAsyncWithHttpMessagesAsync(String, String, ConnectivityCheckRequest, Dictionary<String,List<String>>, CancellationToken)

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null