@azure/keyvault-keys package

Klasy

CryptographyClient	Klient używany do wykonywania operacji kryptograficznych na kluczu usługi Azure Key Vault lub lokalnym kluczu JsonWebKey.
KeyClient	Obiekt KeyClient udostępnia metody zarządzania kluczem KeyVaultKey w usłudze Azure Key Vault. Klient obsługuje tworzenie, pobieranie, aktualizowanie, usuwanie, przeczyszczanie, tworzenie kopii zapasowych, przywracanie i wyświetlanie listy KeyVaultKeys. Klient obsługuje również wyświetlanie listy DeletedKey dla nietrwałego usuwania z włączoną usługą Azure Key Vault.

Interfejsy

AesCbcDecryptParameters	Parametry odszyfrowywania algorytmów szyfrowania AES-CBC.
AesCbcEncryptParameters	Parametry szyfrowania algorytmów szyfrowania AES-CBC.
AesGcmDecryptParameters	Parametry odszyfrowywania algorytmów szyfrowania AES-GCM.
AesGcmEncryptParameters	Parametry szyfrowania algorytmów szyfrowania AES-GCM.
BackupKeyOptions	Opcje dla .backupKey(string, BackupKeyOptions)
BeginDeleteKeyOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions	Opcjonalne parametry akceptowane przez program CryptographyClient usługi KeyVault
CryptographyOptions	Interfejs reprezentujący opcje metod interfejsu API kryptografii przejdź do obiektu CryptographyClient , aby uzyskać więcej informacji.
DecryptOptions	Opcje dla .decrypt(DecryptParameters, DecryptOptions)
DecryptResult	decrypt(DecryptParameters, DecryptOptions) Wynik operacji.
DeletedKey	Interfejs reprezentujący usunięty klucz Key Vault.
EncryptOptions	Opcje dla .encrypt(EncryptParameters, EncryptOptions)
EncryptResult	encrypt(EncryptParameters, EncryptOptions) Wynik operacji.
GetCryptographyClientOptions	Opcje getCryptographyClient.
GetDeletedKeyOptions	Opcje dla .getDeletedKey(string, GetDeletedKeyOptions)
GetKeyOptions	Opcje dla .getKey(string, GetKeyOptions)
GetKeyRotationPolicyOptions	Opcje dla <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions	Opcje getRandomBytes
ImportKeyOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do importKey(string, JsonWebKey_2, ImportKeyOptions)
JsonWebKey	Od http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions	Opcjonalne parametry akceptowane przez klienta KeyVault
KeyPollerOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginDeleteKey(string, BeginDeleteKeyOptions) i beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties	Interfejs reprezentujący właściwości klucza KeyVaultKey
KeyReleasePolicy	Reguły zasad, w ramach których można wyeksportować klucz.
KeyRotationLifetimeAction	Akcja i odpowiedni wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia klucza.
KeyRotationPolicy	Pełne zasady rotacji kluczy, które należą do klucza.
KeyRotationPolicyProperties	Właściwości zasad rotacji kluczy, które klient może ustawić dla danego klucza. Możesz również zresetować zasady rotacji kluczy do jego wartości domyślnych, ustawiając okres istnieniaActions na pustą tablicę.
KeyVaultKey	Interfejs reprezentujący klucz Key Vault z jego nazwą, wartością i właściwościami KeyProperties.
KeyVaultKeyIdentifier	Reprezentuje segmenty tworzące identyfikator klucza Key Vault.
ListDeletedKeysOptions	Interfejs reprezentujący opcjonalne parametry operacji stronicowanych keyClient przekazanych do listDeletedKeys(ListDeletedKeysOptions)elementu .
ListPropertiesOfKeyVersionsOptions	Interfejs reprezentujący opcjonalne parametry operacji stronicowanych keyClient przekazanych do listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)elementu .
ListPropertiesOfKeysOptions	Interfejs reprezentujący opcjonalne parametry operacji stronicowanych keyClient przekazanych do listPropertiesOfKeys(ListPropertiesOfKeysOptions)elementu .
PageSettings	Interfejs śledzący ustawienia stronicowanej iteracji
PagedAsyncIterableIterator	Interfejs, który umożliwia iterację asynchronizalną zarówno do ukończenia, jak i według strony.
PollOperationState	PollOperationState zawiera listę najdrobniejszych zestawów właściwości potrzebnych do zdefiniowania dowolnej długotrwałej operacji poller. Podczas gdy klasa Poller działa jako lokalny mechanizm sterowania, aby rozpocząć wyzwalanie, czekać i potencjalnie anulować długotrwałą operację, PollOperationState dokumentuje stan zdalnej długotrwałej operacji. Powinna zostać zaktualizowana co najmniej po rozpoczęciu operacji, zakończeniu i anulowaniu. Jednak implementacje mogą mieć dowolną inną liczbę właściwości, które mogą być aktualizowane z innych powodów.
PollerLike	Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.
PurgeDeletedKeyOptions	Opcje dla .purgeDeletedKey(string, PurgeDeletedKeyOptions)
ReleaseKeyOptions	Opcje releaseKey
ReleaseKeyResult	Wynik operacji releaseKey .
RestoreKeyBackupOptions	Opcje dla .restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)
RotateKeyOptions	Opcje rotacjiKey
RsaDecryptParameters	Parametry odszyfrowywania algorytmów szyfrowania RSA.
RsaEncryptParameters	Parametry szyfrowania algorytmów szyfrowania RSA.
SignOptions	Opcje dla .sign(string, Uint8Array, SignOptions)
SignResult	sign(string, Uint8Array, SignOptions) Wynik operacji.
UnwrapKeyOptions	Opcje dla .unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)
UnwrapResult	<xref:unwrap> Wynik operacji.
UpdateKeyPropertiesOptions	Opcje dla .updateKeyProperties(string, string, UpdateKeyPropertiesOptions)
UpdateKeyRotationPolicyOptions	Opcje aktualizacjiKeyRotationPolicy
VerifyDataOptions	Opcje dla verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions	Opcje dla .verify(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyResult	verify(string, Uint8Array, Uint8Array, VerifyOptions) Wynik operacji.
WrapKeyOptions	Opcje dla .wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)
WrapResult	<xref:wrap> Wynik operacji.

Aliasy typu

AesCbcEncryptionAlgorithm	Typ unii reprezentujący wszystkie obsługiwane algorytmy szyfrowania AES-CBC.
AesGcmEncryptionAlgorithm	Typ unii reprezentujący wszystkie obsługiwane algorytmy szyfrowania AES-GCM.
DecryptParameters	Typ reprezentujący wszystkie aktualnie obsługiwane parametry odszyfrowywania, które mają zastosowanie do różnych algorytmów szyfrowania.
DeletionRecoveryLevel	Definiuje wartości elementu DeletionRecoveryLevel. KnownDeletionRecoveryLevel można używać zamiennie z elementem DeletionRecoveryLevel. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Możliwe do przeczyszczenia: określa stan magazynu, w którym usunięcie jest nieodwracalną operacją bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuń na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.) Możliwe do odzyskania+Przeczyszczanie: określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane Możliwe do odzyskania: określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane Możliwe do odzyskania+ChronioneSubskrypcja: oznacza magazyn i stan subskrypcji, w którym usunięcie można odzyskać w okresie przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane CustomizedRecoverable+Purgeable: określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w przedziale czasu przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. CustomizedRecoverable: określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna. CustomizedRecoverable+ProtectedSubscription: określa stan magazynu i subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7<= SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana.
EncryptParameters	Typ reprezentujący wszystkie aktualnie obsługiwane parametry szyfrowania stosowane do różnych algorytmów szyfrowania.
EncryptionAlgorithm	Definiuje wartości dla JsonWebKeyEncryptionAlgorithm. <xref:KnownJsonWebKeyEncryptionAlgorithm> można używać zamiennie z JsonWebKeyEncryptionAlgorithm, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę RSA-OAEP RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	Definiuje wartości JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> można używać zamiennie z JsonWebKeyCurveName. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę P-256: Krzywa eliptyczna NIST P-256, Krzywa AKA SECG SECP256R1. P-384: Krzywa eliptyczna NIST P-384, krzywa AKA SECG SECP384R1. P-521: Krzywa wielokropowa NIST P-521, krzywa AKA SECG SECP521R1. P-256K: Krzywa eliptyczna SECG SECP256K1.
KeyExportEncryptionAlgorithm	Definiuje wartości keyEncryptionAlgorithm. ZnaneKeyExportEncryptionAlgorithm można używać zamiennie z kluczem KeyEncryptionAlgorithm. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	Definiuje wartości dla JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> można używać zamiennie z JsonWebKeyOperation, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Szyfrowania Odszyfrować sign verify zawijaniekey unwrapKey Importu Eksportu
KeyRotationPolicyAction	Akcja, która zostanie wykonana.
KeyType	Definiuje wartości JsonWebKeyType. <xref:KnownJsonWebKeyType> można używać zamiennie z JsonWebKeyType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę EC: Krzywa eliptyczna. Moduł EC-HSM: Krzywa eliptyczna z kluczem prywatnym przechowywanym w module HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA z kluczem prywatnym przechowywanym w module HSM. oct: sekwencja octet (używana do reprezentowania kluczy symetrycznych) oct-HSM: sekwencja octet (używana do reprezentowania kluczy symetrycznych), która jest przechowywana w module HSM.
KeyWrapAlgorithm	Obsługiwane algorytmy opakowujące/rozpakowujące klucze
RsaEncryptionAlgorithm	Typ unii reprezentujący wszystkie obsługiwane algorytmy szyfrowania RSA.
SignatureAlgorithm	Definiuje wartości JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> można używać zamiennie z JsonWebKeySignatureAlgorithm, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę PS256: RSASSA-PSS przy użyciu algorytmu SHA-256 i MGF1 z algorytmem SHA-256, zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS przy użyciu algorytmu SHA-384 i MGF1 z algorytmem SHA-384, zgodnie z opisem w artykule https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS przy użyciu algorytmu SHA-512 i MGF1 z algorytmem SHA-512, zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 przy użyciu algorytmu SHA-256 zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 przy użyciu algorytmu SHA-384 zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 przy użyciu algorytmu SHA-512 zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518 RSNULL: zarezerwowane ES256: ECDSA przy użyciu protokołu P-256 i SHA-256 zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518. ES384: ECDSA przy użyciu protokołu P-384 i SHA-384 zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518 ES512: ECDSA przy użyciu protokołu P-521 i SHA-512 zgodnie z opisem w temacie https://tools.ietf.org/html/rfc7518 ES256K: ECDSA przy użyciu P-256K i SHA-256, zgodnie z opisem w artykule https://tools.ietf.org/html/rfc7518

Wyliczenia

KnownDeletionRecoveryLevel	Znane wartości DeletionRecoveryLevel , które akceptuje usługa.
KnownEncryptionAlgorithms	Znane wartości EncryptionAlgorithm , które akceptuje usługa.
KnownKeyCurveNames	Znane wartości, <xref:JsonWebKeyCurveName> które akceptuje usługa.
KnownKeyExportEncryptionAlgorithm	Znane wartości KeyExportEncryptionAlgorithm , które akceptuje usługa.
KnownKeyOperations	Znane wartości KeyOperation akceptowane przez usługę.
KnownKeyTypes	Znane wartości, <xref:JsonWebKeyType> które akceptuje usługa.
KnownSignatureAlgorithms	Znane wartości, <xref:JsonWebKeySignatureAlgorithm> które akceptuje usługa.

Funkcje

parseKeyVaultKeyIdentifier(string)

Analizuje podany identyfikator klucza Key Vault. Przykład: https://.vault.azure.net/keys// Po przeanalizowaniu powyższego identyfikatora ta funkcja zwraca: { 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>" }

Szczegóły funkcji

parseKeyVaultKeyIdentifier(string)

Analizuje podany identyfikator klucza Key Vault. Przykład:

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

Po przeanalizowaniu powyższego identyfikatora ta funkcja zwraca:

  {
     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

Parametry

id

string

Identyfikator klucza Key Vault.

Zwraca

KeyVaultKeyIdentifier