@azure/keyvault-secrets package

參考

類別

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

介面

BackupSecretOptions	的選項 <xref:backupSecretOptions> 。
BeginDeleteSecretOptions	介面，表示可傳遞至的選擇性參數 beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	介面，表示可傳遞至的選擇性參數 beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	表示已刪除 KeyVault 秘密的介面。
GetDeletedSecretOptions	的選項 getDeletedSecret(string, GetDeletedSecretOptions) 。
GetSecretOptions	的選項 getSecret(string, GetSecretOptions) 。
KeyVaultSecret	代表 KeyVault Secret 的介面，其名稱、值和 SecretProperties。
KeyVaultSecretIdentifier	表示組成金鑰保存庫秘密識別碼的區段。
ListDeletedSecretsOptions	的選項 listDeletedSecrets(ListDeletedSecretsOptions) 。
ListPropertiesOfSecretVersionsOptions	的選項 listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions) 。
ListPropertiesOfSecretsOptions	的選項 listPropertiesOfSecrets(ListPropertiesOfSecretsOptions) 。
PageSettings	追蹤分頁反覆運算設定的介面
PagedAsyncIterableIterator	介面，可讓非同步反覆運算同時完成和依頁面進行。
PollOperationState	PollOperationState 包含定義任何長時間執行之作業輪詢器所需的最小屬性集意見清單。雖然 Poller 類別可作為開始觸發、等候及可能取消長時間執行作業的本機控制機制，但 PollOperationState 會記載遠端長時間執行作業的狀態。它應該至少在作業啟動時、完成時以及取消時更新。不過，實作可以有任何其他數目的屬性，這些屬性可能會因為其他原因而更新。
PollerLike	輪詢器的抽象標記法，旨在只公開使用者所需的最小 API。
PurgeDeletedSecretOptions	的選項 purgeDeletedSecret(string, PurgeDeletedSecretOptions) 。
RestoreSecretBackupOptions	的選項 restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions) 。
SecretClientOptions	KeyVault 的 KeyClient 所接受的選擇性參數
SecretPollerOptions	介面，表示可傳遞至 beginDeleteSecret(string, BeginDeleteSecretOptions) 和 <xref:beginRecoverDeletedKey> 的選擇性參數。
SecretProperties	介面，表示 KeyVaultSecret的屬性。
SetSecretOptions	的選項 setSecret(string, string, SetSecretOptions) 。
UpdateSecretPropertiesOptions	的選項 updateSecretProperties(string, string, UpdateSecretPropertiesOptions) 。

類型別名

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 時，無法永久取消訂用帳戶本身。此層級保證在保留間隔期間刪除的實體可復原性，同時反映無法取消訂閱本身的事實。

列舉

KnownDeletionRecoveryLevel

服務接受的 DeletionRecoveryLevel 已知值。

函數

parseKeyVaultSecretIdentifier(string)

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

https://.vault.azure.net/secrets//

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

  {
     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>"
  }

函式詳細資料

parseKeyVaultSecretIdentifier(string)

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

https://.vault.azure.net/secrets//

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

  {
     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>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

參數

id: string

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

傳回

KeyVaultSecretIdentifier

@azure/keyvault-secrets package

類別

介面

類型別名

服務支援的已知值

列舉

函數

函式詳細資料

parseKeyVaultSecretIdentifier(string)

參數

傳回

其他資源