KeyVaultEkmClient.CheckEkmConnection(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 Azure.Response<Azure.Security.KeyVault.Administration.EkmProxyInfo> CheckEkmConnection(System.Threading.CancellationToken cancellationToken = default);
abstract member CheckEkmConnection : System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Administration.EkmProxyInfo>
override this.CheckEkmConnection : System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Administration.EkmProxyInfo>
Public Overridable Function CheckEkmConnection (Optional cancellationToken As CancellationToken = Nothing) As Response(Of EkmProxyInfo)

Parameters

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

Service returned a non-success status code.

Applies to