@azure/keyvault-admin package

類別

KeyVaultAccessControlClient	KeyVaultAccessControlClient 提供方法來管理任何指定 Azure Key Vault 實例中的訪問控制和角色指派。 用戶端支援建立、擷取和刪除角色。
KeyVaultBackupClient	KeyVaultBackupClient 提供方法來產生任何指定 Azure Key Vault 實例的備份和還原備份。 此用戶端支持產生完整備份、選擇性還原特定密鑰，以及 Key Vault 實例的完整還原。
KeyVaultSettingsClient	KeyVaultSettingsClient 提供異步方法來建立、更新、取得和列出 Azure Key Vault 的設定。

介面

AccessControlClientOptions	Key Vault AccessControlClient 所接受的選擇性參數
BooleanKeyVaultSetting	布爾類型的 Key Vault 設定。 若要檢查指定的 KeyVaultSetting 是否為布林值，請使用 isBooleanSetting。
CreateRoleAssignmentOptions	介面，表示可傳遞至 createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions) 的選擇性參數
DeleteRoleAssignmentOptions	介面，表示可傳遞至 deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions) 的選擇性參數
DeleteRoleDefinitionOptions	介面，表示傳遞至 deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)的選擇性參數。
GetRoleAssignmentOptions	介面，表示可傳遞至 getRoleAssignment(string, string, GetRoleAssignmentOptions) 的選擇性參數
GetRoleDefinitionOptions	介面，表示傳遞至 getRoleDefinition(string, string, GetRoleDefinitionOptions)的選擇性參數。
GetSettingOptions	介面，表示可傳遞至 getSetting 選擇性參數的介面
KeyVaultAdminPollOperationState	介面，表示 Key Vault 管理員輪詢器作業的狀態。
KeyVaultBackupClientOptions	KeyVaultBackupClient 接受的選擇性參數
KeyVaultBackupPollerOptions	介面，表示可傳遞至 beginBackup(string, string, KeyVaultBeginBackupOptions) 的選擇性參數
KeyVaultBackupResult	介面，表示備份作業的結果。
KeyVaultBeginBackupOptions	介面，表示可傳遞至 beginBackup 的選擇性參數
KeyVaultBeginPreBackupOptions	介面，表示可傳遞至 beginPreBackup 選擇性參數的介面
KeyVaultBeginPreRestoreOptions	介面，表示可傳遞至 beginPreRestore 的選擇性參數
KeyVaultBeginRestoreOptions	介面，表示可傳遞至 beginRestore 的選擇性參數
KeyVaultBeginSelectiveKeyRestoreOptions	介面，表示可傳遞至 beginSelectiveKeyRestore 的選擇性參數
KeyVaultPermission	Key Vault 許可權的清單。
KeyVaultRestoreOperationState	介面，表示還原 Key Vault 輪詢作業狀態的公開可用屬性。
KeyVaultRestoreResult	介面，表示還原作業的結果。
KeyVaultRoleAssignment	Key Vault 角色指派。
KeyVaultRoleAssignmentProperties	角色指派屬性。
KeyVaultRoleDefinition	Key Vault 角色定義。
KeyVaultSelectiveKeyRestoreOperationState	介面，表示還原 Key Vault 輪詢作業狀態的公開可用屬性。
KeyVaultSelectiveKeyRestoreResult	介面，表示選擇性密鑰還原作業的結果。
KeyVaultSetting	Key Vault 設定。
ListRoleAssignmentsOptions	介面，表示傳遞至 listRoleAssignments(string, ListRoleAssignmentsOptions)的選擇性參數。
ListRoleAssignmentsPageSettings	擷取搜尋結果下一頁的自變數。
ListRoleDefinitionsOptions	介面，表示傳遞至 listRoleDefinitions(string, ListRoleDefinitionsOptions)的選擇性參數。
ListRoleDefinitionsPageSettings	擷取搜尋結果下一頁的自變數。
ListSettingsOptions	介面，表示可傳遞至 <xref:KeyVaultSettingsClient.listSettings> 的選擇性參數
ListSettingsResponse	介面，表示 <xref:KeyVaultSettingsClient.listSettings> 傳回的回應
PollerLike	簡單的輪詢器，可用來輪詢長時間執行的作業。
SetRoleDefinitionOptions	介面，表示傳遞至 setRoleDefinition(string, SetRoleDefinitionOptions)的選擇性參數。
SettingsClientOptions	KeyVaultSettingsClient 接受的選擇性參數。
UpdateSettingOptions	介面，表示可傳遞至 updateSetting 的選擇性參數

類型別名

KeyVaultBackupOperationState	介面，表示備份Key Vault輪詢作業狀態的公開可用屬性。
KeyVaultDataAction	數據動作的支持許可權。 <xref:KnownDataAction> 可以與 DataAction 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 Microsoft.KeyVault/managedHsm/keys/read/action：讀取 HSM 密鑰元數據。 Microsoft.KeyVault/managedHsm/keys/write/action：更新 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action：讀取已刪除的 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action：復原已刪除的 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/backup/action：備份 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/restore/action：還原 HSM 密鑰。 Microsoft.KeyVault/managedHsm/roleAssignments/delete/action：刪除角色指派。 Microsoft.KeyVault/managedHsm/roleAssignments/read/action：取得角色指派。 Microsoft.KeyVault/managedHsm/roleAssignments/write/action：建立或更新角色指派。 Microsoft.KeyVault/managedHsm/roleDefinitions/read/action：取得角色定義。 Microsoft.KeyVault/managedHsm/roleDefinitions/write/action：建立或更新角色定義。 Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action：刪除角色定義。 Microsoft.KeyVault/managedHsm/keys/encrypt/action：使用 HSM 密鑰加密。 Microsoft.KeyVault/managedHsm/keys/decrypt/action：使用 HSM 密鑰解密。 Microsoft.KeyVault/managedHsm/keys/wrap/action：使用 HSM 密鑰包裝。 Microsoft.KeyVault/managedHsm/keys/unwrap/action：使用 HSM 密鑰解除包裝。 Microsoft.KeyVault/managedHsm/keys/sign/action：使用 HSM 密鑰簽署。 Microsoft.KeyVault/managedHsm/keys/verify/action：使用 HSM 密鑰進行驗證。 Microsoft.KeyVault/managedHsm/keys/create：建立 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/delete：刪除 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/export/action：導出 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/release/action：使用安全密鑰版本釋放 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/import/action：匯入 HSM 密鑰。 Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete：清除已刪除的 HSM 密鑰。 Microsoft.KeyVault/managedHsm/securitydomain/download/action：下載 HSM 安全性網域。 Microsoft.KeyVault/managedHsm/securitydomain/download/read：檢查 HSM 安全性網域下載的狀態。 Microsoft.KeyVault/managedHsm/securitydomain/upload/action：上傳 HSM 安全性網域。 Microsoft.KeyVault/managedHsm/securitydomain/upload/read：檢查 HSM 安全性網域交換檔案的狀態。 Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read：下載 HSM 安全性網域傳輸密鑰。 Microsoft.KeyVault/managedHsm/backup/start/action：啟動 HSM 備份。 Microsoft.KeyVault/managedHsm/restore/start/action：啟動 HSM 還原。 Microsoft.KeyVault/managedHsm/backup/status/action：讀取 HSM 備份狀態。 Microsoft.KeyVault/managedHsm/restore/status/action：讀取 HSM 還原狀態。 Microsoft.KeyVault/managedHsm/rng/action：產生隨機數。
KeyVaultRoleScope	角色範圍。 <xref:KnownRoleScope> 可以與 RoleScope 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 /：全域範圍 /keys：金鑰範圍
OperationStatus	長時間執行作業的狀態。 <xref:KnownOperationStatus> 可以與 OperationStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 InProgress：作業正在進行中。 成功：作業成功完成。 取消：作業已取消。 失敗：作業失敗。
SUPPORTED_API_VERSIONS	支援的 API 版本

列舉

KnownKeyVaultDataAction	數據動作的支持許可權。
KnownKeyVaultRoleScope	角色範圍。

函式

isBooleanSetting(KeyVaultSetting)

判斷指定的 KeyVaultSetting 是否為布爾值KeyVaultSetting ，亦即具有布爾值。

函式詳細資料

isBooleanSetting(KeyVaultSetting)

判斷指定的 KeyVaultSetting 是否為布爾值KeyVaultSetting ，亦即具有布爾值。

function isBooleanSetting(setting: KeyVaultSetting): setting

參數

setting

KeyVaultSetting

傳回

setting