Certificate

Manages a Key Vault Certificate.

Create a Certificate Resource

new Certificate(name: string, args: CertificateArgs, opts?: CustomResourceOptions);

def Certificate(resource_name, opts=None, certificate=None, certificate_policy=None, key_vault_id=None, name=None, tags=None, __props__=None);

func NewCertificate(ctx *Context, name string, args CertificateArgs, opts ...ResourceOption) (*Certificate, error)

public Certificate(string name, CertificateArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args CertificateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CertificateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CertificateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Certificate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Certificate resource accepts the following input properties:

CertificatePolicy CertificateCertificatePolicyArgs: A certificate_policy block as defined below.
KeyVaultId string: The ID of the Key Vault where the Certificate should be created.
KeyVaultCertificate CertificateCertificateArgs: A certificate block as defined below, used to Import an existing certificate.
Name string: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

CertificatePolicy CertificateCertificatePolicy: A certificate_policy block as defined below.
KeyVaultId string: The ID of the Key Vault where the Certificate should be created.
Certificate CertificateCertificate: A certificate block as defined below, used to Import an existing certificate.
Name string: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

certificatePolicy CertificateCertificatePolicy: A certificate_policy block as defined below.
keyVaultId string: The ID of the Key Vault where the Certificate should be created.
certificate CertificateCertificate: A certificate block as defined below, used to Import an existing certificate.
name string: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

certificate_policy Dict[CertificateCertificatePolicy]: A certificate_policy block as defined below.
key_vault_id str: The ID of the Key Vault where the Certificate should be created.
certificate Dict[CertificateCertificate]: A certificate block as defined below, used to Import an existing certificate.
name str: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Certificate resource produces the following output properties:

CertificateData string: The raw Key Vault Certificate data represented as a hexadecimal string.
Id string: The provider-assigned unique ID for this managed resource.
SecretId string: The ID of the associated Key Vault Secret.
Thumbprint string: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
Version string: The current version of the Key Vault Certificate.

CertificateData string: The raw Key Vault Certificate data represented as a hexadecimal string.
Id string: The provider-assigned unique ID for this managed resource.
SecretId string: The ID of the associated Key Vault Secret.
Thumbprint string: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
Version string: The current version of the Key Vault Certificate.

certificateData string: The raw Key Vault Certificate data represented as a hexadecimal string.
id string: The provider-assigned unique ID for this managed resource.
secretId string: The ID of the associated Key Vault Secret.
thumbprint string: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
version string: The current version of the Key Vault Certificate.

certificate_data str: The raw Key Vault Certificate data represented as a hexadecimal string.
id str: The provider-assigned unique ID for this managed resource.
secret_id str: The ID of the associated Key Vault Secret.
thumbprint str: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
version str: The current version of the Key Vault Certificate.

Look up an Existing Certificate Resource

Get an existing Certificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CertificateState, opts?: CustomResourceOptions): Certificate

static get(resource_name, id, opts=None, certificate=None, certificate_data=None, certificate_policy=None, key_vault_id=None, name=None, secret_id=None, tags=None, thumbprint=None, version=None, __props__=None);

func GetCertificate(ctx *Context, name string, id IDInput, state *CertificateState, opts ...ResourceOption) (*Certificate, error)

public static Certificate Get(string name, Input<string> id, CertificateState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CertificateData string: The raw Key Vault Certificate data represented as a hexadecimal string.
CertificatePolicy CertificateCertificatePolicyArgs: A certificate_policy block as defined below.
KeyVaultCertificate CertificateCertificateArgs: A certificate block as defined below, used to Import an existing certificate.
KeyVaultId string: The ID of the Key Vault where the Certificate should be created.
Name string: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
SecretId string: The ID of the associated Key Vault Secret.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Thumbprint string: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
Version string: The current version of the Key Vault Certificate.

Certificate CertificateCertificate: A certificate block as defined below, used to Import an existing certificate.
CertificateData string: The raw Key Vault Certificate data represented as a hexadecimal string.
CertificatePolicy CertificateCertificatePolicy: A certificate_policy block as defined below.
KeyVaultId string: The ID of the Key Vault where the Certificate should be created.
Name string: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
SecretId string: The ID of the associated Key Vault Secret.
Tags map[string]string: A mapping of tags to assign to the resource.
Thumbprint string: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
Version string: The current version of the Key Vault Certificate.

certificate CertificateCertificate: A certificate block as defined below, used to Import an existing certificate.
certificateData string: The raw Key Vault Certificate data represented as a hexadecimal string.
certificatePolicy CertificateCertificatePolicy: A certificate_policy block as defined below.
keyVaultId string: The ID of the Key Vault where the Certificate should be created.
name string: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
secretId string: The ID of the associated Key Vault Secret.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
thumbprint string: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
version string: The current version of the Key Vault Certificate.

certificate Dict[CertificateCertificate]: A certificate block as defined below, used to Import an existing certificate.
certificate_data str: The raw Key Vault Certificate data represented as a hexadecimal string.
certificate_policy Dict[CertificateCertificatePolicy]: A certificate_policy block as defined below.
key_vault_id str: The ID of the Key Vault where the Certificate should be created.
name str: Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.
secret_id str: The ID of the associated Key Vault Secret.
tags Dict[str, str]: A mapping of tags to assign to the resource.
thumbprint str: The X509 Thumbprint of the Key Vault Certificate represented as a hexadecimal string.
version str: The current version of the Key Vault Certificate.

Supporting Types

CertificateCertificate

Contents string: The base64-encoded certificate contents. Changing this forces a new resource to be created.
Password string: The password associated with the certificate. Changing this forces a new resource to be created.

Contents string: The base64-encoded certificate contents. Changing this forces a new resource to be created.
Password string: The password associated with the certificate. Changing this forces a new resource to be created.

contents string: The base64-encoded certificate contents. Changing this forces a new resource to be created.
password string: The password associated with the certificate. Changing this forces a new resource to be created.

contents str: The base64-encoded certificate contents. Changing this forces a new resource to be created.
password str: The password associated with the certificate. Changing this forces a new resource to be created.

CertificateCertificatePolicy

IssuerParameters CertificateCertificatePolicyIssuerParametersArgs: A issuer_parameters block as defined below.
KeyProperties CertificateCertificatePolicyKeyPropertiesArgs: A key_properties block as defined below.
SecretProperties CertificateCertificatePolicySecretPropertiesArgs: A secret_properties block as defined below.
LifetimeActions List<CertificateCertificatePolicyLifetimeActionArgs>: A lifetime_action block as defined below.
X509CertificateProperties CertificateCertificatePolicyX509CertificatePropertiesArgs: A x509_certificate_properties block as defined below. Required when certificate block is not specified.

IssuerParameters CertificateCertificatePolicyIssuerParameters: A issuer_parameters block as defined below.
KeyProperties CertificateCertificatePolicyKeyProperties: A key_properties block as defined below.
SecretProperties CertificateCertificatePolicySecretProperties: A secret_properties block as defined below.
LifetimeActions []CertificateCertificatePolicyLifetimeAction: A lifetime_action block as defined below.
X509CertificateProperties CertificateCertificatePolicyX509CertificateProperties: A x509_certificate_properties block as defined below. Required when certificate block is not specified.

issuerParameters CertificateCertificatePolicyIssuerParameters: A issuer_parameters block as defined below.
keyProperties CertificateCertificatePolicyKeyProperties: A key_properties block as defined below.
secretProperties CertificateCertificatePolicySecretProperties: A secret_properties block as defined below.
lifetimeActions CertificateCertificatePolicyLifetimeAction[]: A lifetime_action block as defined below.
x509CertificateProperties CertificateCertificatePolicyX509CertificateProperties: A x509_certificate_properties block as defined below. Required when certificate block is not specified.

issuerParameters Dict[CertificateCertificatePolicyIssuerParameters]: A issuer_parameters block as defined below.
key_properties Dict[CertificateCertificatePolicyKeyProperties]: A key_properties block as defined below.
secretProperties Dict[CertificateCertificatePolicySecretProperties]: A secret_properties block as defined below.
lifetimeActions List[CertificateCertificatePolicyLifetimeAction]: A lifetime_action block as defined below.
x509CertificateProperties Dict[CertificateCertificatePolicyX509CertificateProperties]: A x509_certificate_properties block as defined below. Required when certificate block is not specified.

CertificateCertificatePolicyIssuerParameters

Name string: The name of the Certificate Issuer. Possible values include Self (for self-signed certificate), or Unknown (for a certificate issuing authority like Let's Encrypt and Azure direct supported ones). Changing this forces a new resource to be created.

Name string: The name of the Certificate Issuer. Possible values include Self (for self-signed certificate), or Unknown (for a certificate issuing authority like Let's Encrypt and Azure direct supported ones). Changing this forces a new resource to be created.

name string: The name of the Certificate Issuer. Possible values include Self (for self-signed certificate), or Unknown (for a certificate issuing authority like Let's Encrypt and Azure direct supported ones). Changing this forces a new resource to be created.

name str: The name of the Certificate Issuer. Possible values include Self (for self-signed certificate), or Unknown (for a certificate issuing authority like Let's Encrypt and Azure direct supported ones). Changing this forces a new resource to be created.

CertificateCertificatePolicyKeyProperties

Exportable bool: Is this Certificate Exportable? Changing this forces a new resource to be created.
KeySize int: The size of the Key used in the Certificate. Possible values include 2048 and 4096. Changing this forces a new resource to be created.
KeyType string: Specifies the Type of Key, such as RSA. Changing this forces a new resource to be created.
ReuseKey bool: Is the key reusable? Changing this forces a new resource to be created.

Exportable bool: Is this Certificate Exportable? Changing this forces a new resource to be created.
KeySize int: The size of the Key used in the Certificate. Possible values include 2048 and 4096. Changing this forces a new resource to be created.
KeyType string: Specifies the Type of Key, such as RSA. Changing this forces a new resource to be created.
ReuseKey bool: Is the key reusable? Changing this forces a new resource to be created.

exportable boolean: Is this Certificate Exportable? Changing this forces a new resource to be created.
keySize number: The size of the Key used in the Certificate. Possible values include 2048 and 4096. Changing this forces a new resource to be created.
keyType string: Specifies the Type of Key, such as RSA. Changing this forces a new resource to be created.
reuseKey boolean: Is the key reusable? Changing this forces a new resource to be created.

exportable bool: Is this Certificate Exportable? Changing this forces a new resource to be created.
key_size float: The size of the Key used in the Certificate. Possible values include 2048 and 4096. Changing this forces a new resource to be created.
key_type str: Specifies the Type of Key, such as RSA. Changing this forces a new resource to be created.
reuseKey bool: Is the key reusable? Changing this forces a new resource to be created.

CertificateCertificatePolicyLifetimeAction

Action CertificateCertificatePolicyLifetimeActionActionArgs: A action block as defined below.
Trigger CertificateCertificatePolicyLifetimeActionTriggerArgs: A trigger block as defined below.

Action CertificateCertificatePolicyLifetimeActionAction: A action block as defined below.
Trigger CertificateCertificatePolicyLifetimeActionTrigger: A trigger block as defined below.

action CertificateCertificatePolicyLifetimeActionAction: A action block as defined below.
trigger CertificateCertificatePolicyLifetimeActionTrigger: A trigger block as defined below.

action Dict[CertificateCertificatePolicyLifetimeActionAction]: A action block as defined below.
trigger Dict[CertificateCertificatePolicyLifetimeActionTrigger]: A trigger block as defined below.

CertificateCertificatePolicyLifetimeActionAction

ActionType string: The Type of action to be performed when the lifetime trigger is triggerec. Possible values include AutoRenew and EmailContacts. Changing this forces a new resource to be created.

ActionType string: The Type of action to be performed when the lifetime trigger is triggerec. Possible values include AutoRenew and EmailContacts. Changing this forces a new resource to be created.

actionType string: The Type of action to be performed when the lifetime trigger is triggerec. Possible values include AutoRenew and EmailContacts. Changing this forces a new resource to be created.

actionType str: The Type of action to be performed when the lifetime trigger is triggerec. Possible values include AutoRenew and EmailContacts. Changing this forces a new resource to be created.

CertificateCertificatePolicyLifetimeActionTrigger

DaysBeforeExpiry int: The number of days before the Certificate expires that the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with lifetime_percentage.
LifetimePercentage int: The percentage at which during the Certificates Lifetime the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with days_before_expiry.

DaysBeforeExpiry int: The number of days before the Certificate expires that the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with lifetime_percentage.
LifetimePercentage int: The percentage at which during the Certificates Lifetime the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with days_before_expiry.

daysBeforeExpiry number: The number of days before the Certificate expires that the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with lifetime_percentage.
lifetimePercentage number: The percentage at which during the Certificates Lifetime the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with days_before_expiry.

daysBeforeExpiry float: The number of days before the Certificate expires that the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with lifetime_percentage.
lifetimePercentage float: The percentage at which during the Certificates Lifetime the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with days_before_expiry.

CertificateCertificatePolicySecretProperties

ContentType string: The Content-Type of the Certificate, such as application/x-pkcs12 for a PFX or application/x-pem-file for a PEM. Changing this forces a new resource to be created.

ContentType string: The Content-Type of the Certificate, such as application/x-pkcs12 for a PFX or application/x-pem-file for a PEM. Changing this forces a new resource to be created.

contentType string: The Content-Type of the Certificate, such as application/x-pkcs12 for a PFX or application/x-pem-file for a PEM. Changing this forces a new resource to be created.

content_type str: The Content-Type of the Certificate, such as application/x-pkcs12 for a PFX or application/x-pem-file for a PEM. Changing this forces a new resource to be created.

CertificateCertificatePolicyX509CertificateProperties

KeyUsages List<string>: A list of uses associated with this Key. Possible values include cRLSign, dataEncipherment, decipherOnly, digitalSignature, encipherOnly, keyAgreement, keyCertSign, keyEncipherment and nonRepudiation and are case-sensitive. Changing this forces a new resource to be created.
Subject string: The Certificate’s Subject. Changing this forces a new resource to be created.
ValidityInMonths int: The Certificates Validity Period in Months. Changing this forces a new resource to be created.
ExtendedKeyUsages List<string>: A list of Extended/Enhanced Key Usages. Changing this forces a new resource to be created.
SubjectAlternativeNames CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNamesArgs: A subject_alternative_names block as defined below.

KeyUsages []string: A list of uses associated with this Key. Possible values include cRLSign, dataEncipherment, decipherOnly, digitalSignature, encipherOnly, keyAgreement, keyCertSign, keyEncipherment and nonRepudiation and are case-sensitive. Changing this forces a new resource to be created.
Subject string: The Certificate’s Subject. Changing this forces a new resource to be created.
ValidityInMonths int: The Certificates Validity Period in Months. Changing this forces a new resource to be created.
ExtendedKeyUsages []string: A list of Extended/Enhanced Key Usages. Changing this forces a new resource to be created.
SubjectAlternativeNames CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames: A subject_alternative_names block as defined below.

keyUsages string[]: A list of uses associated with this Key. Possible values include cRLSign, dataEncipherment, decipherOnly, digitalSignature, encipherOnly, keyAgreement, keyCertSign, keyEncipherment and nonRepudiation and are case-sensitive. Changing this forces a new resource to be created.
subject string: The Certificate’s Subject. Changing this forces a new resource to be created.
validityInMonths number: The Certificates Validity Period in Months. Changing this forces a new resource to be created.
extendedKeyUsages string[]: A list of Extended/Enhanced Key Usages. Changing this forces a new resource to be created.
subjectAlternativeNames CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames: A subject_alternative_names block as defined below.

keyUsages List[str]: A list of uses associated with this Key. Possible values include cRLSign, dataEncipherment, decipherOnly, digitalSignature, encipherOnly, keyAgreement, keyCertSign, keyEncipherment and nonRepudiation and are case-sensitive. Changing this forces a new resource to be created.
subject str: The Certificate’s Subject. Changing this forces a new resource to be created.
validityInMonths float: The Certificates Validity Period in Months. Changing this forces a new resource to be created.
extendedKeyUsages List[str]: A list of Extended/Enhanced Key Usages. Changing this forces a new resource to be created.
subjectAlternativeNames Dict[CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames]: A subject_alternative_names block as defined below.

CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames

DnsNames List<string>: A list of alternative DNS names (FQDNs) identified by the Certificate. Changing this forces a new resource to be created.
Emails List<string>: A list of email addresses identified by this Certificate. Changing this forces a new resource to be created.
Upns List<string>: A list of User Principal Names identified by the Certificate. Changing this forces a new resource to be created.

DnsNames []string: A list of alternative DNS names (FQDNs) identified by the Certificate. Changing this forces a new resource to be created.
Emails []string: A list of email addresses identified by this Certificate. Changing this forces a new resource to be created.
Upns []string: A list of User Principal Names identified by the Certificate. Changing this forces a new resource to be created.

dnsNames string[]: A list of alternative DNS names (FQDNs) identified by the Certificate. Changing this forces a new resource to be created.
emails string[]: A list of email addresses identified by this Certificate. Changing this forces a new resource to be created.
upns string[]: A list of User Principal Names identified by the Certificate. Changing this forces a new resource to be created.

dnsNames List[str]: A list of alternative DNS names (FQDNs) identified by the Certificate. Changing this forces a new resource to be created.
emails List[str]: A list of email addresses identified by this Certificate. Changing this forces a new resource to be created.
upns List[str]: A list of User Principal Names identified by the Certificate. Changing this forces a new resource to be created.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud