@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 local JsonWebKey. |
| KeyClient |
O KeyClient fornece métodos para gerenciar KeyVaultKey no Cofre de Chaves 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 dá suporte à listagem 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 backupKey(string, BackupKeyOptions). |
| BeginDeleteKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteKey(string, BeginDeleteKeyOptions) |
| BeginRecoverDeletedKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| CreateEcKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para createEcKey(string, CreateEcKeyOptions) |
| CreateKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para createKey(string, string, CreateKeyOptions) |
| CreateOctKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para createOctKey(string, CreateOctKeyOptions) |
| CreateRsaKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para createRsaKey(string, CreateRsaKeyOptions) |
| 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 CryptographyClient para obter mais informações. |
| DecryptOptions |
Opções para decrypt(DecryptParameters, DecryptOptions). |
| DecryptResult |
Resultado da operação decrypt(DecryptParameters, DecryptOptions). |
| DeletedKey |
Uma interface que representa uma chave de cofre de chave excluída. |
| EncryptOptions |
Opções para encrypt(EncryptParameters, EncryptOptions). |
| EncryptResult |
Resultado da operação encrypt(EncryptParameters, EncryptOptions). |
| GetCryptographyClientOptions |
Opções para getCryptographyClient. |
| GetDeletedKeyOptions |
Opções para getDeletedKey(string, GetDeletedKeyOptions). |
| GetKeyOptions |
Opções para getKey(string, GetKeyOptions). |
| GetKeyRotationPolicyOptions |
Opções para <xref:KeyClient.getRotationPolicy> |
| GetRandomBytesOptions |
Opções para getRandomBytes |
| ImportKeyOptions |
Uma interface que representa os parâmetros opcionais que podem ser passados para importKey(string, JsonWebKey, ImportKeyOptions) |
| 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 beginDeleteKey(string, BeginDeleteKeyOptions) e beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) |
| KeyProperties |
Uma interface que representa as propriedades de KeyVaultKey |
| KeyReleasePolicy |
As regras de política sob as quais uma chave pode ser exportada. |
| KeyRotationLifetimeAction |
Uma ação e seu gatilho correspondente que será executado pelo Key Vault ao longo da vida útil de uma chave. |
| KeyRotationPolicy |
A política completa de rotação de chaves que pertence a uma chave. |
| KeyRotationPolicyProperties |
As propriedades de uma política de rotação de chave que o cliente pode definir para uma determinada chave. Você também pode redefinir a política de rotação de chaves para seus valores padrão definindo lifetimeActions como uma matriz vazia. |
| KeyVaultKey |
Uma interface que representa uma chave do cofre da chave, com seu nome, valor e 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 listDeletedKeys(ListDeletedKeysOptions). |
| ListPropertiesOfKeyVersionsOptions |
Uma interface que representa parâmetros opcionais para operações paginadas KeyClient passadas para listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions). |
| ListPropertiesOfKeysOptions |
Uma interface que representa parâmetros opcionais para operações paginadas KeyClient passadas para listPropertiesOfKeys(ListPropertiesOfKeysOptions). |
| PageSettings |
Uma interface que rastreia as configurações para iteração paginada |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável até a conclusão e por página. |
| PollOperationState |
PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessárias para definir qualquer poller de operação de longa duração. Enquanto a classe Poller funciona como o mecanismo de controle local para iniciar o acionamento, aguardar e potencialmente cancelar uma operação de longa duração, o PollOperationState documenta o status da operação remota de longa duração. Ele deve ser atualizado pelo menos quando a operação for iniciada, quando for concluída e quando for cancelada. No entanto, as implementações podem ter qualquer outro número de propriedades que podem ser atualizadas por outros motivos. |
| PollerLike |
Representação abstrata de um poller, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar. |
| PurgeDeletedKeyOptions |
Opções para purgeDeletedKey(string, PurgeDeletedKeyOptions). |
| ReleaseKeyOptions |
Opções para releaseKey |
| ReleaseKeyResult |
Resultado da releaseKey operação. |
| RestoreKeyBackupOptions |
Opções para restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions). |
| RotateKeyOptions |
Opções para rotateKey |
| 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 sign(string, Uint8Array, SignOptions). |
| SignResult |
Resultado da operação sign(string, Uint8Array, SignOptions). |
| UnwrapKeyOptions |
Opções para unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions). |
| UnwrapResult |
Resultado da operação <xref:unwrap>. |
| UpdateKeyPropertiesOptions |
Opções para updateKeyProperties(string, string, UpdateKeyPropertiesOptions). |
| UpdateKeyRotationPolicyOptions |
Opções para updateKeyRotationPolicy |
| VerifyDataOptions |
Opções para verifyData(string, Uint8Array, Uint8Array, VerifyOptions) |
| VerifyOptions |
Opções para verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| VerifyResult |
Resultado da operação verify(string, Uint8Array, Uint8Array, VerifyOptions). |
| WrapKeyOptions |
Opções para wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions). |
| 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. Valores conhecidos 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. Valores conhecidos suportados pelo serviço
RSA-OAEP |
| KeyCurveName |
Define valores para JsonWebKeyCurveName. Valores conhecidos suportados pelo serviço
P-256: A curva elíptica NIST P-256, AKA curva SECG SECP256R1. |
| KeyExportEncryptionAlgorithm |
Define valores para KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm pode ser usado de forma intercambiável com KeyEncryptionAlgorithm, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço
CKM_RSA_AES_KEY_WRAP |
| KeyOperation |
Define valores para JsonWebKeyOperation. Valores conhecidos suportados pelo serviço
criptografar |
| KeyRotationPolicyAction |
A ação que será executada. |
| KeyType |
Define valores para JsonWebKeyType. Valores conhecidos 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. Valores conhecidos 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 |
Os valores conhecidos de DeletionRecoveryLevel que o serviço aceita. |
| KnownEncryptionAlgorithms |
Os valores conhecidos de EncryptionAlgorithm que o serviço aceita. |
| KnownKeyCurveNames |
Valores conhecidos de <xref:JsonWebKeyCurveName> que o serviço aceita. |
| KnownKeyExportEncryptionAlgorithm |
Os valores conhecidos de KeyExportEncryptionAlgorithm que o serviço aceita. |
| KnownKeyOperations |
Os valores conhecidos de KeyOperation 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://.vault.azure.net/keys// 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://.vault.azure.net/keys//
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): KeyVaultKeyIdentifierParâmetros
- id
-
string
O id da chave do cofre da chave.