@azure/keyvault-keys package

Um cliente utilizado para realizar operações criptográficas numa chave do cofre de chaves do Azure ou num JsonWebKey local.

O KeyClient fornece métodos para gerir KeyVaultKey na Key Vault do Azure. O cliente suporta a criação, obtenção, atualização, eliminação, remoção, cópia de segurança, restauro e listagem de KeyVaultKeys. O cliente também suporta a listagem deleteKey para uma eliminação recuperável ativada do Azure Key Vault.

Parâmetros de desencriptação para algoritmos de encriptação AES-CBC.

Parâmetros de encriptação para algoritmos de encriptação AES-CBC.

Parâmetros de desencriptação para algoritmos de encriptação AES-GCM.

Parâmetros de encriptação para algoritmos de encriptação AES-GCM.

Opções para backupKey(string, BackupKeyOptions).

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para beginDeleteKey(string, BeginDeleteKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para createEcKey(string, CreateEcKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para createKey(string, string, CreateKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para createOctKey(string, CreateOctKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para createRsaKey(string, CreateRsaKeyOptions)

Os parâmetros opcionais aceites pelo KeyVault CryptographyClient

Uma interface que representa as opções dos métodos da API de criptografia, aceda ao CryptographyClient para obter mais informações.

Opções para decrypt(DecryptParameters, DecryptOptions).

Resultado da decrypt(DecryptParameters, DecryptOptions) operação.

Uma interface que representa uma Chave de Key Vault eliminada.

Opções para encrypt(EncryptParameters, EncryptOptions).

Resultado da encrypt(EncryptParameters, EncryptOptions) operação.

Opções para getCryptographyClient.

Opções para getDeletedKey(string, GetDeletedKeyOptions).

Opções para getKey(string, GetKeyOptions).

Opções para <xref:KeyClient.getRotationPolicy>

Opções para getRandomBytes

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para importKey(string, JsonWebKey_2, ImportKeyOptions)

A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Os parâmetros opcionais aceites pelo KeyClient do KeyVault

Uma interface que representa os parâmetros opcionais que podem ser transmitidos para beginDeleteKey(string, BeginDeleteKeyOptions) e beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Uma interface que representa as Propriedades de KeyVaultKey

As regras de política sob as quais uma chave pode ser exportada.

Uma ação e o respetivo acionador correspondente que serão efetuados por Key Vault ao longo da duração de uma chave.

A política de rotação de chaves completa que pertence a uma chave.

As propriedades de uma política de rotação de chaves que o cliente pode definir para uma determinada chave.

Também pode repor a política de rotação de chaves para os respetivos valores predefinidos ao definir lifetimeActions para uma matriz vazia.

Uma interface que representa uma Chave de Key Vault, com o respetivo nome, valor e KeyProperties.

Representa os segmentos que compõem um ID de Chave Key Vault.

Uma interface que representa parâmetros opcionais para operações paginadas keyClient transmitida para listDeletedKeys(ListDeletedKeysOptions).

Uma interface que representa parâmetros opcionais para operações paginadas keyClient transmitida para listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).

Uma interface que representa parâmetros opcionais para operações paginadas keyClient transmitida para listPropertiesOfKeys(ListPropertiesOfKeysOptions).

Uma interface que controla as definições da iteração paginada

Uma interface que permite a iteração iterável assíncrona até à conclusão e por página.

PollOperationState contém uma lista opinada do conjunto de propriedades mais pequeno necessário para definir qualquer poller de operação de execução prolongada.

Enquanto a classe Poller funciona como o mecanismo de controlo local para começar a acionar, aguardar e potencialmente cancelar uma operação de execução prolongada, o PollOperationState documenta o estado da operação de execução prolongada remota.

Deve ser atualizado, pelo menos, quando a operação for iniciada, quando terminar e quando for cancelada. No entanto, as implementações podem ter qualquer outro número de propriedades que podem ser atualizadas por outros motivos.

Representação abstrata de um poller, destinada a expor apenas a API mínima com a qual o utilizador precisa de trabalhar.

Opções para purgeDeletedKey(string, PurgeDeletedKeyOptions).

Opções para releaseKey

Resultado da operação releaseKey .

Opções para restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Opções para rotateKey

Parâmetros de desencriptação para algoritmos de encriptação RSA.

Parâmetros de encriptação para algoritmos de encriptação RSA.

Opções para sign(string, Uint8Array, SignOptions).

Resultado da sign(string, Uint8Array, SignOptions) operação.

Opções para unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

Resultado da <xref:unwrap> operação.

Opções para updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Opções para updateKeyRotationPolicy

Opções para verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Opções para verify(string, Uint8Array, Uint8Array, VerifyOptions).

Resultado da verify(string, Uint8Array, Uint8Array, VerifyOptions) operação.

Opções para wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

Resultado da <xref:wrap> operação.

Um tipo de união que representa todos os algoritmos de encriptação AES-CBC suportados.

Um tipo de união que representa todos os algoritmos de encriptação AES-GCM suportados.

Um tipo que representa todos os parâmetros de desencriptação atualmente suportados à medida que se aplicam a diferentes algoritmos de encriptação.

Define valores para DeletionRecoveryLevel.
KnownDeletionRecoveryLevel pode ser utilizado alternadamente com DeletionRecoveryLevel, esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Removível: indica um estado do cofre no qual a eliminação é uma operação irreversível, sem a possibilidade de recuperação. Este nível não corresponde a nenhuma proteção disponível numa operação Eliminar; os dados são irremediavelmente perdidos ao aceitar uma operação Delete ao nível da entidade ou superior (cofre, grupo de recursos, subscrição, etc.)
Recuperável+Removível: indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias), a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recuperável: indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias) e enquanto a subscrição ainda está disponível. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recuperável+ProtectedSubscription: indica um cofre e estado de subscrição no qual a eliminação é recuperável dentro do intervalo de retenção (90 dias), a eliminação imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
CustomizedRecoverable+Purgeable: indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção, a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada.
CustomizedRecoverable: indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e enquanto a subscrição ainda está disponível.
CustomizedRecoverable+ProtectedSubscription: indica um cofre e estado de subscrição no qual a eliminação é recuperável, imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e também reflete o facto de a própria subscrição não poder ser cancelada.

Um tipo que representa todos os parâmetros de encriptação atualmente suportados à medida que se aplicam a diferentes algoritmos de encriptação.

Define valores para JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> pode ser utilizado alternadamente com JsonWebKeyEncryptionAlgorithm. Esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

RSA-OAEP
RSA-OAEP-256
RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD

Define valores para JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> pode ser utilizado alternadamente com JsonWebKeyCurveName, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

P-256: A curva elíptica NIST P-256, também conhecida como curva SECG SECP256R1.
P-384: A curva elíptica NIST P-384, também conhecida como curva SECG SECP384R1.
P-521: A curva elíptica NIST P-521, também conhecida como curva SECG SECP521R1.
P-256K: a curva elíptica SECG SECP256K1.

Define valores para KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm pode ser utilizado alternadamente com KeyEncryptionAlgorithm, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

Define valores para JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> pode ser utilizado alternadamente com JsonWebKeyOperation, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

encriptar
desencriptar
assinar
verificar
wrapKey
unwrapKey
importar
exportar

A ação que será executada.

Define valores para JsonWebKeyType.
<xref:KnownJsonWebKeyType> pode ser utilizado alternadamente com JsonWebKeyType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo 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.
oct: sequência octeto (utilizada para representar chaves simétricas)
oct-HSM: sequência octeto (utilizada para representar chaves simétricas) que é armazenada no HSM.

Algoritmos suportados para encapsulamento/anulação de moldagem de chaves

Um tipo de união que representa todos os algoritmos de encriptação RSA suportados.

Define valores para JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> pode ser utilizado alternadamente com JsonWebKeySignatureAlgorithm, esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

PS256: RSASSA-PSS com SHA-256 e MGF1 com SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS com SHA-384 e MGF1 com SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS com SHA-512 e MGF1 com SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 com SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 com SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 com SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
RSNULL: Reservado
ES256: ECDSA com P-256 e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518.
ES384: ECDSA com P-384 e SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
ES512: ECDSA com P-521 e SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
ES256K: ECDSA com P-256K e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518

Valores conhecidos de DeletionRecoveryLevel que o serviço aceita.

Valores conhecidos de EncryptionAlgorithm que o serviço aceita.

Valores conhecidos do <xref:JsonWebKeyCurveName> que o serviço aceita.

Valores conhecidos de KeyExportEncryptionAlgorithm que o serviço aceita.

Valores conhecidos de KeyOperation que o serviço aceita.

Valores conhecidos do <xref:JsonWebKeyType> que o serviço aceita.

Valores conhecidos do <xref:JsonWebKeySignatureAlgorithm> que o serviço aceita.

Analisa o ID da Chave de Key Vault especificado. Um exemplo é:

https://.vault.azure.net/keys//

Ao analisar o ID acima, esta função devolve:

  {
     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>"
  }