KeyClient.UpdateKeyPropertiesAsync Method
Definition
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.
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 System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>> UpdateKeyPropertiesAsync (Azure.Security.KeyVault.Keys.KeyProperties properties, System.Collections.Generic.IEnumerable<Azure.Security.KeyVault.Keys.KeyOperation> keyOperations = default, System.Threading.CancellationToken cancellationToken = default);abstract member UpdateKeyPropertiesAsync : Azure.Security.KeyVault.Keys.KeyProperties * seq<Azure.Security.KeyVault.Keys.KeyOperation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>
override this.UpdateKeyPropertiesAsync : Azure.Security.KeyVault.Keys.KeyProperties * seq<Azure.Security.KeyVault.Keys.KeyOperation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>Public Overridable Function UpdateKeyPropertiesAsync (properties As KeyProperties, Optional keyOperations As IEnumerable(Of KeyOperation) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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
Exceptions
properties or keyOperations is null.
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.
