通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Secrets interface

  • 参考
包:
@azure/arm-keyvault

表示机密的接口。

方法

createOrUpdate(string, string, string, SecretCreateOrUpdateParameters, SecretsCreateOrUpdateOptionalParams)

在指定订阅的密钥保管库中创建或更新机密。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。
get(string, string, string, SecretsGetOptionalParams)

获取指定的机密。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。
list(string, string, SecretsListOptionalParams)

“列出”操作获取有关保管库中机密的信息。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。
update(string, string, string, SecretPatchParameters, SecretsUpdateOptionalParams)

更新指定订阅中的机密。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

方法详细信息

createOrUpdate(string, string, string, SecretCreateOrUpdateParameters, SecretsCreateOrUpdateOptionalParams)

在指定订阅的密钥保管库中创建或更新机密。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

function createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, options?: SecretsCreateOrUpdateOptionalParams): Promise<Secret>

参数

resourceGroupName

string

保管库所属的资源组的名称。

vaultName

string

保管库的名称

secretName

string

机密的名称。 为了运行服务，可能会全局复制你提供的值。 提供的值不应包括个人身份信息或敏感信息。

parameters
SecretCreateOrUpdateParameters

用于创建或更新机密的参数

options
SecretsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<Secret>

get(string, string, string, SecretsGetOptionalParams)

获取指定的机密。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

function get(resourceGroupName: string, vaultName: string, secretName: string, options?: SecretsGetOptionalParams): Promise<Secret>

参数

resourceGroupName

string

保管库所属的资源组的名称。

vaultName

string

保管库的名称。

secretName

string

机密的名称。

options
SecretsGetOptionalParams

选项参数。

返回

Promise<Secret>

list(string, string, SecretsListOptionalParams)

“列出”操作获取有关保管库中机密的信息。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

function list(resourceGroupName: string, vaultName: string, options?: SecretsListOptionalParams): PagedAsyncIterableIterator<Secret, Secret[], PageSettings>

参数

resourceGroupName

string

保管库所属的资源组的名称。

vaultName

string

保管库的名称。

options
SecretsListOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<Secret, Secret[], PageSettings>

update(string, string, string, SecretPatchParameters, SecretsUpdateOptionalParams)

更新指定订阅中的机密。 注意：此 API 适用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

function update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, options?: SecretsUpdateOptionalParams): Promise<Secret>

参数

resourceGroupName

string

保管库所属的资源组的名称。

vaultName

string

保管库的名称

secretName

string

机密的名称

parameters
SecretPatchParameters

用于修补机密的参数

options
SecretsUpdateOptionalParams

选项参数。

返回

Promise<Secret>