Udostępnij za pośrednictwem

@azure/keyvault-keys package

  • Odwołanie

Klasy

CryptographyClient

Klient używany do wykonywania operacji kryptograficznych na kluczu usługi Azure Key Vault lub lokalnym JsonWebKey.
KeyClient

Obiekt KeyClient udostępnia metody zarządzania KeyVaultKey w usłudze Azure Key Vault. Klient obsługuje tworzenie, pobieranie, aktualizowanie, usuwanie, przeczyszczanie, tworzenie kopii zapasowej, przywracanie i wyświetlanie listy kluczy KeyVaultKeys. Klient obsługuje również wyświetlanie listy DeletedKey dla usługi Azure Key Vault z włączoną obsługą usuwania nietrwałego.

Interfejsy

AesCbcDecryptParameters

Parametry odszyfrowywania dla algorytmów szyfrowania AES-CBC.
AesCbcEncryptParameters

Parametry szyfrowania dla algorytmów szyfrowania AES-CBC.
AesGcmDecryptParameters

Parametry odszyfrowywania dla algorytmów szyfrowania AES-GCM.
AesGcmEncryptParameters

Parametry szyfrowania dla algorytmów szyfrowania AES-GCM.
BackupKeyOptions

Opcje backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions

Opcjonalne parametry akceptowane przez element CryptographyClient programu KeyVault
CryptographyOptions

Interfejs reprezentujący opcje metod interfejsu API kryptografii przejdź do CryptographyClient, aby uzyskać więcej informacji.
DecryptOptions

Opcje decrypt(DecryptParameters, DecryptOptions).
DecryptResult

Wynik operacji decrypt(DecryptParameters, DecryptOptions).
DeletedKey

Interfejs reprezentujący usunięty klucz usługi Key Vault.
EncryptOptions

Opcje encrypt(EncryptParameters, EncryptOptions).
EncryptResult

Wynik operacji encrypt(EncryptParameters, EncryptOptions).
GetCryptographyClientOptions

Opcje getCryptographyClient.
GetDeletedKeyOptions

Opcje getDeletedKey(string, GetDeletedKeyOptions).
GetKeyOptions

Opcje getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions

Opcje <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions

Opcje getRandomBytes
ImportKeyOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do importKey(string, JsonWebKey, 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 parametry opcjonalne, które można przekazać do beginDeleteKey(string, BeginDeleteKeyOptions) i beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties

Interfejs reprezentujący właściwości KeyVaultKey
KeyReleasePolicy

Reguły zasad, w ramach których można wyeksportować klucz.
KeyRotationLifetimeAction

Akcja i odpowiadający jej wyzwalacz, który będzie wykonywany przez usługę 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żna również zresetować zasady rotacji kluczy do jej wartości domyślnych, ustawiając okres istnieniaActions na pustą tablicę.
KeyVaultKey

Interfejs reprezentujący klucz usługi Key Vault z jego nazwą, wartością i KeyProperties.
KeyVaultKeyIdentifier

Reprezentuje segmenty tworzące identyfikator klucza usługi Key Vault.
ListDeletedKeysOptions

Interfejs reprezentujący opcjonalne parametry operacji stronicowanych KeyClient przekazanych do listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions

Interfejs reprezentujący opcjonalne parametry operacji stronicowanych KeyClient przekazanych do listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions

Interfejs reprezentujący opcjonalne parametry operacji stronicowanych KeyClient przekazanych do listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings

Interfejs śledzący ustawienia iteracji stronicowanej
PagedAsyncIterableIterator

Interfejs, który umożliwia iterację asynchronialną 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 purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions

Opcje releaseKey
ReleaseKeyResult

Wynik operacji releaseKey.
RestoreKeyBackupOptions

Opcje restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions

Opcje rotateKey
RsaDecryptParameters

Parametry odszyfrowywania dla algorytmów szyfrowania RSA.
RsaEncryptParameters

Parametry szyfrowania dla algorytmów szyfrowania RSA.
SignOptions

Opcje sign(string, Uint8Array, SignOptions).
SignResult

Wynik operacji sign(string, Uint8Array, SignOptions).
UnwrapKeyOptions

Opcje unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult

Wynik operacji <xref:unwrap>.
UpdateKeyPropertiesOptions

Opcje updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions

Opcje updateKeyRotationPolicy
VerifyDataOptions

Opcje verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions

Opcje verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult

Wynik operacji verify(string, Uint8Array, Uint8Array, VerifyOptions).
WrapKeyOptions

Opcje wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult

Wynik operacji <xref:wrap>.

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, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

można przeczyścić: określa stan magazynu, w którym usunięcie jest operacją nieodwracalną bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuwania na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)
możliwe do odzyskania i przeczyszczania: oznacza stan magazynu, w którym można odzyskać, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w przedziale przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
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 zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
możliwe do odzyskania+ChronioneSubskrypcja: oznacza magazyn i stan subskrypcji, w którym usunięcie można odzyskać w przedziale 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 zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
CustomizedRecoverable+Purgeable: oznacza 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 okresie 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: oznacza magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone 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, które mają zastosowanie do różnych algorytmów szyfrowania.
EncryptionAlgorithm

Definiuje wartości dla JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> można używać zamiennie z JsonWebKeyEncryptionAlgorithm, 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 dla JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> można używać zamiennie z JsonWebKeyCurveName, 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 eliptyczna NIST P-521, krzywa AKA SECG SECP521R1.
P-256K: krzywa eliptyczna SECG SECP256K1.
KeyExportEncryptionAlgorithm

Definiuje wartości keyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm można używać zamiennie z kluczem KeyEncryptionAlgorithm, 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, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

szyfrowanie
odszyfrowywania
podpisywania
weryfikować
zawijaniekey
unwrapKey
importowania
eksportowania
KeyRotationPolicyAction

Akcja, która zostanie wykonana.
KeyType

Definiuje wartości JsonWebKeyType.
<xref:KnownJsonWebKeyType> można używać zamiennie z JsonWebKeyType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

EC: Krzywa eliptyczna.
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.
października: sekwencja oktetów (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 dla JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> można używać zamiennie z JsonWebKeySignatureAlgorithm, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

PS256: RSASSA-PSS przy użyciu algorytmów SHA-256 i MGF1 z algorytmem SHA-256, zgodnie z opisem w https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS przy użyciu algorytmów SHA-384 i MGF1 z algorytmem SHA-384, zgodnie z opisem w https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS przy użyciu algorytmów SHA-512 i MGF1 z algorytmem SHA-512 zgodnie z opisem w https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 przy użyciu algorytmu SHA-256 zgodnie z opisem w https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 przy użyciu algorytmu SHA-384 zgodnie z opisem w https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 przy użyciu algorytmu SHA-512 zgodnie z opisem w https://tools.ietf.org/html/rfc7518
RSNULL: Reserved
ES256: ECDSA przy użyciu P-256 i SHA-256, zgodnie z opisem w https://tools.ietf.org/html/rfc7518.
ES384: ECDSA przy użyciu P-384 i SHA-384, zgodnie z opisem w https://tools.ietf.org/html/rfc7518
ES512: ECDSA przy użyciu P-521 i SHA-512 zgodnie z opisem w https://tools.ietf.org/html/rfc7518
ES256K: ECDSA przy użyciu P-256K i SHA-256, zgodnie z opisem w https://tools.ietf.org/html/rfc7518

Wyliczenia

KnownDeletionRecoveryLevel

Znane wartości DeletionRecoveryLevel akceptowane przez usługę.
KnownEncryptionAlgorithms

Znane wartości EncryptionAlgorithm akceptowane przez usługę.
KnownKeyCurveNames

Znane wartości <xref:JsonWebKeyCurveName> akceptowanych przez usługę.
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> akceptowanych przez usługę.
KnownSignatureAlgorithms

Znane wartości <xref:JsonWebKeySignatureAlgorithm> akceptowanych przez usługę.

Funkcje

parseKeyVaultKeyIdentifier(string)

Analizuje dany identyfikator klucza usługi Key Vault. Przykład:

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

Podczas analizowania powyższego identyfikatora ta funkcja zwraca następujące elementy:

  {
     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 dany identyfikator klucza usługi Key Vault. Przykład:

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

Podczas analizowania powyższego identyfikatora ta funkcja zwraca następujące elementy:

  {
     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 usługi Key Vault.

Zwraca

KeyVaultKeyIdentifier