@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).
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á 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	Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se contiver 'Purgeable', o certificado pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o certificado, no final do intervalo de retenção. KnownDeletionRecoveryLevel pode ser usado de forma intercambiável com DeletionRecoveryLevel, esse enum contém os valores conhecidos suportados pelo serviço. 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.) Recoverable+Purgeable: Indica um estado vault no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga). 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado recuperável : Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga). 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado Recoverable+ProtectedSubscription: indica um estado de cofre e 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado CustomizedRecoverable+Purgeable: Indica um estado do cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga 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 Purge seja solicitada ou a assinatura seja cancelada. CustomizedRecoverable: Indica 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. CustomizedRecoverable+ProtectedSubscription: Indica um estado de cofre e 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 assinatura em si não pode ser cancelada.
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	Um algoritmo usado para encriptação e desencriptação. <xref:KnownJsonWebKeyEncryptionAlgorithm> pode ser usado de forma intercambiável com JsonWebKeyEncryptionAlgorithm, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço RSA-OAEP: [Não recomendado] RSAES usando Optimal Asymmetric Encryption Padding (OAEP), conforme descrito no https://tools.ietf.org/html/rfc3447, com os parâmetros padrão especificados pela RFC 3447 na Seção A.2.1. Estes parâmetros predefinidos estão a utilizar uma função hash de SHA-1 e uma função de geração de máscara de MGF1 com SHA-1. A Microsoft recomenda o uso de algoritmos RSA_OAEP_256 ou mais fortes para maior segurança. A Microsoft não recomenda RSA_OAEP, que é incluído apenas para compatibilidade com versões anteriores. RSA_OAEP utiliza SHA1, que tem problemas de colisão conhecidos. RSA-OAEP-256: RSAES usando preenchimento de criptografia assimétrica ideal com uma função de hash de 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 o uso de algoritmos RSA_OAEP_256 ou mais fortes para maior segurança. A Microsoft não recomenda RSA_1_5, que é incluído apenas para compatibilidade com versões anteriores. Os padrões criptográficos não consideram mais RSA com o esquema de preenchimento PKCS#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: wrap de chave AES de 128 bits. A192KW: wrap de chave AES de 192 bits. A256KW: wrap de 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: Wrap chave CKM AES. CKM_AES_KEY_WRAP_PAD: Wrap de chave CKM AES com preenchimento.
KeyCurveName	Nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> pode ser usado de forma intercambiável com JsonWebKeyCurveName, este 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, AKA curva SECG SECP256R1. P-384: A curva elíptica NIST P-384, AKA SECG curva SECP384R1. P-521: A curva elíptica NIST P-521, AKA SECG curva SECP521R1. P-256K: A curva elíptica SECG SECP256K1.
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 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, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço criptografar: Indica que a chave pode ser usada para criptografar. desencriptar: Indica que a chave pode ser usada para desencriptar. sinal: Indica que a chave pode ser usada para assinar. verificar: Indica que 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. de exportação : Indica que o componente privado da chave pode ser exportado.
KeyRotationPolicyAction	A ação que será executada.
KeyType	JsonWebKey Key Type (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, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço EC: Curva Elíptica. EC-HSM: Curva elíptica com uma chave privada que é armazenada no HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA com uma chave privada que é armazenada no HSM. out: Sequência Octet (usada para representar chaves simétricas) oct-HSM: Sequência Octet (usada para representar chaves simétricas) que é armazenada o HSM.
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	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, este enum contém os valores conhecidos que o serviço suporta. 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 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 no 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 no 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 contiver 'Purgeable', o certificado pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o certificado, no final do intervalo de retenção.
KnownEncryptionAlgorithms	Um algoritmo usado para encriptação e desencriptação.
KnownKeyCurveNames	Nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName.
KnownKeyExportEncryptionAlgorithm	O algoritmo de encriptação a utilizar para proteger o material da chave exportada
KnownKeyOperations	Os valores conhecidos de KeyOperation que o serviço aceita.
KnownKeyTypes	JsonWebKey Key Type (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 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>"
  }

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): KeyVaultKeyIdentifier

Parâmetros

id: string

O id da chave do cofre da chave.

Devoluções

KeyVaultKeyIdentifier

Partilhar via

@azure/keyvault-keys package

Classes

Interfaces

Aliases de Tipo

Valores conhecidos suportados pelo serviço

Valores conhecidos suportados pelo serviço

Valores conhecidos suportados pelo serviço

Valores conhecidos suportados pelo serviço

Valores conhecidos suportados pelo serviço

Valores conhecidos suportados pelo serviço

Valores conhecidos suportados pelo serviço

Enumerações

Funções

Detalhes de Função

parseKeyVaultKeyIdentifier(string)

Parâmetros

Devoluções