KeyClient.UpdateKeyProperties Method

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.7.0

Source:

KeyClient.cs

The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.

public virtual Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey> UpdateKeyProperties (Azure.Security.KeyVault.Keys.KeyProperties properties, System.Collections.Generic.IEnumerable<Azure.Security.KeyVault.Keys.KeyOperation> keyOperations = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateKeyProperties : Azure.Security.KeyVault.Keys.KeyProperties * seq<Azure.Security.KeyVault.Keys.KeyOperation> * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>
override this.UpdateKeyProperties : Azure.Security.KeyVault.Keys.KeyProperties * seq<Azure.Security.KeyVault.Keys.KeyOperation> * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>

Public Overridable Function UpdateKeyProperties (properties As KeyProperties, Optional keyOperations As IEnumerable(Of KeyOperation) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of KeyVaultKey)

Parameters

properties

KeyProperties

The KeyProperties object with updated properties.

keyOperations

IEnumerable<KeyOperation>

Optional list of supported KeyOperation. If null, no changes will be made to existing key operations.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Response<KeyVaultKey>

Exceptions

ArgumentNullException

properties is null.

RequestFailedException

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

Remarks

In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.