KeyVaultEkmClient.CreateEkmConnectionAsync Method

Definition

Sets up the External Key Manager (EKM) connection. If the EKM connection already exists, this operation fails. This operation requires ekm/write permission.

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

Parameters

ekmConnection
KeyVaultEkmConnection

The EKM connection to create.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

ekmConnection is null.

Service returned a non-success status code.

Applies to