KeyVaultSettingsClient class
O KeyVaultSettingsClient fornece métodos assíncronos para criar, atualizar, obter e listar configurações para o Azure Key Vault.
Construtores
| Key |
Cria uma instância do KeyVaultSettingsClient. Uso de exemplo: |
Propriedades
| vault |
A URL base para o cofre. |
Métodos
| get |
Obtenha o valor de uma configuração de conta específica. |
| get |
Listar as configurações da conta. |
| update |
Atualiza a configuração da conta nomeada. |
Detalhes do construtor
KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)
Cria uma instância do KeyVaultSettingsClient.
Uso de exemplo:
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
a URL do Key Vault. Ele deve ter esta forma: https://${your-key-vault-name}.vault.azure.net. Você deve validar que essa URL faz referência a um cofre de chaves válido ou recurso HSM gerenciado. Consulte https://aka.ms/azsdk/blog/vault-uri para obter detalhes.
- credential
- TokenCredential
Um objeto que implementa a interface TokenCredential usada para autenticar solicitações no serviço. Use o pacote @azure/identity para criar uma credencial que atenda às suas necessidades.
- options
- SettingsClientOptions
opções usadas para configurar solicitações de API do Key Vault.
Detalhes da propriedade
vaultUrl
A URL base para o cofre.
vaultUrl: stringValor da propriedade
string
Detalhes do método
getSetting(string, GetSettingOptions)
Obtenha o valor de uma configuração de conta específica.
function getSetting(settingName: string, options?: GetSettingOptions): Promise<KeyVaultSetting>Parâmetros
- settingName
-
string
o nome da configuração.
- options
- GetSettingOptions
os parâmetros opcionais.
Retornos
Promise<KeyVaultSetting>
getSettings(ListSettingsOptions)
Listar as configurações da conta.
function getSettings(options?: ListSettingsOptions): Promise<ListSettingsResponse>Parâmetros
- options
- ListSettingsOptions
os parâmetros opcionais.
Retornos
Promise<ListSettingsResponse>
updateSetting(KeyVaultSetting, UpdateSettingOptions)
Atualiza a configuração da conta nomeada.
function updateSetting(setting: KeyVaultSetting, options?: UpdateSettingOptions): Promise<KeyVaultSetting>Parâmetros
- setting
- KeyVaultSetting
a configuração a ser atualizada. O nome da configuração deve ser uma opção de configurações válida.
- options
- UpdateSettingOptions
os parâmetros opcionais.
Retornos
Promise<KeyVaultSetting>