@azure/keyvault-common package
Interfaces
| AdditionalPolicyConfig |
Usado para configurar políticas adicionais adicionadas ao pipeline na construção. |
| CommonClientOptions |
O conjunto comum de opções que os clientes de alto nível devem expor. |
| KeepAliveOptions |
Opções para manter o comportamento ativo das conexões HTTP. |
| KeyVaultAuthenticationPolicyOptions |
Opções adicionais para a política de autenticação baseada em desafio. |
| KeyVaultEntityIdentifier |
Os componentes analisados de um identificador de entidade do Key Vault. |
| RedirectOptions |
Opções de como as respostas de redirecionamento são tratadas. |
Aliases de tipo
| ExtendedCommonClientOptions |
Opções estendidas para clientes comuns que incluem manter vivo e opções de redirecionamento. Esse tipo combina o padrão CommonClientOptions com opções adicionais para controlar o comportamento de manutenção e redirecionamento da conexão HTTP. |
Funções
| key |
Uma implementação personalizada da política de autenticação de token portador que lida com desafios de Key Vault e CAE. O Key Vault suporta outros esquemas de autenticação, mas garantimos que a autenticação de desafio seja usada enviando primeiro uma cópia da solicitação, sem autorização ou conteúdo. quando o desafio for recebido, ele será autenticado e usado para enviar a solicitação original com autorização. Após a primeira solicitação de um cliente, as solicitações de acompanhamento obterão o token armazenado em cache, se possível. |
| parse |
Analisa um identificador de Key Vault em seus componentes. |
Variáveis
| key |
Nome da política de autenticação do Key Vault. |
Detalhes da função
keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)
Uma implementação personalizada da política de autenticação de token portador que lida com desafios de Key Vault e CAE.
O Key Vault suporta outros esquemas de autenticação, mas garantimos que a autenticação de desafio seja usada enviando primeiro uma cópia da solicitação, sem autorização ou conteúdo.
quando o desafio for recebido, ele será autenticado e usado para enviar a solicitação original com autorização.
Após a primeira solicitação de um cliente, as solicitações de acompanhamento obterão o token armazenado em cache, se possível.
function keyVaultAuthenticationPolicy(credential: TokenCredential, options?: KeyVaultAuthenticationPolicyOptions): PipelinePolicyParâmetros
- credential
- TokenCredential
Retornos
parseKeyVaultIdentifier(string, undefined | string)
Analisa um identificador de Key Vault em seus componentes.
function parseKeyVaultIdentifier(collection: string, identifier: undefined | string): KeyVaultEntityIdentifierParâmetros
- collection
-
string
A coleção do identificador Key Vault.
- identifier
-
undefined | string
O identificador do Key Vault a ser analisado.
Retornos
Detalhes da variável
keyVaultAuthenticationPolicyName
Nome da política de autenticação do Key Vault.
keyVaultAuthenticationPolicyName: "keyVaultAuthenticationPolicy"Tipo
"keyVaultAuthenticationPolicy"