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)	List 作業會取得保存庫中秘密的相關資訊。 注意：此 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)

List 作業會取得保存庫中秘密的相關資訊。 注意：此 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>