CertificateOrder

Manages an App Service Certificate Order.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleCertificateOrder = new Azure.AppService.CertificateOrder("exampleCertificateOrder", new Azure.AppService.CertificateOrderArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = "global",
            DistinguishedName = "CN=example.com",
            ProductType = "Standard",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/appservice"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        _, err = appservice.NewCertificateOrder(ctx, "exampleCertificateOrder", &appservice.CertificateOrderArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          pulumi.String("global"),
            DistinguishedName: pulumi.String("CN=example.com"),
            ProductType:       pulumi.String("Standard"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_certificate_order = azure.appservice.CertificateOrder("exampleCertificateOrder",
    resource_group_name=example_resource_group.name,
    location="global",
    distinguished_name="CN=example.com",
    product_type="Standard")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleCertificateOrder = new azure.appservice.CertificateOrder("exampleCertificateOrder", {
    resourceGroupName: exampleResourceGroup.name,
    location: "global",
    distinguishedName: "CN=example.com",
    productType: "Standard",
});

Create a CertificateOrder Resource

new CertificateOrder(name: string, args: CertificateOrderArgs, opts?: CustomResourceOptions);

def CertificateOrder(resource_name, opts=None, auto_renew=None, csr=None, distinguished_name=None, key_size=None, location=None, name=None, product_type=None, resource_group_name=None, tags=None, validity_in_years=None, __props__=None);

func NewCertificateOrder(ctx *Context, name string, args CertificateOrderArgs, opts ...ResourceOption) (*CertificateOrder, error)

public CertificateOrder(string name, CertificateOrderArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args CertificateOrderArgs: 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 CertificateOrderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

CertificateOrder Resource Properties

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

Inputs

The CertificateOrder 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.
AutoRenew bool: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
Csr string: Last CSR that was created for this order.
DistinguishedName string: The Distinguished Name for the App Service Certificate Order.
KeySize int: Certificate key size. Defaults to 2048.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
ProductType string: Certificate product type, such as Standard or WildCard.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
ValidityInYears int: Duration in years (must be between 1 and 3). Defaults to 1.

ResourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
AutoRenew bool: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
Csr string: Last CSR that was created for this order.
DistinguishedName string: The Distinguished Name for the App Service Certificate Order.
KeySize int: Certificate key size. Defaults to 2048.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
ProductType string: Certificate product type, such as Standard or WildCard.
Tags map[string]string: A mapping of tags to assign to the resource.
ValidityInYears int: Duration in years (must be between 1 and 3). Defaults to 1.

resourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
autoRenew boolean: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
csr string: Last CSR that was created for this order.
distinguishedName string: The Distinguished Name for the App Service Certificate Order.
keySize number: Certificate key size. Defaults to 2048.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
productType string: Certificate product type, such as Standard or WildCard.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
validityInYears number: Duration in years (must be between 1 and 3). Defaults to 1.

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.
auto_renew bool: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
csr str: Last CSR that was created for this order.
distinguished_name str: The Distinguished Name for the App Service Certificate Order.
key_size float: Certificate key size. Defaults to 2048.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
name str: Specifies the name of the certificate. Changing this forces a new resource to be created.
product_type str: Certificate product type, such as Standard or WildCard.
tags Dict[str, str]: A mapping of tags to assign to the resource.
validity_in_years float: Duration in years (must be between 1 and 3). Defaults to 1.

Outputs

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

AppServiceCertificateNotRenewableReasons List<string>: Reasons why App Service Certificate is not renewable at the current moment.
Certificates List<CertificateOrderCertificate>: State of the Key Vault secret. A certificates block as defined below.
DomainVerificationToken string: Domain verification token.
ExpirationTime string: Certificate expiration time.
Id string: The provider-assigned unique ID for this managed resource.
IntermediateThumbprint string: Certificate thumbprint intermediate certificate.
IsPrivateKeyExternal bool: Whether the private key is external or not.
RootThumbprint string: Certificate thumbprint for root certificate.
SignedCertificateThumbprint string: Certificate thumbprint for signed certificate.
Status string: Current order status.

AppServiceCertificateNotRenewableReasons []string: Reasons why App Service Certificate is not renewable at the current moment.
Certificates []CertificateOrderCertificate: State of the Key Vault secret. A certificates block as defined below.
DomainVerificationToken string: Domain verification token.
ExpirationTime string: Certificate expiration time.
Id string: The provider-assigned unique ID for this managed resource.
IntermediateThumbprint string: Certificate thumbprint intermediate certificate.
IsPrivateKeyExternal bool: Whether the private key is external or not.
RootThumbprint string: Certificate thumbprint for root certificate.
SignedCertificateThumbprint string: Certificate thumbprint for signed certificate.
Status string: Current order status.

appServiceCertificateNotRenewableReasons string[]: Reasons why App Service Certificate is not renewable at the current moment.
certificates CertificateOrderCertificate[]: State of the Key Vault secret. A certificates block as defined below.
domainVerificationToken string: Domain verification token.
expirationTime string: Certificate expiration time.
id string: The provider-assigned unique ID for this managed resource.
intermediateThumbprint string: Certificate thumbprint intermediate certificate.
isPrivateKeyExternal boolean: Whether the private key is external or not.
rootThumbprint string: Certificate thumbprint for root certificate.
signedCertificateThumbprint string: Certificate thumbprint for signed certificate.
status string: Current order status.

app_service_certificate_not_renewable_reasons List[str]: Reasons why App Service Certificate is not renewable at the current moment.
certificates List[CertificateOrderCertificate]: State of the Key Vault secret. A certificates block as defined below.
domain_verification_token str: Domain verification token.
expiration_time str: Certificate expiration time.
id str: The provider-assigned unique ID for this managed resource.
intermediate_thumbprint str: Certificate thumbprint intermediate certificate.
is_private_key_external bool: Whether the private key is external or not.
root_thumbprint str: Certificate thumbprint for root certificate.
signed_certificate_thumbprint str: Certificate thumbprint for signed certificate.
status str: Current order status.

Look up an Existing CertificateOrder Resource

Get an existing CertificateOrder 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?: CertificateOrderState, opts?: CustomResourceOptions): CertificateOrder

static get(resource_name, id, opts=None, app_service_certificate_not_renewable_reasons=None, auto_renew=None, certificates=None, csr=None, distinguished_name=None, domain_verification_token=None, expiration_time=None, intermediate_thumbprint=None, is_private_key_external=None, key_size=None, location=None, name=None, product_type=None, resource_group_name=None, root_thumbprint=None, signed_certificate_thumbprint=None, status=None, tags=None, validity_in_years=None, __props__=None);

func GetCertificateOrder(ctx *Context, name string, id IDInput, state *CertificateOrderState, opts ...ResourceOption) (*CertificateOrder, error)

public static CertificateOrder Get(string name, Input<string> id, CertificateOrderState? 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:

AppServiceCertificateNotRenewableReasons List<string>: Reasons why App Service Certificate is not renewable at the current moment.
AutoRenew bool: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
Certificates List<CertificateOrderCertificateArgs>: State of the Key Vault secret. A certificates block as defined below.
Csr string: Last CSR that was created for this order.
DistinguishedName string: The Distinguished Name for the App Service Certificate Order.
DomainVerificationToken string: Domain verification token.
ExpirationTime string: Certificate expiration time.
IntermediateThumbprint string: Certificate thumbprint intermediate certificate.
IsPrivateKeyExternal bool: Whether the private key is external or not.
KeySize int: Certificate key size. Defaults to 2048.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
ProductType string: Certificate product type, such as Standard or WildCard.
ResourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
RootThumbprint string: Certificate thumbprint for root certificate.
SignedCertificateThumbprint string: Certificate thumbprint for signed certificate.
Status string: Current order status.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
ValidityInYears int: Duration in years (must be between 1 and 3). Defaults to 1.

AppServiceCertificateNotRenewableReasons []string: Reasons why App Service Certificate is not renewable at the current moment.
AutoRenew bool: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
Certificates []CertificateOrderCertificate: State of the Key Vault secret. A certificates block as defined below.
Csr string: Last CSR that was created for this order.
DistinguishedName string: The Distinguished Name for the App Service Certificate Order.
DomainVerificationToken string: Domain verification token.
ExpirationTime string: Certificate expiration time.
IntermediateThumbprint string: Certificate thumbprint intermediate certificate.
IsPrivateKeyExternal bool: Whether the private key is external or not.
KeySize int: Certificate key size. Defaults to 2048.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
Name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
ProductType string: Certificate product type, such as Standard or WildCard.
ResourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
RootThumbprint string: Certificate thumbprint for root certificate.
SignedCertificateThumbprint string: Certificate thumbprint for signed certificate.
Status string: Current order status.
Tags map[string]string: A mapping of tags to assign to the resource.
ValidityInYears int: Duration in years (must be between 1 and 3). Defaults to 1.

appServiceCertificateNotRenewableReasons string[]: Reasons why App Service Certificate is not renewable at the current moment.
autoRenew boolean: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
certificates CertificateOrderCertificate[]: State of the Key Vault secret. A certificates block as defined below.
csr string: Last CSR that was created for this order.
distinguishedName string: The Distinguished Name for the App Service Certificate Order.
domainVerificationToken string: Domain verification token.
expirationTime string: Certificate expiration time.
intermediateThumbprint string: Certificate thumbprint intermediate certificate.
isPrivateKeyExternal boolean: Whether the private key is external or not.
keySize number: Certificate key size. Defaults to 2048.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
name string: Specifies the name of the certificate. Changing this forces a new resource to be created.
productType string: Certificate product type, such as Standard or WildCard.
resourceGroupName string: The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.
rootThumbprint string: Certificate thumbprint for root certificate.
signedCertificateThumbprint string: Certificate thumbprint for signed certificate.
status string: Current order status.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
validityInYears number: Duration in years (must be between 1 and 3). Defaults to 1.

app_service_certificate_not_renewable_reasons List[str]: Reasons why App Service Certificate is not renewable at the current moment.
auto_renew bool: true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true.
certificates List[CertificateOrderCertificate]: State of the Key Vault secret. A certificates block as defined below.
csr str: Last CSR that was created for this order.
distinguished_name str: The Distinguished Name for the App Service Certificate Order.
domain_verification_token str: Domain verification token.
expiration_time str: Certificate expiration time.
intermediate_thumbprint str: Certificate thumbprint intermediate certificate.
is_private_key_external bool: Whether the private key is external or not.
key_size float: Certificate key size. Defaults to 2048.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Currently the only valid value is global.
name str: Specifies the name of the certificate. Changing this forces a new resource to be created.
product_type str: Certificate product type, such as Standard or WildCard.
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.
root_thumbprint str: Certificate thumbprint for root certificate.
signed_certificate_thumbprint str: Certificate thumbprint for signed certificate.
status str: Current order status.
tags Dict[str, str]: A mapping of tags to assign to the resource.
validity_in_years float: Duration in years (must be between 1 and 3). Defaults to 1.

Supporting Types

CertificateOrderCertificate

See the output API doc for this type.

CertificateName string: The name of the App Service Certificate.
KeyVaultId string: Key Vault resource Id.
KeyVaultSecretName string: Key Vault secret name.
ProvisioningState string: Status of the Key Vault secret.

CertificateName string: The name of the App Service Certificate.
KeyVaultId string: Key Vault resource Id.
KeyVaultSecretName string: Key Vault secret name.
ProvisioningState string: Status of the Key Vault secret.

certificateName string: The name of the App Service Certificate.
keyVaultId string: Key Vault resource Id.
keyVaultSecretName string: Key Vault secret name.
provisioningState string: Status of the Key Vault secret.

certificateName str: The name of the App Service Certificate.
keyVaultSecretName str: Key Vault secret name.
key_vault_id str: Key Vault resource Id.
provisioningState str: Status of the Key Vault secret.

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