SecretClient.SetSecretAsync メソッド

定義

名前空間:

Azure.Security.KeyVault.Secrets

アセンブリ:

Azure.Security.KeyVault.Secrets.dll

パッケージ:

Azure.Security.KeyVault.Secrets v4.6.0

オーバーロード

SetSecretAsync(KeyVaultSecret, CancellationToken)	指定したキー コンテナーにシークレットを設定します。
SetSecretAsync(String, String, CancellationToken)	指定したキー コンテナーにシークレットを設定します。

SetSecretAsync(KeyVaultSecret, CancellationToken)

ソース:

SecretClient.cs

指定したキー コンテナーにシークレットを設定します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.KeyVaultSecret>> SetSecretAsync (Azure.Security.KeyVault.Secrets.KeyVaultSecret secret, System.Threading.CancellationToken cancellationToken = default);

abstract member SetSecretAsync : Azure.Security.KeyVault.Secrets.KeyVaultSecret * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.KeyVaultSecret>>
override this.SetSecretAsync : Azure.Security.KeyVault.Secrets.KeyVaultSecret * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.KeyVaultSecret>>

Public Overridable Function SetSecretAsync (secret As KeyVaultSecret, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultSecret))

パラメーター

secret

KeyVaultSecret

シークレットとそのプロパティに関する情報を含む Secret オブジェクト。 プロパティ シークレット。名前とシークレット。値は null 以外である必要があります。

cancellationToken

CancellationToken

CancellationToken要求の有効期間を制御する 。

戻り値

Task<Response<KeyVaultSecret>>

例外

ArgumentNullException

secret が null です。

RequestFailedException

サーバーからエラーが返されました。 サーバーから返される詳細については、「」を参照してください Message 。

注釈

set 操作は、Azure Key Vaultにシークレットを追加します。 名前付きのシークレット キーが既に存在する場合は、Azure Key Vault により、そのシークレットの新しいバージョンが作成されます。 この操作には、secrets/set アクセス許可が必要です。

SetSecretAsync(String, String, CancellationToken)

ソース:

SecretClient.cs

指定したキー コンテナーにシークレットを設定します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.KeyVaultSecret>> SetSecretAsync (string name, string value, System.Threading.CancellationToken cancellationToken = default);

abstract member SetSecretAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.KeyVaultSecret>>
override this.SetSecretAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.KeyVaultSecret>>

Public Overridable Function SetSecretAsync (name As String, value As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultSecret))

パラメーター

name

String

シークレットの名前。 null にすることはできません。

value

String

シークレットの値。 null にすることはできません。

cancellationToken

CancellationToken

CancellationToken要求の有効期間を制御する 。

戻り値

Task<Response<KeyVaultSecret>>

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

サーバーからエラーが返されました。 サーバーから返される詳細については、「」を参照してください Message 。

注釈

set 操作は、Azure Key Vaultにシークレットを追加します。 名前付きのシークレット キーが既に存在する場合は、Azure Key Vault により、そのシークレットの新しいバージョンが作成されます。 この操作には、secrets/set アクセス許可が必要です。