@azure/keyvault-keys package

類別

CryptographyClient	用來在 Azure 金鑰保存庫金鑰或本機 JsonWebKey上執行密碼編譯作業的用戶端。
KeyClient	KeyClient 提供在 Azure 金鑰保存庫中管理KeyVaultKey的方法。 用戶端支援建立、擷取、更新、刪除、清除、備份、還原和列出 KeyVaultKeys。 用戶端也支援針對已啟用虛刪除的 Azure 金鑰保存庫列出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 密碼編譯Client 所接受的選擇性參數
CryptographyOptions	代表密碼編譯 API 方法選項的介面，請移至 CryptographyClient 以取得詳細資訊。
DecryptOptions	的選項 decrypt(DecryptParameters, DecryptOptions) 。
DecryptResult	decrypt(DecryptParameters, DecryptOptions)作業的結果。
DeletedKey	表示已刪除金鑰保存庫金鑰的介面。
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_2, 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	動作及其對應的觸發程式，該觸發程式將由索引鍵存留期期間金鑰保存庫執行。
KeyRotationPolicy	屬於金鑰的完整金鑰輪替原則。
KeyRotationPolicyProperties	用戶端可以為指定金鑰設定的金鑰輪替原則屬性。 您也可以將 lifetimeActions 設定為空陣列，將金鑰輪替原則重設為預設值。
KeyVaultKey	介面，表示金鑰保存庫 Key，其名稱、值和KeyProperties。
KeyVaultKeyIdentifier	表示組成金鑰保存庫索引鍵識別碼的區段。
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 天) ，否則已刪除實體的復原能力。 系統會在 90 天后永久刪除，如果未復原，則為 可復原：表示可復原刪除的保存庫狀態，而不可能發生立即和永久刪除 (，亦即清除) 。 此層級可確保在保留間隔期間 (90 天) 且訂用帳戶仍可使用時，刪除實體的復原能力。 系統會在 90 天后永久刪除，如果未復原，則為 Recoverable+ProtectedSubscription：表示保存庫和訂用帳戶狀態，其中刪除可在保留間隔內復原 (90 天) 、立即和永久刪除 (，亦即不允許清除) ，以及無法永久取消訂用帳戶本身。 系統會在 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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 encrypt 解密 簽署 驗證 wrapKey unwrapKey import 匯出
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：使用 SHA-256 和 MGF1 搭配 SHA-256 的 RSAUTH-PSS，如下列所述 https://tools.ietf.org/html/rfc7518 PS384：使用 SHA-384 和 MGF1 搭配 SHA-384 的 RSAUTH-PSS，如下列所述 https://tools.ietf.org/html/rfc7518 PS512：使用 SHA-512 和 MGF1 搭配 SHA-512 的 RSAUTH-PSS，如下列所述 https://tools.ietf.org/html/rfc7518 RS256：使用 SHA-256 的 RSAUTH-PKCS1-v1_5，如中所述 https://tools.ietf.org/html/rfc7518 RS384：使用 SHA-384 的 RSAUTH-PKCS1-v1_5，如中所述 https://tools.ietf.org/html/rfc7518 RS512：使用 SHA-512 的 RSAUTH-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)

剖析指定的金鑰保存庫金鑰識別碼。例如： 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)

剖析指定的金鑰保存庫金鑰識別碼。例如：

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

金鑰保存庫金鑰的識別碼。

傳回

KeyVaultKeyIdentifier