SecretClient.UpdateSecretProperties Method

Definition

Namespace:

Azure.Security.KeyVault.Secrets

Assembly:

Azure.Security.KeyVault.Secrets.dll

Package:

Azure.Security.KeyVault.Secrets v4.7.0

Source:

SecretClient.cs

Updates the attributes associated with a specified secret.

public virtual Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties> UpdateSecretProperties (Azure.Security.KeyVault.Secrets.SecretProperties properties, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateSecretProperties : Azure.Security.KeyVault.Secrets.SecretProperties * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties>
override this.UpdateSecretProperties : Azure.Security.KeyVault.Secrets.SecretProperties * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Secrets.SecretProperties>

Public Overridable Function UpdateSecretProperties (properties As SecretProperties, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SecretProperties)

Parameters

properties

SecretProperties

The secret object with updated properties.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Response<SecretProperties>

Exceptions

ArgumentNullException

properties or Version is null.

RequestFailedException

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.