@azure/keyvault-keys package
Classes
| CryptographyClient |
Um cliente usado para executar operações criptográficas em uma chave de cofre da Chave do Azure ou em um <xref:JsonWebKey>local. |
| KeyClient |
O KeyClient fornece métodos para gerenciar <xref:KeyVaultKey> no Cofre da Chave do Azure. O cliente suporta a criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem KeyVaultKeys. O cliente também oferece suporte à listagem de <xref:DeletedKey> para um Cofre de Chaves do Azure habilitado para exclusão suave. |
Interfaces
| AesCbcDecryptParameters |
Parâmetros de desencriptação para algoritmos de encriptação AES-CBC. |
| AesCbcEncryptParameters |
Parâmetros de encriptação para algoritmos de encriptação AES-CBC. |
| AesGcmDecryptParameters |
Parâmetros de desencriptação para algoritmos de encriptação AES-GCM. |
| AesGcmEncryptParameters |
Parâmetros de encriptação para algoritmos de encriptação AES-GCM. |
| BackupKeyOptions |
Opções para <xref:backupKey>. |
| BeginDeleteKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:beginDeleteKey> |
| BeginRecoverDeletedKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:beginRecoverDeletedKey> |
| CreateEcKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:createEcKey> |
| CreateKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:createKey> |
| CreateOctKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:createOctKey> |
| CreateRsaKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:createRsaKey> |
| CryptographyClientOptions |
Os parâmetros opcionais aceitos pelo CryptographyClient do KeyVault |
| CryptographyOptions |
Uma interface que representa as opções dos métodos de API de criptografia, vá para o <xref:CryptographyClient> para obter mais informações. |
| DecryptOptions |
Opções para <xref:decrypt>. |
| DecryptResult |
Resultado da operação <xref:decrypt>. |
| DeletedKey |
Uma interface que representa uma chave de cofre de chave excluída. |
| EncryptOptions |
Opções para <xref:encrypt>. |
| EncryptResult |
Resultado da operação <xref:encrypt>. |
| GetDeletedKeyOptions |
Opções para <xref:getDeletedKey>. |
| GetKeyOptions |
Opções para <xref:getKey>. |
| ImportKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:importKey> |
| JsonWebKey |
A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
Os parâmetros opcionais aceitos pelo KeyClient do KeyVault |
| KeyPollerOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para <xref:beginDeleteKey> e <xref:beginRecoverDeletedKey> |
| KeyProperties |
Uma interface que representa as propriedades de <xref:KeyVaultKey> |
| KeyVaultKey |
Uma interface que representa uma chave do cofre da chave, com seu nome, valor e <xref:KeyProperties>. |
| KeyVaultKeyIdentifier |
Representa os segmentos que compõem um ID de Chave do Cofre da Chave. |
| ListDeletedKeysOptions |
Uma interface que representa parâmetros opcionais para operações paginadas KeyClient passadas para <xref:listDeletedKeys>. |
| ListPropertiesOfKeyVersionsOptions |
Uma interface que representa parâmetros opcionais para operações paginadas KeyClient passadas para <xref:listPropertiesOfKeyVersions>. |
| ListPropertiesOfKeysOptions |
Uma interface que representa parâmetros opcionais para operações paginadas KeyClient passadas para <xref:listPropertiesOfKeys>. |
| PurgeDeletedKeyOptions |
Opções para <xref:purgeDeletedKey>. |
| RestoreKeyBackupOptions |
Opções para <xref:restoreKeyBackup>. |
| RsaDecryptParameters |
Parâmetros de desencriptação para algoritmos de encriptação RSA. |
| RsaEncryptParameters |
Parâmetros de encriptação para algoritmos de encriptação RSA. |
| SignOptions |
Opções para <xref:sign>. |
| SignResult |
Resultado da operação <xref:sign>. |
| UnwrapKeyOptions |
Opções para <xref:unwrapKey>. |
| UnwrapResult |
Resultado da operação <xref:unwrap>. |
| UpdateKeyPropertiesOptions |
Opções para <xref:updateKeyProperties>. |
| VerifyDataOptions |
Opções para <xref:verifyData> |
| VerifyOptions |
Opções para <xref:verify>. |
| VerifyResult |
Resultado da operação <xref:verify>. |
| WrapKeyOptions |
Opções para <xref:wrapKey>. |
| WrapResult |
Resultado da operação <xref:wrap>. |
Aliases de Tipo
| AesCbcEncryptionAlgorithm |
Um tipo de união que representa todos os algoritmos de encriptação AES-CBC suportados. |
| AesGcmEncryptionAlgorithm |
Um tipo de união que representa todos os algoritmos de encriptação AES-GCM suportados. |
| DecryptParameters |
Um tipo que representa todos os parâmetros de desencriptação atualmente suportados à medida que se aplicam a diferentes algoritmos de encriptação. |
| DeletionRecoveryLevel |
Define valores para DeletionRecoveryLevel. Conheça os valores suportados pelo serviço
Purgeable: Indica um estado vault no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível contra uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação de Exclusão no nível da entidade ou superior (cofre, grupo de recursos, assinatura, etc.) |
| EncryptParameters |
Um tipo que representa todos os parâmetros de encriptação atualmente suportados à medida que se aplicam a diferentes algoritmos de encriptação. |
| EncryptionAlgorithm |
Define valores para JsonWebKeyEncryptionAlgorithm. Conheça os valores suportados pelo serviço
RSA-OAEP |
| KeyCurveName |
Define valores para JsonWebKeyCurveName. Conheça os valores suportados pelo serviço
P-256: A curva elíptica NIST P-256, AKA curva SECG SECP256R1. |
| KeyOperation |
Define valores para JsonWebKeyOperation. Conheça os valores suportados pelo serviço
criptografar |
| KeyType |
Define valores para JsonWebKeyType. Conheça os valores suportados pelo serviço
EC: Curva Elíptica. |
| KeyWrapAlgorithm |
Algoritmos suportados para empacotamento/desempacotamento de chaves |
| RsaEncryptionAlgorithm |
Um tipo de união que representa todos os algoritmos de encriptação RSA suportados. |
| SignatureAlgorithm |
Define valores para JsonWebKeySignatureAlgorithm. Conheça os valores suportados pelo serviço
PS256: RSASSA-PSS usando SHA-256 e MGF1 com SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518 |
Enumerações
| KnownDeletionRecoveryLevel |
Valores conhecidos de <xref:DeletionRecoveryLevel> que o serviço aceita. |
| KnownEncryptionAlgorithms |
Valores conhecidos de <xref:JsonWebKeyEncryptionAlgorithm> que o serviço aceita. |
| KnownKeyCurveNames |
Valores conhecidos de <xref:JsonWebKeyCurveName> que o serviço aceita. |
| KnownKeyOperations |
Valores conhecidos de <xref:JsonWebKeyOperation> que o serviço aceita. |
| KnownKeyTypes |
Valores conhecidos de <xref:JsonWebKeyType> que o serviço aceita. |
| KnownSignatureAlgorithms |
Valores conhecidos de <xref:JsonWebKeySignatureAlgorithm> que o serviço aceita. |
Funções
| parse |
Analisa o ID da chave do cofre da chave fornecido. Um exemplo é: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id> Ao analisar o ID acima, essa função retorna: |
Detalhes de Função
parseKeyVaultKeyIdentifier(string)
Analisa o ID da chave do cofre da chave fornecido. Um exemplo é: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>
Ao analisar o ID acima, essa função retorna:
{
sourceId: "https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id>",
vaultUrl: "https://<keyvault-name>.vault.azure.net",
version: "<unique-version-id>",
name: "<key-name>"
}
function parseKeyVaultKeyIdentifier(id: string)Parâmetros
- id
-
string
O id da chave do cofre da chave.
