@azure/keyvault-keys package

Klasy

CryptographyClient	Klient używany do wykonywania operacji kryptograficznych na kluczu usługi Azure Key Vault lub lokalnym <xref:JsonWebKey>.
KeyClient	Usługa KeyClient udostępnia metody zarządzania <xref: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 <xref: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 <xref:backupKey>.
BeginDeleteKeyOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:beginDeleteKey>
BeginRecoverDeletedKeyOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:beginRecoverDeletedKey>
CreateEcKeyOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:createEcKey>
CreateKeyOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:createKey>
CreateOctKeyOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:createOctKey>
CreateRsaKeyOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:createRsaKey>
CryptographyClientOptions	Opcjonalne parametry akceptowane przez element CryptographyClient programu KeyVault
CryptographyOptions	Interfejs reprezentujący opcje metod interfejsu API kryptografii, przejdź do <xref:CryptographyClient>, aby uzyskać więcej informacji.
DecryptOptions	Opcje <xref:decrypt>.
DecryptResult	Wynik operacji <xref:decrypt>.
DeletedKey	Interfejs reprezentujący usunięty klucz usługi Key Vault.
EncryptOptions	Opcje <xref:encrypt>.
EncryptResult	Wynik operacji <xref:encrypt>.
GetDeletedKeyOptions	Opcje <xref:getDeletedKey>.
GetKeyOptions	Opcje <xref:getKey>.
ImportKeyOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:importKey>
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 <xref:beginDeleteKey> i <xref:beginRecoverDeletedKey>
KeyProperties	Interfejs reprezentujący właściwości <xref:KeyVaultKey>
KeyVaultKey	Interfejs reprezentujący klucz usługi Key Vault z jego nazwą, wartością i <xref:KeyProperties>.
KeyVaultKeyIdentifier	Reprezentuje segmenty tworzące identyfikator klucza usługi Key Vault.
ListDeletedKeysOptions	Interfejs reprezentujący opcjonalne parametry operacji stronicowanych KeyClient przekazanych do <xref:listDeletedKeys>.
ListPropertiesOfKeyVersionsOptions	Interfejs reprezentujący opcjonalne parametry operacji stronicowanych KeyClient przekazanych do <xref:listPropertiesOfKeyVersions>.
ListPropertiesOfKeysOptions	Interfejs reprezentujący opcjonalne parametry operacji stronicowanych KeyClient przekazanych do <xref:listPropertiesOfKeys>.
PurgeDeletedKeyOptions	Opcje <xref:purgeDeletedKey>.
RestoreKeyBackupOptions	Opcje <xref:restoreKeyBackup>.
RsaDecryptParameters	Parametry odszyfrowywania dla algorytmów szyfrowania RSA.
RsaEncryptParameters	Parametry szyfrowania dla algorytmów szyfrowania RSA.
SignOptions	Opcje <xref:sign>.
SignResult	Wynik operacji <xref:sign>.
UnwrapKeyOptions	Opcje <xref:unwrapKey>.
UnwrapResult	Wynik operacji <xref:unwrap>.
UpdateKeyPropertiesOptions	Opcje <xref:updateKeyProperties>.
VerifyDataOptions	Opcje <xref:verifyData>
VerifyOptions	Opcje <xref:verify>.
VerifyResult	Wynik operacji <xref:verify>.
WrapKeyOptions	Opcje <xref:wrapKey>.
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. <xref:KnownDeletionRecoveryLevel> można używać zamiennie z elementem DeletionRecoveryLevel, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znajomość wartości obsługiwanych 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ę. Znajomość wartości obsługiwanych 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ę. Znajomość wartości obsługiwanych 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.
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ę. Znajomość wartości obsługiwanych przez usługę szyfrowanie odszyfrowywania podpisywania weryfikować zawijaniekey unwrapKey importowania
KeyType	Definiuje wartości JsonWebKeyType. <xref:KnownJsonWebKeyType> można używać zamiennie z JsonWebKeyType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znajomość wartości obsługiwanych przez usługę EC: Krzywa eliptyczna. ec-HSM: Krzywa eliptyczna z kluczem prywatnym, który nie można wyeksportować z modułu HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA z kluczem prywatnym, który nie można wyeksportować z modułu HSM. października: sekwencja oktetów (używana do reprezentowania kluczy symetrycznych) oct-HSM: sekwencja oktetów (używana do reprezentowania kluczy symetrycznych), która nie jest eksportowana z modułu 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ę. Znajomość wartości obsługiwanych 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: Zarezerwowane 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 <xref:DeletionRecoveryLevel> akceptowanych przez usługę.
KnownEncryptionAlgorithms	Znane wartości <xref:JsonWebKeyEncryptionAlgorithm> akceptowanych przez usługę.
KnownKeyCurveNames	Znane wartości <xref:JsonWebKeyCurveName> akceptowanych przez usługę.
KnownKeyOperations	Znane wartości <xref:JsonWebKeyOperation> akceptowanych 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 podany identyfikator klucza Key Vault. Przykładem jest: https://< nazwa-magazynu.vault.azure.net/keys/>< nazwa-klucza>/<unikatowy-identyfikator-wersji-> 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 podany identyfikator klucza Key Vault. Przykładem jest: https://< nazwa-magazynu.vault.azure.net/keys/>< nazwa-klucza>/<unikatowy-identyfikator-wersji->

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)

Parametry

id

string

Identyfikator klucza usługi Key Vault.

Zwraca

KeyVaultKeyIdentifier