Certificate

Manages an App Service certificate.

Create a Certificate Resource

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

def Certificate(resource_name, opts=None, hosting_environment_profile_id=None, key_vault_secret_id=None, location=None, name=None, password=None, pfx_blob=None, resource_group_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:

ResourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
HostingEnvironmentProfileId string: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
KeyVaultSecretId string: The ID of the Key Vault secret. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
Password string: The password to access the certificate’s private key. Changing this forces a new resource to be created.
PfxBlob string: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
Tags Dictionary<string, string>

ResourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
HostingEnvironmentProfileId string: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
KeyVaultSecretId string: The ID of the Key Vault secret. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
Password string: The password to access the certificate’s private key. Changing this forces a new resource to be created.
PfxBlob string: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
Tags map[string]string

resourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
hostingEnvironmentProfileId string: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
keyVaultSecretId string: The ID of the Key Vault secret. Changing this forces a new resource to be created.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
password string: The password to access the certificate’s private key. Changing this forces a new resource to be created.
pfxBlob string: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
tags {[key: string]: string}

resource_group_name str: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
hosting_environment_profile_id str: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
key_vault_secret_id str: The ID of the Key Vault secret. Changing this forces a new resource to be created.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the certificate. Changing this forces a new resource to be created.
password str: The password to access the certificate’s private key. Changing this forces a new resource to be created.
pfx_blob str: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
tags Dict[str, str]

Outputs

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

ExpirationDate string: The expiration date for the certificate.
FriendlyName string: The friendly name of the certificate.
HostNames List<string>: List of host names the certificate applies to.
Id string: The provider-assigned unique ID for this managed resource.
IssueDate string: The issue date for the certificate.
Issuer string: The name of the certificate issuer.
SubjectName string: The subject name of the certificate.
Thumbprint string: The thumbprint for the certificate.

ExpirationDate string: The expiration date for the certificate.
FriendlyName string: The friendly name of the certificate.
HostNames []string: List of host names the certificate applies to.
Id string: The provider-assigned unique ID for this managed resource.
IssueDate string: The issue date for the certificate.
Issuer string: The name of the certificate issuer.
SubjectName string: The subject name of the certificate.
Thumbprint string: The thumbprint for the certificate.

expirationDate string: The expiration date for the certificate.
friendlyName string: The friendly name of the certificate.
hostNames string[]: List of host names the certificate applies to.
id string: The provider-assigned unique ID for this managed resource.
issueDate string: The issue date for the certificate.
issuer string: The name of the certificate issuer.
subjectName string: The subject name of the certificate.
thumbprint string: The thumbprint for the certificate.

expiration_date str: The expiration date for the certificate.
friendly_name str: The friendly name of the certificate.
host_names List[str]: List of host names the certificate applies to.
id str: The provider-assigned unique ID for this managed resource.
issue_date str: The issue date for the certificate.
issuer str: The name of the certificate issuer.
subject_name str: The subject name of the certificate.
thumbprint str: The thumbprint for the 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, expiration_date=None, friendly_name=None, host_names=None, hosting_environment_profile_id=None, issue_date=None, issuer=None, key_vault_secret_id=None, location=None, name=None, password=None, pfx_blob=None, resource_group_name=None, subject_name=None, tags=None, thumbprint=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:

ExpirationDate string: The expiration date for the certificate.
FriendlyName string: The friendly name of the certificate.
HostNames List<string>: List of host names the certificate applies to.
HostingEnvironmentProfileId string: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
IssueDate string: The issue date for the certificate.
Issuer string: The name of the certificate issuer.
KeyVaultSecretId string: The ID of the Key Vault secret. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
Password string: The password to access the certificate’s private key. Changing this forces a new resource to be created.
PfxBlob string: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
SubjectName string: The subject name of the certificate.
Tags Dictionary<string, string>
Thumbprint string: The thumbprint for the certificate.

ExpirationDate string: The expiration date for the certificate.
FriendlyName string: The friendly name of the certificate.
HostNames []string: List of host names the certificate applies to.
HostingEnvironmentProfileId string: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
IssueDate string: The issue date for the certificate.
Issuer string: The name of the certificate issuer.
KeyVaultSecretId string: The ID of the Key Vault secret. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
Password string: The password to access the certificate’s private key. Changing this forces a new resource to be created.
PfxBlob string: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
SubjectName string: The subject name of the certificate.
Tags map[string]string
Thumbprint string: The thumbprint for the certificate.

expirationDate string: The expiration date for the certificate.
friendlyName string: The friendly name of the certificate.
hostNames string[]: List of host names the certificate applies to.
hostingEnvironmentProfileId string: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
issueDate string: The issue date for the certificate.
issuer string: The name of the certificate issuer.
keyVaultSecretId string: The ID of the Key Vault secret. Changing this forces a new resource to be created.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
password string: The password to access the certificate’s private key. Changing this forces a new resource to be created.
pfxBlob string: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
subjectName string: The subject name of the certificate.
tags {[key: string]: string}
thumbprint string: The thumbprint for the certificate.

expiration_date str: The expiration date for the certificate.
friendly_name str: The friendly name of the certificate.
host_names List[str]: List of host names the certificate applies to.
hosting_environment_profile_id str: Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.
issue_date str: The issue date for the certificate.
issuer str: The name of the certificate issuer.
key_vault_secret_id str: The ID of the Key Vault secret. Changing this forces a new resource to be created.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the certificate. Changing this forces a new resource to be created.
password str: The password to access the certificate’s private key. Changing this forces a new resource to be created.
pfx_blob str: The base64-encoded contents of the certificate. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
subject_name str: The subject name of the certificate.
tags Dict[str, str]
thumbprint str: The thumbprint for the certificate.

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