Lingua

KeyVaultEkmClient Class

Definition

The KeyVaultEkmClient.

public class KeyVaultEkmClient : IDisposable
type KeyVaultEkmClient = class
    interface IDisposable
Public Class KeyVaultEkmClient
Implements IDisposable
Inheritance
KeyVaultEkmClient
Implements

Constructors

Name Description
KeyVaultEkmClient()

Initializes a new instance of KeyVaultEkmClient for mocking.

KeyVaultEkmClient(KeyVaultEkmClientSettings)

Initializes a new instance of KeyVaultEkmClient from a KeyVaultEkmClientSettings.

KeyVaultEkmClient(Uri, TokenCredential, KeyVaultAdministrationClientOptions)

Initializes a new instance of KeyVaultEkmClient.

KeyVaultEkmClient(Uri, TokenCredential)

Initializes a new instance of KeyVaultEkmClient.

Properties

Name Description
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

VaultUri

Gets the vault URI.

Methods

Name Description
CheckEkmConnection(CancellationToken)

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

CheckEkmConnectionAsync(CancellationToken)

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

CreateEkmConnection(KeyVaultEkmConnection, CancellationToken)

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

CreateEkmConnectionAsync(KeyVaultEkmConnection, CancellationToken)

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

CreateEkmPrivateEndpoint(WaitUntil, String, String, String, CancellationToken)

Creates an External Key Manager (EKM) proxy private endpoint. A pool may have up to two private endpoints. This operation requires ekm/write permission. Only available with service version V2026_07_01_Preview and newer.

CreateEkmPrivateEndpointAsync(WaitUntil, String, String, String, CancellationToken)

Creates an External Key Manager (EKM) proxy private endpoint. A pool may have up to two private endpoints. This operation requires ekm/write permission. Only available with service version V2026_07_01_Preview and newer.

DeleteEkmConnection(CancellationToken)

Deletes the existing External Key Manager (EKM) connection. If the EKM connection does not exist, this operation fails. This operation requires ekm/delete permission.

DeleteEkmConnectionAsync(CancellationToken)

Deletes the existing External Key Manager (EKM) connection. If the EKM connection does not exist, this operation fails. This operation requires ekm/delete permission.

DeleteEkmPrivateEndpoint(WaitUntil, String, CancellationToken)

Deletes an existing External Key Manager (EKM) proxy private endpoint. The operation is rejected while an EKM connection still references the private endpoint. This operation requires ekm/write permission. Only available with service version V2026_07_01_Preview and newer.

DeleteEkmPrivateEndpointAsync(WaitUntil, String, CancellationToken)

Deletes an existing External Key Manager (EKM) proxy private endpoint. The operation is rejected while an EKM connection still references the private endpoint. This operation requires ekm/write permission. Only available with service version V2026_07_01_Preview and newer.

Dispose()

Releases the HTTP pipeline resources owned by this client.

GetEkmCertificate(CancellationToken)

The External Key Manager (EKM) Certificate Get operation returns the proxy client certificate. This operation requires ekm/read permission.

GetEkmCertificateAsync(CancellationToken)

The External Key Manager (EKM) Certificate Get operation returns the proxy client certificate. This operation requires ekm/read permission.

GetEkmConnection(CancellationToken)

The External Key Manager (EKM) Get operation returns the EKM connection. This operation requires ekm/read permission.

GetEkmConnectionAsync(CancellationToken)

The External Key Manager (EKM) Get operation returns the EKM connection. This operation requires ekm/read permission.

GetEkmPrivateEndpoint(String, CancellationToken)

Gets an existing External Key Manager (EKM) proxy private endpoint. This operation requires ekm/read permission. Only available with service version V2026_07_01_Preview and newer.

GetEkmPrivateEndpointAsync(String, CancellationToken)

Gets an existing External Key Manager (EKM) proxy private endpoint. This operation requires ekm/read permission. Only available with service version V2026_07_01_Preview and newer.

GetEkmPrivateEndpointOperationStatus(String, CancellationToken)

Gets the status of an External Key Manager (EKM) proxy private endpoint create or delete operation. This operation requires ekm/read permission. Only available with service version V2026_07_01_Preview and newer.

GetEkmPrivateEndpointOperationStatusAsync(String, CancellationToken)

Gets the status of an External Key Manager (EKM) proxy private endpoint create or delete operation. This operation requires ekm/read permission. Only available with service version V2026_07_01_Preview and newer.

GetEkmPrivateEndpoints(CancellationToken)

Lists all External Key Manager (EKM) proxy private endpoints on the pool. This operation requires ekm/read permission. Only available with service version V2026_07_01_Preview and newer.

GetEkmPrivateEndpointsAsync(CancellationToken)

Lists all External Key Manager (EKM) proxy private endpoints on the pool. This operation requires ekm/read permission. Only available with service version V2026_07_01_Preview and newer.

UpdateEkmConnection(KeyVaultEkmConnection, CancellationToken)

Updates the existing External Key Manager (EKM) connection. If the EKM connection does not exist, this operation fails. This operation requires ekm/write permission.

UpdateEkmConnectionAsync(KeyVaultEkmConnection, CancellationToken)

Updates the existing External Key Manager (EKM) connection. If the EKM connection does not exist, this operation fails. This operation requires ekm/write permission.

Applies to