KeyVaultSettingsClient class
KeyVaultSettingsClient proporciona métodos asincrónicos para crear, actualizar, obtener y enumerar la configuración de Azure Key Vault.
Constructores
| Key |
Crea una instancia de KeyVaultSettingsClient. Uso de ejemplo: |
Propiedades
| vault |
Dirección URL base del almacén. |
Métodos
| get |
Obtenga el valor de una configuración de cuenta específica. |
| get |
Enumere la configuración de la cuenta. |
| update |
Actualiza la configuración de la cuenta con nombre. |
Detalles del constructor
KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)
Crea una instancia de KeyVaultSettingsClient.
Uso de ejemplo:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultSettingsClient } from "@azure/keyvault-admin";
const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultSettingsClient(vaultUrl, credentials);
new KeyVaultSettingsClient(vaultUrl: string, credential: TokenCredential, options?: SettingsClientOptions)Parámetros
- vaultUrl
-
string
la dirección URL de Key Vault. Debe tener esta forma: https://${your-key-vault-name}.vault.azure.net. Debe validar que esta dirección URL hace referencia a un recurso de Key Vault o HSM administrado válido. Consulte https://aka.ms/azsdk/blog/vault-uri para obtener más información.
- credential
- TokenCredential
Objeto que implementa la interfaz TokenCredential utilizada para autenticar las solicitudes al servicio. Use el paquete @azure/identity para crear una credencial que se adapte a sus necesidades.
- options
- SettingsClientOptions
opciones que se usan para configurar solicitudes de API de Key Vault.
Detalles de las propiedades
vaultUrl
Dirección URL base del almacén.
vaultUrl: stringValor de propiedad
string
Detalles del método
getSetting(string, GetSettingOptions)
Obtenga el valor de una configuración de cuenta específica.
function getSetting(settingName: string, options?: GetSettingOptions): Promise<KeyVaultSetting>Parámetros
- settingName
-
string
el nombre de la configuración.
- options
- GetSettingOptions
los parámetros opcionales.
Devoluciones
Promise<KeyVaultSetting>
getSettings(ListSettingsOptions)
Enumere la configuración de la cuenta.
function getSettings(options?: ListSettingsOptions): Promise<ListSettingsResponse>Parámetros
- options
- ListSettingsOptions
los parámetros opcionales.
Devoluciones
Promise<ListSettingsResponse>
updateSetting(KeyVaultSetting, UpdateSettingOptions)
Actualiza la configuración de la cuenta con nombre.
function updateSetting(setting: KeyVaultSetting, options?: UpdateSettingOptions): Promise<KeyVaultSetting>Parámetros
- setting
- KeyVaultSetting
la configuración que se va a actualizar. El nombre de la configuración debe ser una opción de configuración válida.
- options
- UpdateSettingOptions
los parámetros opcionales.
Devoluciones
Promise<KeyVaultSetting>