IKeyVaultClient.UpdateKeyWithHttpMessagesAsync(String, String, String, IList<String>, KeyAttributes, IDictionary<String,String>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>> UpdateKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, string keyVersion, System.Collections.Generic.IList<string> keyOps = null, Microsoft.Azure.KeyVault.Models.KeyAttributes keyAttributes = null, System.Collections.Generic.IDictionary<string,string> tags = null, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = null, System.Threading.CancellationToken cancellationToken = null);
abstract member UpdateKeyWithHttpMessagesAsync : string * string * string * System.Collections.Generic.IList<string> * Microsoft.Azure.KeyVault.Models.KeyAttributes * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>>

Parameters

vaultBaseUrl
String

The vault name, for example https://myvault.vault.azure.net.

keyName
String

The name of key to update.

keyVersion
String

The version of the key to update.

keyOps
IList<String>

Json web key operations. For more information on possible key operations, see JsonWebKeyOperation.

keyAttributes
KeyAttributes
tags
IDictionary<String,String>

Application specific metadata in the form of key-value pairs.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<Microsoft.Rest.Azure.AzureOperationResponse<KeyBundle>>

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.

Applies to