SecretClient.UpdateSecretPropertiesAsync Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Secrets

Assembly:: Azure.Security.KeyVault.Secrets.dll

Package:: Azure.Security.KeyVault.Secrets v4.6.0

Package:: Azure.Security.KeyVault.Secrets v4.6.0-beta.2

Source:: SecretClient.cs

Source:: SecretClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<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.

Applies to