Vaults interface
表示保存庫的介面。
方法
方法詳細資料
beginCreateOrUpdate(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)
在指定的訂用帳戶中建立或更新金鑰保存庫。
function beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Vault>, Vault>>
參數
- resourceGroupName
-
string
伺服器所屬的資源群組名稱。
- vaultName
-
string
保存庫的名稱
- parameters
- VaultCreateOrUpdateParameters
用來建立或更新保存庫的參數
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<Vault>, Vault>>
beginCreateOrUpdateAndWait(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)
在指定的訂用帳戶中建立或更新金鑰保存庫。
function beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<Vault>
參數
- resourceGroupName
-
string
伺服器所屬的資源群組名稱。
- vaultName
-
string
保存庫的名稱
- parameters
- VaultCreateOrUpdateParameters
用來建立或更新保存庫的參數
選項參數。
傳回
Promise<Vault>
beginPurgeDeleted(string, string, VaultsPurgeDeletedOptionalParams)
永久刪除指定的保存庫。 也稱為清除已刪除的 Azure 金鑰保存庫。
function beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
參數
- vaultName
-
string
虛刪除保存庫的名稱。
- location
-
string
虛刪除保存庫的位置。
- options
- VaultsPurgeDeletedOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginPurgeDeletedAndWait(string, string, VaultsPurgeDeletedOptionalParams)
永久刪除指定的保存庫。 也稱為清除已刪除的 Azure 金鑰保存庫。
function beginPurgeDeletedAndWait(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<void>
參數
- vaultName
-
string
虛刪除保存庫的名稱。
- location
-
string
虛刪除保存庫的位置。
- options
- VaultsPurgeDeletedOptionalParams
選項參數。
傳回
Promise<void>
checkNameAvailability(VaultCheckNameAvailabilityParameters, VaultsCheckNameAvailabilityOptionalParams)
檢查保存庫名稱是否有效,且尚未使用中。
function checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options?: VaultsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>
參數
- vaultName
- VaultCheckNameAvailabilityParameters
保存庫的名稱。
選項參數。
傳回
Promise<CheckNameAvailabilityResult>
delete(string, string, VaultsDeleteOptionalParams)
刪除指定的 Azure 金鑰保存庫。
function delete(resourceGroupName: string, vaultName: string, options?: VaultsDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
保存庫所屬之資源群組的名稱。
- vaultName
-
string
要刪除之保存庫的名稱
- options
- VaultsDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, VaultsGetOptionalParams)
取得指定的 Azure 金鑰保存庫。
function get(resourceGroupName: string, vaultName: string, options?: VaultsGetOptionalParams): Promise<Vault>
參數
- resourceGroupName
-
string
保存庫所屬之資源群組的名稱。
- vaultName
-
string
保存庫的名稱。
- options
- VaultsGetOptionalParams
選項參數。
傳回
Promise<Vault>
getDeleted(string, string, VaultsGetDeletedOptionalParams)
取得已刪除的 Azure 金鑰保存庫。
function getDeleted(vaultName: string, location: string, options?: VaultsGetDeletedOptionalParams): Promise<DeletedVault>
參數
- vaultName
-
string
保存庫的名稱。
- location
-
string
已刪除保存庫的位置。
- options
- VaultsGetDeletedOptionalParams
選項參數。
傳回
Promise<DeletedVault>
list(VaultsListOptionalParams)
List 作業會取得與訂用帳戶相關聯之保存庫的相關信息。
function list(options?: VaultsListOptionalParams): PagedAsyncIterableIterator<Resource, Resource[], PageSettings>
參數
- options
- VaultsListOptionalParams
選項參數。
傳回
listByResourceGroup(string, VaultsListByResourceGroupOptionalParams)
List 作業會取得與訂用帳戶和指定資源群組內相關聯之保存庫的相關信息。
function listByResourceGroup(resourceGroupName: string, options?: VaultsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>
參數
- resourceGroupName
-
string
保存庫所屬之資源群組的名稱。
選項參數。
傳回
listBySubscription(VaultsListBySubscriptionOptionalParams)
List 作業會取得與訂用帳戶相關聯之保存庫的相關信息。
function listBySubscription(options?: VaultsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>
參數
選項參數。
傳回
listDeleted(VaultsListDeletedOptionalParams)
取得訂用帳戶中已刪除保存庫的相關信息。
function listDeleted(options?: VaultsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedVault, DeletedVault[], PageSettings>
參數
- options
- VaultsListDeletedOptionalParams
選項參數。
傳回
update(string, string, VaultPatchParameters, VaultsUpdateOptionalParams)
更新指定訂用帳戶中的金鑰保存庫。
function update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options?: VaultsUpdateOptionalParams): Promise<Vault>
參數
- resourceGroupName
-
string
伺服器所屬的資源群組名稱。
- vaultName
-
string
保存庫的名稱
- parameters
- VaultPatchParameters
修補保存庫的參數
- options
- VaultsUpdateOptionalParams
選項參數。
傳回
Promise<Vault>
updateAccessPolicy(string, string, AccessPolicyUpdateKind, VaultAccessPolicyParameters, VaultsUpdateAccessPolicyOptionalParams)
更新指定訂用帳戶中金鑰保存庫中的存取原則。
function updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options?: VaultsUpdateAccessPolicyOptionalParams): Promise<VaultAccessPolicyParameters>
參數
- resourceGroupName
-
string
保存庫所屬之資源群組的名稱。
- vaultName
-
string
保存庫的名稱
- operationKind
- AccessPolicyUpdateKind
作業的名稱
- parameters
- VaultAccessPolicyParameters
要合併至保存庫的存取原則
選項參數。
傳回
Promise<VaultAccessPolicyParameters>