@azure/keyvault-secrets package

SecretClient 提供方法來管理 Azure Key Vault 中的 KeyVaultSecret。 用戶端支援建立、擷取、更新、刪除、清除、備份、還原及列出KeyVaultSecrets。 用戶端也支持針對已啟用虛刪除的 Azure Key Vault 列出 DeletedSecret。

<xref:backupSecretOptions>的選項。

介面，表示可傳遞至 beginDeleteSecret(string, BeginDeleteSecretOptions) 的選擇性參數

介面，表示可傳遞至 beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions) 的選擇性參數

介面，表示已刪除的 KeyVault 秘密。

getDeletedSecret(string, GetDeletedSecretOptions)的選項。

getSecret(string, GetSecretOptions)的選項。

代表 KeyVault Secret 的介面，其名稱、值和 SecretProperties。

代表組成 Key Vault 秘密標識符的區段。

listDeletedSecrets(ListDeletedSecretsOptions)的選項。

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)的選項。

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)的選項。

追蹤分頁反覆運算設定的介面

介面，可讓異步反覆運算同時完成和逐頁執行。

PollOperationState 包含定義任何長時間執行之作業輪詢器所需的最小屬性集意見清單。

雖然 Poller 類別會當做本機控制機制來開始觸發、等候，並可能取消長時間執行的作業，但 PollOperationState 會記錄遠端長時間執行作業的狀態。

它至少應在作業啟動時、完成時，以及取消時更新。 不過，實作可以有任何其他數目的屬性，這些屬性可能會因為其他原因而更新。

輪詢器抽象表示法，旨在只公開使用者需要使用的最小 API。

purgeDeletedSecret(string, PurgeDeletedSecretOptions)的選項。

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)的選項。

KeyVault 的 KeyClient 接受的選擇性參數

介面，表示可傳遞至 beginDeleteSecret(string, BeginDeleteSecretOptions) 和 <xref:beginRecoverDeletedKey>的選擇性參數。

介面，表示 KeyVaultSecret的屬性。

setSecret(string, string, SetSecretOptions)的選項。

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)的選項。

反映目前保存庫中秘密目前生效的刪除復原層級。 如果它包含「可清除」，則特殊許可權使用者可以永久刪除秘密;否則，只有系統可以在保留間隔結束時清除秘密。
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 時，將無法永久取消訂閱本身。 此層級保證在保留間隔期間已刪除實體的復原能力，也反映無法取消訂閱本身的事實。

反映目前保存庫中秘密目前生效的刪除復原層級。 如果它包含「可清除」，則特殊許可權使用者可以永久刪除秘密;否則，只有系統可以在保留間隔結束時清除秘密。

剖析指定的 Key Vault 秘密識別碼。例如：

https://< keyvault-name.vault.azure.net/secrets/>< secret-name>/<unique-version-id>

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

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }