KeyVaultEkmClient Class

Definition

Namespace:

Azure.Security.KeyVault.Administration

Assembly:

Azure.Security.KeyVault.Administration.dll

Package:

Azure.Security.KeyVault.Administration v4.9.0-beta.1

Source:

KeyVaultEkmClient.cs

The KeyVaultEkmClient.

public class KeyVaultEkmClient

type KeyVaultEkmClient = class

Public Class KeyVaultEkmClient

Inheritance

Object

KeyVaultEkmClient

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.
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.
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.
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.