KeyVaultClient.UpdateCertificateWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Package:

Microsoft.Azure.KeyVault v3.0.5

Source:

KeyVaultClient.cs

Updates the specified attributes associated with the given certificate.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.CertificateBundle>> UpdateCertificateWithHttpMessagesAsync (string vaultBaseUrl, string certificateName, string certificateVersion, Microsoft.Azure.KeyVault.Models.CertificatePolicy certificatePolicy = default, Microsoft.Azure.KeyVault.Models.CertificateAttributes certificateAttributes = default, System.Collections.Generic.IDictionary<string,string> tags = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateCertificateWithHttpMessagesAsync : string * string * string * Microsoft.Azure.KeyVault.Models.CertificatePolicy * Microsoft.Azure.KeyVault.Models.CertificateAttributes * 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.CertificateBundle>>
override this.UpdateCertificateWithHttpMessagesAsync : string * string * string * Microsoft.Azure.KeyVault.Models.CertificatePolicy * Microsoft.Azure.KeyVault.Models.CertificateAttributes * 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.CertificateBundle>>

Public Function UpdateCertificateWithHttpMessagesAsync (vaultBaseUrl As String, certificateName As String, certificateVersion As String, Optional certificatePolicy As CertificatePolicy = Nothing, Optional certificateAttributes As CertificateAttributes = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of CertificateBundle))

Parameters

vaultBaseUrl

String

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

certificateName

String

The name of the certificate in the given key vault.

certificateVersion

String

The version of the certificate.

certificatePolicy

CertificatePolicy

The management policy for the certificate.

certificateAttributes

CertificateAttributes

The attributes of the certificate (optional).

tags

IDictionary<String,String>

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

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<CertificateBundle>>

Implements

UpdateCertificateWithHttpMessagesAsync(String, String, String, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, Dictionary<String,List<String>>, CancellationToken)

Exceptions

KeyVaultErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.