Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.11.0 published on Monday, Jun 27, 2022 by Pulumi

ManagedCertificate

This certificate can be used to secure custom domains on App Services (Windows and Linux) hosted on an App Service Plan of Basic and above (free and shared tiers are not supported).

NOTE: A certificate is valid for six months, and about a month before the certificate‚Äôs expiration date, App Services renews/rotates the certificate. This is managed by Azure and doesn’t require this resource to be changed or reprovisioned. It will change the thumbprint computed attribute the next time the resource is refreshed after rotation occurs, so keep that in mind if you have any dependencies on this attribute directly.

Create a ManagedCertificate Resource

new ManagedCertificate(name: string, args: ManagedCertificateArgs, opts?: CustomResourceOptions);
@overload
def ManagedCertificate(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       custom_hostname_binding_id: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
@overload
def ManagedCertificate(resource_name: str,
                       args: ManagedCertificateArgs,
                       opts: Optional[ResourceOptions] = None)
func NewManagedCertificate(ctx *Context, name string, args ManagedCertificateArgs, opts ...ResourceOption) (*ManagedCertificate, error)
public ManagedCertificate(string name, ManagedCertificateArgs args, CustomResourceOptions? opts = null)
public ManagedCertificate(String name, ManagedCertificateArgs args)
public ManagedCertificate(String name, ManagedCertificateArgs args, CustomResourceOptions options)
type: azure:appservice:ManagedCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ManagedCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ManagedCertificateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ManagedCertificateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ManagedCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ManagedCertificateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ManagedCertificate Resource Properties

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

Inputs

The ManagedCertificate resource accepts the following input properties:

CustomHostnameBindingId string

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the App Service Managed Certificate.

CustomHostnameBindingId string

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

Tags map[string]string

A mapping of tags which should be assigned to the App Service Managed Certificate.

customHostnameBindingId String

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

tags Map<String,String>

A mapping of tags which should be assigned to the App Service Managed Certificate.

customHostnameBindingId string

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

tags {[key: string]: string}

A mapping of tags which should be assigned to the App Service Managed Certificate.

custom_hostname_binding_id str

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

tags Mapping[str, str]

A mapping of tags which should be assigned to the App Service Managed Certificate.

customHostnameBindingId String

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

tags Map<String>

A mapping of tags which should be assigned to the App Service Managed Certificate.

Outputs

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

CanonicalName string

The Canonical Name of the Certificate.

ExpirationDate string

The expiration date of the Certificate.

FriendlyName string

The friendly name of the Certificate.

HostNames List<string>

The list of Host Names for the Certificate.

Id string

The provider-assigned unique ID for this managed resource.

IssueDate string

The Start date for the Certificate.

Issuer string

The issuer of the Certificate.

SubjectName string

The Subject Name for the Certificate.

Thumbprint string

The Certificate Thumbprint.

CanonicalName string

The Canonical Name of the Certificate.

ExpirationDate string

The expiration date of the Certificate.

FriendlyName string

The friendly name of the Certificate.

HostNames []string

The list of Host Names for the Certificate.

Id string

The provider-assigned unique ID for this managed resource.

IssueDate string

The Start date for the Certificate.

Issuer string

The issuer of the Certificate.

SubjectName string

The Subject Name for the Certificate.

Thumbprint string

The Certificate Thumbprint.

canonicalName String

The Canonical Name of the Certificate.

expirationDate String

The expiration date of the Certificate.

friendlyName String

The friendly name of the Certificate.

hostNames List<String>

The list of Host Names for the Certificate.

id String

The provider-assigned unique ID for this managed resource.

issueDate String

The Start date for the Certificate.

issuer String

The issuer of the Certificate.

subjectName String

The Subject Name for the Certificate.

thumbprint String

The Certificate Thumbprint.

canonicalName string

The Canonical Name of the Certificate.

expirationDate string

The expiration date of the Certificate.

friendlyName string

The friendly name of the Certificate.

hostNames string[]

The list of Host Names for the Certificate.

id string

The provider-assigned unique ID for this managed resource.

issueDate string

The Start date for the Certificate.

issuer string

The issuer of the Certificate.

subjectName string

The Subject Name for the Certificate.

thumbprint string

The Certificate Thumbprint.

canonical_name str

The Canonical Name of the Certificate.

expiration_date str

The expiration date of the Certificate.

friendly_name str

The friendly name of the Certificate.

host_names Sequence[str]

The list of Host Names for the Certificate.

id str

The provider-assigned unique ID for this managed resource.

issue_date str

The Start date for the Certificate.

issuer str

The issuer of the Certificate.

subject_name str

The Subject Name for the Certificate.

thumbprint str

The Certificate Thumbprint.

canonicalName String

The Canonical Name of the Certificate.

expirationDate String

The expiration date of the Certificate.

friendlyName String

The friendly name of the Certificate.

hostNames List<String>

The list of Host Names for the Certificate.

id String

The provider-assigned unique ID for this managed resource.

issueDate String

The Start date for the Certificate.

issuer String

The issuer of the Certificate.

subjectName String

The Subject Name for the Certificate.

thumbprint String

The Certificate Thumbprint.

Look up an Existing ManagedCertificate Resource

Get an existing ManagedCertificate 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?: ManagedCertificateState, opts?: CustomResourceOptions): ManagedCertificate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        canonical_name: Optional[str] = None,
        custom_hostname_binding_id: Optional[str] = None,
        expiration_date: Optional[str] = None,
        friendly_name: Optional[str] = None,
        host_names: Optional[Sequence[str]] = None,
        issue_date: Optional[str] = None,
        issuer: Optional[str] = None,
        subject_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        thumbprint: Optional[str] = None) -> ManagedCertificate
func GetManagedCertificate(ctx *Context, name string, id IDInput, state *ManagedCertificateState, opts ...ResourceOption) (*ManagedCertificate, error)
public static ManagedCertificate Get(string name, Input<string> id, ManagedCertificateState? state, CustomResourceOptions? opts = null)
public static ManagedCertificate get(String name, Output<String> id, ManagedCertificateState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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:
CanonicalName string

The Canonical Name of the Certificate.

CustomHostnameBindingId string

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

ExpirationDate string

The expiration date of the Certificate.

FriendlyName string

The friendly name of the Certificate.

HostNames List<string>

The list of Host Names for the Certificate.

IssueDate string

The Start date for the Certificate.

Issuer string

The issuer of the Certificate.

SubjectName string

The Subject Name for the Certificate.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the App Service Managed Certificate.

Thumbprint string

The Certificate Thumbprint.

CanonicalName string

The Canonical Name of the Certificate.

CustomHostnameBindingId string

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

ExpirationDate string

The expiration date of the Certificate.

FriendlyName string

The friendly name of the Certificate.

HostNames []string

The list of Host Names for the Certificate.

IssueDate string

The Start date for the Certificate.

Issuer string

The issuer of the Certificate.

SubjectName string

The Subject Name for the Certificate.

Tags map[string]string

A mapping of tags which should be assigned to the App Service Managed Certificate.

Thumbprint string

The Certificate Thumbprint.

canonicalName String

The Canonical Name of the Certificate.

customHostnameBindingId String

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

expirationDate String

The expiration date of the Certificate.

friendlyName String

The friendly name of the Certificate.

hostNames List<String>

The list of Host Names for the Certificate.

issueDate String

The Start date for the Certificate.

issuer String

The issuer of the Certificate.

subjectName String

The Subject Name for the Certificate.

tags Map<String,String>

A mapping of tags which should be assigned to the App Service Managed Certificate.

thumbprint String

The Certificate Thumbprint.

canonicalName string

The Canonical Name of the Certificate.

customHostnameBindingId string

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

expirationDate string

The expiration date of the Certificate.

friendlyName string

The friendly name of the Certificate.

hostNames string[]

The list of Host Names for the Certificate.

issueDate string

The Start date for the Certificate.

issuer string

The issuer of the Certificate.

subjectName string

The Subject Name for the Certificate.

tags {[key: string]: string}

A mapping of tags which should be assigned to the App Service Managed Certificate.

thumbprint string

The Certificate Thumbprint.

canonical_name str

The Canonical Name of the Certificate.

custom_hostname_binding_id str

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

expiration_date str

The expiration date of the Certificate.

friendly_name str

The friendly name of the Certificate.

host_names Sequence[str]

The list of Host Names for the Certificate.

issue_date str

The Start date for the Certificate.

issuer str

The issuer of the Certificate.

subject_name str

The Subject Name for the Certificate.

tags Mapping[str, str]

A mapping of tags which should be assigned to the App Service Managed Certificate.

thumbprint str

The Certificate Thumbprint.

canonicalName String

The Canonical Name of the Certificate.

customHostnameBindingId String

The ID of the App Service Custom Hostname Binding for the Certificate. Changing this forces a new App Service Managed Certificate to be created.

expirationDate String

The expiration date of the Certificate.

friendlyName String

The friendly name of the Certificate.

hostNames List<String>

The list of Host Names for the Certificate.

issueDate String

The Start date for the Certificate.

issuer String

The issuer of the Certificate.

subjectName String

The Subject Name for the Certificate.

tags Map<String>

A mapping of tags which should be assigned to the App Service Managed Certificate.

thumbprint String

The Certificate Thumbprint.

Import

App Service Managed Certificates can be imported using the resource id, e.g.

 $ pulumi import azure:appservice/managedCertificate:ManagedCertificate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.Web/certificates/customhost.contoso.com

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.