@azure/keyvault-keys package

類別

CryptographyClient	用來在 Azure Key Vault 金鑰或本機 JsonWebKey上執行密碼編譯作業的用戶端。
KeyClient	KeyClient 提供方法來管理 Azure Key Vault 中的 KeyVaultKey。 用戶端支援建立、擷取、更新、刪除、清除、備份、還原及列出KeyVaultKeys。 用戶端也支援針對已啟用虛刪除的 Azure Key Vault 列出 DeletedKey。

介面

AesCbcDecryptParameters	AES-CBC 加密演算法的解密參數。
AesCbcEncryptParameters	AES-CBC 加密演演算法的加密參數。
AesGcmDecryptParameters	AES-GCM 加密演算法的解密參數。
AesGcmEncryptParameters	AES-GCM 加密演演算法的加密參數。
BackupKeyOptions	backupKey(string, BackupKeyOptions)的選項。
BeginDeleteKeyOptions	介面，表示可傳遞至 beginDeleteKey(string, BeginDeleteKeyOptions) 的選擇性參數
BeginRecoverDeletedKeyOptions	介面，表示可傳遞至 beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) 的選擇性參數
CreateEcKeyOptions	介面，表示可傳遞至 createEcKey(string, CreateEcKeyOptions) 的選擇性參數
CreateKeyOptions	介面，表示可傳遞至 createKey(string, string, CreateKeyOptions) 的選擇性參數
CreateOctKeyOptions	介面，表示可傳遞至 createOctKey(string, CreateOctKeyOptions) 的選擇性參數
CreateRsaKeyOptions	介面，表示可傳遞至 createRsaKey(string, CreateRsaKeyOptions) 的選擇性參數
CryptographyClientOptions	KeyVault 的 CryptographyClient 接受的選擇性參數
CryptographyOptions	代表密碼編譯 API 方法選項的介面，如需詳細資訊，請移至 CryptographyClient。
DecryptOptions	decrypt(DecryptParameters, DecryptOptions)的選項。
DecryptResult	decrypt(DecryptParameters, DecryptOptions) 作業的結果。
DeletedKey	介面，表示已刪除的 Key Vault 金鑰。
EncryptOptions	encrypt(EncryptParameters, EncryptOptions)的選項。
EncryptResult	encrypt(EncryptParameters, EncryptOptions) 作業的結果。
GetCryptographyClientOptions	getCryptographyClient的選項。
GetDeletedKeyOptions	getDeletedKey(string, GetDeletedKeyOptions)的選項。
GetKeyOptions	getKey(string, GetKeyOptions)的選項。
GetKeyRotationPolicyOptions	<xref:KeyClient.getRotationPolicy> 的選項
GetRandomBytesOptions	getRandomBytes 的選項
ImportKeyOptions	介面，表示可傳遞至 importKey(string, JsonWebKey, ImportKeyOptions) 的選擇性參數
JsonWebKey	自 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 起
KeyClientOptions	KeyVault 的 KeyClient 接受的選擇性參數
KeyPollerOptions	介面，表示可傳遞至 beginDeleteKey(string, BeginDeleteKeyOptions) 和 beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) 的選擇性參數
KeyProperties	介面，表示 KeyVaultKey 屬性
KeyReleasePolicy	可匯出金鑰的原則規則。
KeyRotationLifetimeAction	動作及其對應的觸發程式，將在密鑰存留期內由 Key Vault 執行。
KeyRotationPolicy	屬於金鑰的完整金鑰輪替原則。
KeyRotationPolicyProperties	用戶端可以為指定金鑰設定的金鑰輪替原則屬性。 您也可以將 lifetimeActions 設定為空陣列，將密鑰輪替原則重設為預設值。
KeyVaultKey	代表 Key Vault 金鑰的介面，其名稱、值和 KeyProperties。
KeyVaultKeyIdentifier	代表組成 Key Vault 金鑰標識碼的區段。
ListDeletedKeysOptions	介面，表示傳遞至 listDeletedKeys(ListDeletedKeysOptions)之 KeyClient 分頁作業的選擇性參數。
ListPropertiesOfKeyVersionsOptions	介面，表示傳遞至 listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)之 KeyClient 分頁作業的選擇性參數。
ListPropertiesOfKeysOptions	介面，表示傳遞至 listPropertiesOfKeys(ListPropertiesOfKeysOptions)之 KeyClient 分頁作業的選擇性參數。
PageSettings	追蹤分頁反覆運算設定的介面
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PollOperationState	PollOperationState 包含定義任何長時間執行之作業輪詢器所需的最小屬性集意見清單。 雖然 Poller 類別會當做本機控制機制來開始觸發、等候，並可能取消長時間執行的作業，但 PollOperationState 會記錄遠端長時間執行作業的狀態。 它至少應在作業啟動時、完成時，以及取消時更新。 不過，實作可以有任何其他數目的屬性，這些屬性可能會因為其他原因而更新。
PollerLike	輪詢器抽象表示法，旨在只公開使用者需要使用的最小 API。
PurgeDeletedKeyOptions	purgeDeletedKey(string, PurgeDeletedKeyOptions)的選項。
ReleaseKeyOptions	releaseKey 的選項
ReleaseKeyResult	releaseKey 作業的結果。
RestoreKeyBackupOptions	restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)的選項。
RotateKeyOptions	rotateKey 的選項
RsaDecryptParameters	RSA 加密演算法的解密參數。
RsaEncryptParameters	RSA 加密演算法的加密參數。
SignOptions	sign(string, Uint8Array, SignOptions)的選項。
SignResult	sign(string, Uint8Array, SignOptions) 作業的結果。
UnwrapKeyOptions	unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)的選項。
UnwrapResult	<xref:unwrap> 作業的結果。
UpdateKeyPropertiesOptions	updateKeyProperties(string, string, UpdateKeyPropertiesOptions)的選項。
UpdateKeyRotationPolicyOptions	updateKeyRotationPolicy 的選項
VerifyDataOptions	verifyData(string, Uint8Array, Uint8Array, VerifyOptions) 的選項
VerifyOptions	verify(string, Uint8Array, Uint8Array, VerifyOptions)的選項。
VerifyResult	verify(string, Uint8Array, Uint8Array, VerifyOptions) 作業的結果。
WrapKeyOptions	wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)的選項。
WrapResult	<xref:wrap> 作業的結果。

類型別名

AesCbcEncryptionAlgorithm	聯集類型，表示所有支援的 AES-CBC 加密演算法。
AesGcmEncryptionAlgorithm	聯集類型，表示所有支援的 AES-GCM 加密演算法。
DecryptParameters	類型，代表所有目前支援的解密參數，因為它們會套用至不同的加密演算法。
DeletionRecoveryLevel	定義DeletionRecoveryLevel的值。 KnownDeletionRecoveryLevel 可以與 DeletionRecoveryLevel 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 可清除：表示保存庫狀態，其中刪除是無法復原的作業，而無法復原。 此層級對應至無法對刪除作業提供保護;在接受實體層級或更高層級的刪除作業時，數據會無法復原（保存庫、資源群組、訂用帳戶等） 可復原+可清除：表示可復原刪除的保存庫狀態，也允許立即和永久刪除（亦即清除）。 此層級保證刪除實體在保留間隔期間 （90 天） 的復原能力，除非要求清除作業，或取消訂閱。 系統 wil 會在 90 天后永久刪除，如果未復原 可復原：表示可復原刪除的保存庫狀態，而無法立即和永久刪除（亦即清除）。 此層級可保證已刪除實體在保留間隔（90 天）和訂用帳戶仍可使用期間復原。 系統 wil 會在 90 天后永久刪除，如果未復原 Recoverable+ProtectedSubscription：表示保存庫和訂用帳戶狀態，在保留間隔（90 天）、立即和永久刪除期間內可復原的保存庫和訂用帳戶狀態，且不允許永久取消訂閱本身。 系統 wil 會在 90 天后永久刪除，如果未復原 CustomizedRecoverable+Purgeable：表示可復原刪除的保存庫狀態，也允許立即和永久刪除（也就是當 7<= SoftDeleteRetentionInDays < 90 時清除）。 除非要求清除作業或取消訂閱，否則此層級保證在保留間隔期間已刪除實體的復原能力。 CustomizedRecoverable：表示可復原刪除的保存庫狀態，而無法立即和永久刪除（亦即當 7<= SoftDeleteRetentionInDays < 90 時清除）。此層級可保證已刪除實體在保留間隔期間和訂用帳戶仍可使用時的復原能力。 CustomizedRecoverable+ProtectedSubscription：表示無法復原刪除的保存庫和訂閱狀態，不允許立即和永久刪除（亦即清除），而且當 7<= SoftDeleteRetentionInDays < 90 時，將無法永久取消訂閱本身。 此層級保證在保留間隔期間已刪除實體的復原能力，也反映無法取消訂閱本身的事實。
EncryptParameters	類型，代表所有目前支援的加密參數，因為它們會套用至不同的加密演算法。
EncryptionAlgorithm	定義 JsonWebKeyEncryptionAlgorithm 的值。 <xref:KnownJsonWebKeyEncryptionAlgorithm> 可與 JsonWebKeyEncryptionAlgorithm 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 RSA-OAEP RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	定義 JsonWebKeyCurveName 的值。 <xref:KnownJsonWebKeyCurveName> 可以與 JsonWebKeyCurveName 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 P-256：NIST P-256 橢圓曲線，AKA SECG 曲線SECP256R1。 P-384：NIST P-384 橢圓曲線，AKA SECG 曲線SECP384R1。 P-521：NIST P-521 橢圓曲線，AKA SECG 曲線SECP521R1。 P-256K：SECG SECP256K1橢圓曲線。
KeyExportEncryptionAlgorithm	定義 KeyEncryptionAlgorithm 的值。 KnownKeyExportEncryptionAlgorithm 可以與 KeyEncryptionAlgorithm 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	定義 JsonWebKeyOperation 的值。 <xref:KnownJsonWebKeyOperation> 可以與 JsonWebKeyOperation 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 加密 解密 簽署 驗證 wrapKey unwrapKey 匯入 匯出
KeyRotationPolicyAction	將執行的動作。
KeyType	定義 JsonWebKeyType 的值。 <xref:KnownJsonWebKeyType> 可以與 JsonWebKeyType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 EC：橢圓曲線。 EC-HSM：橢圓曲線與儲存在 HSM 中的私鑰。 RSA： RSA （https://tools.ietf.org/html/rfc3447） RSA-HSM：具有儲存在 HSM 中的私鑰的 RSA。 oct：八位序列（用來表示對稱密鑰） oct-HSM：八位序列（用來代表對稱密鑰）儲存 HSM。
KeyWrapAlgorithm	密鑰包裝/解除包裝的支援演算法
RsaEncryptionAlgorithm	代表所有支援的 RSA 加密演算法的等位型別。
SignatureAlgorithm	定義 JsonWebKeySignatureAlgorithm 的值。 <xref:KnownJsonWebKeySignatureAlgorithm> 可以與 JsonWebKeySignatureAlgorithm 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 PS256：RSASSA-PSS 搭配 SHA-256 和 MGF1 搭配 SHA-256，如 https://tools.ietf.org/html/rfc7518 所述 PS384：RSASSA-PSS 搭配 SHA-384 和 MGF1 搭配 SHA-384，如 https://tools.ietf.org/html/rfc7518 所述 PS512：搭配 SHA-512 使用 SHA-512 和 MGF1 RSASSA-PSS，如 https://tools.ietf.org/html/rfc7518 所述 RS256：使用 SHA-256 的 RSASSA-PKCS1-v1_5，如 https://tools.ietf.org/html/rfc7518 所述 RS384：使用 SHA-384 的 RSASSA-PKCS1-v1_5，如 https://tools.ietf.org/html/rfc7518 所述 RS512：使用 SHA-512 的 RSASSA-PKCS1-v1_5，如 https://tools.ietf.org/html/rfc7518 所述 RSNULL： 保留 ES256：使用 P-256 和 SHA-256 的 ECDSA，如 https://tools.ietf.org/html/rfc7518中所述。 ES384：使用 P-384 和 SHA-384 的 ECDSA，如 https://tools.ietf.org/html/rfc7518 所述 ES512：使用 P-521 和 SHA-512 的 ECDSA，如 https://tools.ietf.org/html/rfc7518 所述 ES256K：使用 P-256K 和 SHA-256 的 ECDSA，如 https://tools.ietf.org/html/rfc7518 所述

列舉

KnownDeletionRecoveryLevel	DeletionRecoveryLevel 服務的已知值。
KnownEncryptionAlgorithms	EncryptionAlgorithm 服務的已知值。
KnownKeyCurveNames	服務的已知值 <xref:JsonWebKeyCurveName>。
KnownKeyExportEncryptionAlgorithm	KeyExportEncryptionAlgorithm 服務的已知值。
KnownKeyOperations	服務接受 KeyOperation 的已知值。
KnownKeyTypes	服務的已知值 <xref:JsonWebKeyType>。
KnownSignatureAlgorithms	服務的已知值 <xref:JsonWebKeySignatureAlgorithm>。

函式

parseKeyVaultKeyIdentifier(string)

剖析指定的 Key Vault 金鑰標識碼。例如： https://.vault.azure.net/keys// 在剖析上述識別碼時，此函式會傳回： { 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>" }

函式詳細資料

parseKeyVaultKeyIdentifier(string)

剖析指定的 Key Vault 金鑰標識碼。例如：

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

在剖析上述識別碼時，此函式會傳回：

  {
     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

參數

id

string

Key Vault 金鑰的標識碼。

傳回

KeyVaultKeyIdentifier