KeyVaultClient Class

Definition

Namespace:

Azure.Connectors.Sdk.KeyVault

Assembly:

Azure.Connectors.Sdk.dll

Package:

Azure.Connectors.Sdk v0.13.0-preview.1

Typed client for keyvault connector.

public class KeyVaultClient : Azure.Connectors.Sdk.ConnectorClientBase

type KeyVaultClient = class
    inherit ConnectorClientBase

Public Class KeyVaultClient
Inherits ConnectorClientBase

Inheritance

Object

ConnectorClientBase

KeyVaultClient

Constructors

Name	Description
KeyVaultClient()
KeyVaultClient(String)	Creates a new KeyVaultClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.
KeyVaultClient(Uri, TokenCredential, ConnectorClientOptions)	Creates a new KeyVaultClient with the specified connection runtime URL and credential.
KeyVaultClient(Uri, TokenCredential)	Creates a new KeyVaultClient with the specified connection runtime URL and credential.
KeyVaultClient(Uri)	Creates a new KeyVaultClient with the specified connection runtime URL. Uses ManagedIdentityCredential by default.

Properties

Name	Description
ConnectorName
Pipeline	Gets the HTTP pipeline for making connector requests. (Inherited from ConnectorClientBase)

Methods

Name	Description
CallConnectorAsync(HttpMethod, String, Object, CancellationToken)	Sends a connector API request with no response body. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
CallConnectorAsync<TResponse>(HttpMethod, String, Object, CancellationToken)	Sends a connector API request and deserializes the JSON response. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
DecryptDataAsync(String, KeyDecryptInput, CancellationToken)	Decrypt data with key
DecryptDataWithVersionAsync(String, String, KeyDecryptInput, CancellationToken)	Decrypt data with key version
Dispose()	(Inherited from ConnectorClientBase)
Dispose(Boolean)	Disposes the connector client resources. (Inherited from ConnectorClientBase)
EncryptDataAsync(String, KeyEncryptInput, CancellationToken)	Encrypt data with key
EncryptDataWithVersionAsync(String, String, KeyEncryptInput, CancellationToken)	Encrypt data with key version
GetKeyMetadataAsync(String, CancellationToken)	Get key metadata
GetKeyVersionMetadataAsync(String, String, CancellationToken)	Get key version metadata
GetSecretAsync(String, CancellationToken)	Get secret
GetSecretMetadataAsync(String, CancellationToken)	Get secret metadata
GetSecretVersionAsync(String, String, CancellationToken)	Get secret version
GetSecretVersionMetadataAsync(String, String, CancellationToken)	Get secret version metadata
ListKeysAsync(CancellationToken)	List keys
ListKeyVersionsAsync(String, CancellationToken)	List key versions
ListSecretsAsync(CancellationToken)	List secrets
ListSecretVersionsAsync(String, CancellationToken)	List secret versions
ResolveUrl(String)	Resolves a relative path or validates an absolute URL against the connection runtime URL. When the NextLink host matches the connection URL, it's used as-is. When it doesn't match (codeless connectors like ARM return nextLink pointing to the backend host e.g. management.azure.com), the path+query is extracted and routed through the APIM proxy. This is safe because the request still goes through the connection runtime URL with API Hub auth. (Inherited from ConnectorClientBase)