Partager via

KeyVaultSettingsClient class

  • Référence
Paquet:
@azure/keyvault-admin

KeyVaultSettingsClient fournit des méthodes asynchrones pour créer, mettre à jour, obtenir et répertorier des paramètres pour Azure Key Vault.

Constructeurs

KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)

Crée une instance de KeyVaultSettingsClient.

Exemple d’utilisation :

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);

Propriétés

vaultUrl

URL de base du coffre.

Méthodes

getSetting(string, GetSettingOptions)

Obtenez la valeur d’un paramètre de compte spécifique.
getSettings(ListSettingsOptions)

Répertoriez les paramètres du compte.
updateSetting(KeyVaultSetting, UpdateSettingOptions)

Met à jour le paramètre de compte nommé.

Détails du constructeur

KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)

Crée une instance de KeyVaultSettingsClient.

Exemple d’utilisation :

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);

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

Paramètres

vaultUrl

string

URL du coffre de clés. Il doit avoir cette forme : https://${your-key-vault-name}.vault.azure.net. Vous devez vérifier que cette URL fait référence à une ressource Key Vault ou HSM managée valide. Pour plus d’informations, consultez https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objet qui implémente l’interface TokenCredential utilisée pour authentifier les demandes auprès du service. Utilisez le package @azure/identity pour créer des informations d’identification qui correspondent à vos besoins.

options
SettingsClientOptions

options utilisées pour configurer les demandes d’API Key Vault.

Détails de la propriété

vaultUrl

URL de base du coffre.

vaultUrl: string

Valeur de propriété

string

Détails de la méthode

getSetting(string, GetSettingOptions)

Obtenez la valeur d’un paramètre de compte spécifique.

function getSetting(settingName: string, options?: GetSettingOptions): Promise<KeyVaultSetting>

Paramètres

settingName

string

nom du paramètre.

options
GetSettingOptions

paramètres facultatifs.

Retours

Promise<KeyVaultSetting>

getSettings(ListSettingsOptions)

Répertoriez les paramètres du compte.

function getSettings(options?: ListSettingsOptions): Promise<ListSettingsResponse>

Paramètres

options
ListSettingsOptions

paramètres facultatifs.

Retours

Promise<ListSettingsResponse>

updateSetting(KeyVaultSetting, UpdateSettingOptions)

Met à jour le paramètre de compte nommé.

function updateSetting(setting: KeyVaultSetting, options?: UpdateSettingOptions): Promise<KeyVaultSetting>

Paramètres

setting
KeyVaultSetting

paramètre à mettre à jour. Le nom du paramètre doit être une option de paramètres valide.

options
UpdateSettingOptions

paramètres facultatifs.

Retours

Promise<KeyVaultSetting>