你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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)
“列出”操作获取与订阅关联的保管库的相关信息。
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)
“列出”操作获取与订阅关联的保管库的相关信息。
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>