KeyVaultEkmClient.CheckEkmConnectionAsync(CancellationToken) Method

Definition

The External Key Manager (EKM) Check operation verifies connectivity and authentication with the EKM proxy. This operation requires ekm/read permission.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.EkmProxyInfo>> CheckEkmConnectionAsync(System.Threading.CancellationToken cancellationToken = default);
abstract member CheckEkmConnectionAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.EkmProxyInfo>>
override this.CheckEkmConnectionAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.EkmProxyInfo>>
Public Overridable Function CheckEkmConnectionAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EkmProxyInfo))

Parameters

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

Service returned a non-success status code.

Applies to