KeyVaultClientExtensions.ImportCertificateAsync Method

Definition

Overloads

ImportCertificateAsync(IKeyVaultClient, String, String, X509Certificate2Collection, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Imports a new certificate version. If this is the first version, the certificate resource is created.

ImportCertificateAsync(IKeyVaultClient, String, String, String, String, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Imports a certificate into a specified key vault.

ImportCertificateAsync(IKeyVaultClient, String, String, X509Certificate2Collection, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Imports a new certificate version. If this is the first version, the certificate resource is created.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.CertificateBundle> ImportCertificateAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string certificateName, System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificateCollection, Microsoft.Azure.KeyVault.Models.CertificatePolicy certificatePolicy, Microsoft.Azure.KeyVault.Models.CertificateAttributes certificateAttributes = null, System.Collections.Generic.IDictionary<string,string> tags = null, System.Threading.CancellationToken cancellationToken = null);
static member ImportCertificateAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Security.Cryptography.X509Certificates.X509Certificate2Collection * Microsoft.Azure.KeyVault.Models.CertificatePolicy * Microsoft.Azure.KeyVault.Models.CertificateAttributes * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.CertificateBundle>

Parameters

operations
IKeyVaultClient
vaultBaseUrl
String

The URL for the vault containing the certificate

certificateName
String

The name of the certificate

certificateCollection
X509Certificate2Collection

The certificate collection with the private key

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

cancellationToken
CancellationToken

Optional cancellation token

Returns

Task<CertificateBundle>

Imported certificate bundle to the vault.

Applies to

Product Introduced

ImportCertificateAsync(IKeyVaultClient, String, String, String, String, CertificatePolicy, CertificateAttributes, IDictionary<String,String>, CancellationToken)

Imports a certificate into a specified key vault.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.CertificateBundle> ImportCertificateAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string certificateName, string base64EncodedCertificate, string password = null, Microsoft.Azure.KeyVault.Models.CertificatePolicy certificatePolicy = null, Microsoft.Azure.KeyVault.Models.CertificateAttributes certificateAttributes = null, System.Collections.Generic.IDictionary<string,string> tags = null, System.Threading.CancellationToken cancellationToken = null);
static member ImportCertificateAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * string * string * Microsoft.Azure.KeyVault.Models.CertificatePolicy * Microsoft.Azure.KeyVault.Models.CertificateAttributes * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.CertificateBundle>

Parameters

operations
IKeyVaultClient

The operations group for this extension method.

vaultBaseUrl
String

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

certificateName
String

The name of the certificate.

base64EncodedCertificate
String

Base64 encoded representation of the certificate object to import. This certificate needs to contain the private key.

password
String

If the private key in base64EncodedCertificate is encrypted, the password used for encryption.

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.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<CertificateBundle>

Remarks

Imports an existing valid certificate, containing a private key, into Azure

Key Vault. The certificate to be imported can be in either PFX or PEM

format. If the certificate is in PEM format the PEM file must contain the

key as well as x509 certificates.

Applies to

Product Introduced