@azure/keyvault-keys package

Classes

CryptographyClient	Um cliente usado para executar operações criptográficas em uma chave do Azure Key Vault ou em umJsonWebKey local.
KeyClient	O KeyClient fornece métodos para gerenciar KeyVaultKey no Azure Key Vault. O cliente dá suporte à criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem de KeyVaultKeys. O cliente também dá suporte à listagem DeletedKey para um Azure Key Vault habilitado para exclusão reversível.

Interfaces

AesCbcDecryptParameters	Parâmetros de descriptografia para algoritmos de criptografia AES-CBC.
AesCbcEncryptParameters	Parâmetros de criptografia para algoritmos de criptografia AES-CBC.
AesGcmDecryptParameters	Parâmetros de descriptografia para algoritmos de criptografia AES-GCM.
AesGcmEncryptParameters	Parâmetros de criptografia para algoritmos de criptografia 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 pela CryptographyClient do KeyVault
CryptographyOptions	Uma interface que representa as opções dos métodos de API de criptografia, acesse o CryptographyClient para obter mais informações.
DecryptOptions	Opções para decrypt(DecryptParameters, DecryptOptions).
DecryptResult	Resultado da operação de decrypt(DecryptParameters, DecryptOptions).
DeletedKey	Uma interface que representa uma chave do Key Vault excluída.
EncryptOptions	Opções para encrypt(EncryptParameters, EncryptOptions).
EncryptResult	Resultado da operação de encrypt(EncryptParameters, EncryptOptions).
GetCryptographyClientOptions	Opções para getCryptographyClient.
GetDeletedKeyOptions	Opções para getDeletedKey(string, GetDeletedKeyOptions).
GetKeyAttestationOptions	Opções para getKeyAttestation(string, GetKeyAttestationOptions).
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
KeyAttestation	Uma interface que representa as propriedades do atestado de uma chave
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ão executados pelo Key Vault ao longo do tempo de vida de uma chave.
KeyRotationPolicy	A política de rotação de chave completa 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 Key Vault, com seu nome, valor e KeyProperties.
KeyVaultKeyIdentifier	Representa os segmentos que compõem uma ID de chave do Key Vault.
ListDeletedKeysOptions	Uma interface que representa parâmetros opcionais para operações de página keyClient passadas para listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions	Uma interface que representa parâmetros opcionais para operações de página keyClient passadas para listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions	Uma interface que representa parâmetros opcionais para operações de página keyClient passadas para listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings	Uma interface que rastreia as configurações da iteração paginada
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.
PollOperationState	PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessário para definir qualquer poller de operação de execução prolongada. Enquanto a classe Poller funciona como o mecanismo de controle local para começar a disparar, aguardar e potencialmente cancelar uma operação de execução longa, o PollOperationState documenta o status da operação remota de longa execução. Ela deve ser atualizada 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 sondador, 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 operação releaseKey .
RestoreKeyBackupOptions	Opções para restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions	Opções para rotateKey
RsaDecryptParameters	Parâmetros de descriptografia para algoritmos de criptografia RSA.
RsaEncryptParameters	Parâmetros de criptografia para algoritmos de criptografia RSA.
SignOptions	Opções para sign(string, Uint8Array, SignOptions).
SignResult	Resultado da operação de sign(string, Uint8Array, SignOptions).
UnwrapKeyOptions	Opções para unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	Resultado da operação de <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 de verify(string, Uint8Array, Uint8Array, VerifyOptions).
WrapKeyOptions	Opções para wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	Resultado da operação de <xref:wrap>.

Aliases de tipo

AesCbcEncryptionAlgorithm	Um tipo de união que representa todos os algoritmos de criptografia de AES-CBC com suporte.
AesGcmEncryptionAlgorithm	Um tipo de união que representa todos os algoritmos de criptografia de AES-GCM com suporte.
DecryptParameters	Um tipo que representa todos os parâmetros de descriptografia com suporte no momento, conforme eles se aplicam a algoritmos de criptografia diferentes.
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o certificado no final do intervalo de retenção. KnownDeletionRecoveryLevel pode ser usado de forma intercambiável com DeletionRecoveryLevel, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço purgável: denota um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Esse nível corresponde a nenhuma proteção disponível em uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação Delete no nível de entidade ou superior (cofre, grupo de recursos, assinatura etc.) Recuperável+Purgável: denota um estado do cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema o excluirá permanentemente após 90 dias, se não for recuperado recuperável: denota um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema o excluirá permanentemente após 90 dias, se não for recuperado Recoverable+ProtectedSubscription: denota um cofre e um estado de assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema o excluirá permanentemente após 90 dias, se não for recuperado CustomedRecoverable+Purgeable: denota um estado de cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza quando 7 <= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. CustomizedRecoverable: denota um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza quando 7 <= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda estiver disponível. CustomedRecoverable+ProtectedSubscription: denota um cofre e um estado de assinatura no qual a exclusão é recuperável, a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente quando 7 <= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a própria assinatura não pode ser cancelada.
EncryptParameters	Um tipo que representa todos os parâmetros de criptografia atualmente compatíveis à medida que se aplicam a algoritmos de criptografia diferentes.
EncryptionAlgorithm	Um algoritmo usado para criptografia e descriptografia. <xref:KnownJsonWebKeyEncryptionAlgorithm> pode ser usado de forma intercambiável com JsonWebKeyEncryptionAlgorithm, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço RSA-OAEP: [Não recomendado] RSAES usando OAEP (Preenchimento de Criptografia Assimétrica Ideal), conforme descrito em https://tools.ietf.org/html/rfc3447, com os parâmetros padrão especificados pelo RFC 3447 na Seção A.2.1. Esses parâmetros padrão estão usando uma função de hash de SHA-1 e uma função de geração de máscara de MGF1 com SHA-1. A Microsoft recomenda usar algoritmos RSA_OAEP_256 ou mais fortes para segurança aprimorada. A Microsoft não recomenda RSA_OAEP, que está incluída apenas para compatibilidade com versões anteriores. RSA_OAEP utiliza SHA1, que tem problemas conhecidos de colisão. RSA-OAEP-256: RSAES usando preenchimento de criptografia assimétrica ideal com uma função de hash sha-256 e uma função de geração de máscara de MGF1 com SHA-256. RSA1_5: [Não recomendado] RSAES-PKCS1-V1_5 criptografia de chave, conforme descrito em https://tools.ietf.org/html/rfc3447. A Microsoft recomenda usar algoritmos RSA_OAEP_256 ou mais fortes para segurança aprimorada. A Microsoft não recomenda RSA_1_5, que está incluída apenas para compatibilidade com versões anteriores. Os padrões criptográficos não consideram mais a RSA com o esquema de preenchimento PKCS nº 1 v1.5 seguro para criptografia. A128GCM: AES-GCM de 128 bits. A192GCM: AES-GCM de 192 bits. A256GCM: AES-GCM de 256 bits. A128KW: quebra de chave AES de 128 bits. A192KW: quebra de chave AES de 192 bits. A256KW: quebra-chave AES de 256 bits. A128CBC: AES-CBC de 128 bits. A192CBC: AES-CBC de 192 bits. A256CBC: AES-CBC de 256 bits. A128CBCPAD: AES-CBC de 128 bits com preenchimento PKCS. A192CBCPAD: AES-CBC de 192 bits com preenchimento PKCS. A256CBCPAD: AES-CBC de 256 bits com preenchimento PKCS. CKM_AES_KEY_WRAP: quebra de tecla CKM AES. CKM_AES_KEY_WRAP_PAD: quebra de tecla CKM AES com preenchimento.
KeyCurveName	Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> pode ser usado de forma intercambiável com JsonWebKeyCurveName, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço P-256: a curva elíptica NIST P-256, também conhecida como SECP256R1 de curva SECG. P-384: a curva elíptica NIST P-384, também conhecida como SECP384R1 de curva SECG. P-521: A curva elíptica NIST P-521, também conhecida como SECP521R1 de curva SECG. P-256K: a curva elíptica SECP256K1 SECG.
KeyExportEncryptionAlgorithm	Define valores para KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm pode ser usado de forma intercambiável com KeyEncryptionAlgorithm, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	Operações de chave da Web JSON. Para obter mais informações, consulte JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> pode ser usado de forma intercambiável com JsonWebKeyOperation, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço criptografar: indica que a chave pode ser usada para criptografar. descriptografar: indica que a chave pode ser usada para descriptografar. assinar: indica que a chave pode ser usada para assinar. verificar: indica se a chave pode ser usada para verificar. wrapKey: indica que a chave pode ser usada para encapsular outra chave. unwrapKey: indica que a chave pode ser usada para desembrulhar outra chave. importar: indica que a chave pode ser importada durante a criação. exportar: indica que o componente privado da chave pode ser exportado.
KeyRotationPolicyAction	A ação que será executada.
KeyType	Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. <xref:KnownJsonWebKeyType> pode ser usado de forma intercambiável com JsonWebKeyType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço EC: Curva Elíptica. EC-HSM: Curva Elíptica com uma chave privada armazenada no HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA com uma chave privada armazenada no HSM. de outubro: sequência de octeto (usada para representar chaves simétricas) oct-HSM: sequência de octeto (usada para representar chaves simétricas) que é armazenada no HSM.
KeyWrapAlgorithm	Algoritmos com suporte para encapsulamento/desembrulhamento de chave
RsaEncryptionAlgorithm	Um tipo de união que representa todos os algoritmos de criptografia RSA com suporte.
SignatureAlgorithm	O identificador do algoritmo de assinatura/verificação. Para obter mais informações sobre possíveis tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> pode ser usado de forma intercambiável com JsonWebKeySignatureAlgorithm, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço PS256: RSASSA-PSS usando SHA-256 e MGF1 com SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS usando SHA-384 e MGF1 com SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS usando SHA-512 e MGF1 com SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 usando SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 usando SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 usando SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518 HS256: HMAC usando SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518 HS384: HMAC usando SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518 HS512: HMAC usando SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518 RSNULL: Reservado ES256: ECDSA usando P-256 e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518. ES384: ECDSA usando P-384 e SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518 ES512: ECDSA usando P-521 e SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518 ES256K: ECDSA usando P-256K e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518

Enumerações

KnownDeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o certificado no final do intervalo de retenção.
KnownEncryptionAlgorithms	Um algoritmo usado para criptografia e descriptografia.
KnownKeyCurveNames	Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName.
KnownKeyExportEncryptionAlgorithm	O algoritmo de criptografia a ser usado para proteger o material de chave exportado
KnownKeyOperations	Valores conhecidos de KeyOperation que o serviço aceita.
KnownKeyTypes	Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KnownSignatureAlgorithms	O identificador do algoritmo de assinatura/verificação. Para obter mais informações sobre possíveis tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm.

Funções

parseKeyVaultKeyIdentifier(string)

Analisa a ID de chave do Key Vault fornecida. Um exemplo é: https://< nome-do-cofre-chave.vault.azure.net/keys/>< nome-da-chave>/<id da versão exclusiva> Ao analisar a 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>" }

Detalhes da função

parseKeyVaultKeyIdentifier(string)

Analisa a ID de chave do Key Vault fornecida. Um exemplo é:

https://< nome-do-cofre-chave.vault.azure.net/keys/>< nome-da-chave>/<id da versão exclusiva>

Ao analisar a 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): KeyVaultKeyIdentifier

Parâmetros

id

string

A ID da Chave do Key Vault.

Retornos

KeyVaultKeyIdentifier