Class KeyVaultSettingsClient

constructor

• new KeyVaultSettingsClient(vaultUrl: string, credential: TokenCredential, options?: SettingsClientOptions): KeyVaultSettingsClient

• Creates an instance of the KeyVaultSettingsClient.

  Example usage:

  import { KeyVaultSettingsClient } from "@azure/keyvault-admin";
  import { DefaultAzureCredential } from "@azure/identity";
  
  let vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
  let credentials = new DefaultAzureCredential();
  
  let client = new KeyVaultSettingsClient(vaultUrl, credentials);
  

  Parameters

  • vaultUrl: string

    the URL of the Key Vault. It should have this shape: https://${your-key-vault-name}.vault.azure.net. You should validate that this URL references a valid Key Vault or Managed HSM resource. See https://aka.ms/azsdk/blog/vault-uri for details.

  • credential: TokenCredential

    An object that implements the TokenCredential interface used to authenticate requests to the service. Use the @azure/identity package to create a credential that suits your needs.

  • options: SettingsClientOptions = {}

    options used to configure Key Vault API requests.

  Returns KeyVaultSettingsClient