Share via


SecretClient.UpdateSecretPropertiesAsync Method

Definition

Updates the attributes associated with a specified secret.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties>> UpdateSecretPropertiesAsync (Azure.Security.KeyVault.Secrets.SecretProperties properties, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateSecretPropertiesAsync : Azure.Security.KeyVault.Secrets.SecretProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties>>
override this.UpdateSecretPropertiesAsync : Azure.Security.KeyVault.Secrets.SecretProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties>>
Public Overridable Function UpdateSecretPropertiesAsync (properties As SecretProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SecretProperties))

Parameters

properties
SecretProperties

The secret object with updated properties.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

properties or Version is null.

The server returned an error. See Message for details returned from the server.

Remarks

The update operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.

Applies to