1. Packages
  2. Azure Classic
  3. API Docs
  4. appservice
  5. CertificateOrder

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

azure.appservice.CertificateOrder

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages an App Service Certificate Order.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleCertificateOrder = new azure.appservice.CertificateOrder("example", {
        name: "example-cert-order",
        resourceGroupName: example.name,
        location: "global",
        distinguishedName: "CN=example.com",
        productType: "Standard",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_certificate_order = azure.appservice.CertificateOrder("example",
        name="example-cert-order",
        resource_group_name=example.name,
        location="global",
        distinguished_name="CN=example.com",
        product_type="Standard")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appservice"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appservice.NewCertificateOrder(ctx, "example", &appservice.CertificateOrderArgs{
    			Name:              pulumi.String("example-cert-order"),
    			ResourceGroupName: example.Name,
    			Location:          pulumi.String("global"),
    			DistinguishedName: pulumi.String("CN=example.com"),
    			ProductType:       pulumi.String("Standard"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleCertificateOrder = new Azure.AppService.CertificateOrder("example", new()
        {
            Name = "example-cert-order",
            ResourceGroupName = example.Name,
            Location = "global",
            DistinguishedName = "CN=example.com",
            ProductType = "Standard",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.appservice.CertificateOrder;
    import com.pulumi.azure.appservice.CertificateOrderArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleCertificateOrder = new CertificateOrder("exampleCertificateOrder", CertificateOrderArgs.builder()        
                .name("example-cert-order")
                .resourceGroupName(example.name())
                .location("global")
                .distinguishedName("CN=example.com")
                .productType("Standard")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleCertificateOrder:
        type: azure:appservice:CertificateOrder
        name: example
        properties:
          name: example-cert-order
          resourceGroupName: ${example.name}
          location: global
          distinguishedName: CN=example.com
          productType: Standard
    

    Create CertificateOrder Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CertificateOrder(name: string, args: CertificateOrderArgs, opts?: CustomResourceOptions);
    @overload
    def CertificateOrder(resource_name: str,
                         args: CertificateOrderArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def CertificateOrder(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         resource_group_name: Optional[str] = None,
                         auto_renew: Optional[bool] = None,
                         csr: Optional[str] = None,
                         distinguished_name: Optional[str] = None,
                         key_size: Optional[int] = None,
                         location: Optional[str] = None,
                         name: Optional[str] = None,
                         product_type: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         validity_in_years: Optional[int] = None)
    func NewCertificateOrder(ctx *Context, name string, args CertificateOrderArgs, opts ...ResourceOption) (*CertificateOrder, error)
    public CertificateOrder(string name, CertificateOrderArgs args, CustomResourceOptions? opts = null)
    public CertificateOrder(String name, CertificateOrderArgs args)
    public CertificateOrder(String name, CertificateOrderArgs args, CustomResourceOptions options)
    
    type: azure:appservice:CertificateOrder
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var certificateOrderResource = new Azure.AppService.CertificateOrder("certificateOrderResource", new()
    {
        ResourceGroupName = "string",
        AutoRenew = false,
        Csr = "string",
        DistinguishedName = "string",
        KeySize = 0,
        Location = "string",
        Name = "string",
        ProductType = "string",
        Tags = 
        {
            { "string", "string" },
        },
        ValidityInYears = 0,
    });
    
    example, err := appservice.NewCertificateOrder(ctx, "certificateOrderResource", &appservice.CertificateOrderArgs{
    	ResourceGroupName: pulumi.String("string"),
    	AutoRenew:         pulumi.Bool(false),
    	Csr:               pulumi.String("string"),
    	DistinguishedName: pulumi.String("string"),
    	KeySize:           pulumi.Int(0),
    	Location:          pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	ProductType:       pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ValidityInYears: pulumi.Int(0),
    })
    
    var certificateOrderResource = new CertificateOrder("certificateOrderResource", CertificateOrderArgs.builder()        
        .resourceGroupName("string")
        .autoRenew(false)
        .csr("string")
        .distinguishedName("string")
        .keySize(0)
        .location("string")
        .name("string")
        .productType("string")
        .tags(Map.of("string", "string"))
        .validityInYears(0)
        .build());
    
    certificate_order_resource = azure.appservice.CertificateOrder("certificateOrderResource",
        resource_group_name="string",
        auto_renew=False,
        csr="string",
        distinguished_name="string",
        key_size=0,
        location="string",
        name="string",
        product_type="string",
        tags={
            "string": "string",
        },
        validity_in_years=0)
    
    const certificateOrderResource = new azure.appservice.CertificateOrder("certificateOrderResource", {
        resourceGroupName: "string",
        autoRenew: false,
        csr: "string",
        distinguishedName: "string",
        keySize: 0,
        location: "string",
        name: "string",
        productType: "string",
        tags: {
            string: "string",
        },
        validityInYears: 0,
    });
    
    type: azure:appservice:CertificateOrder
    properties:
        autoRenew: false
        csr: string
        distinguishedName: string
        keySize: 0
        location: string
        name: string
        productType: string
        resourceGroupName: string
        tags:
            string: string
        validityInYears: 0
    

    CertificateOrder 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 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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    Tags Dictionary<string, string>
    (Optional) 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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    Tags map[string]string
    (Optional) 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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    keySize Integer
    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. Defaults to Standard.
    tags Map<String,String>
    (Optional) A mapping of tags to assign to the resource.
    validityInYears Integer
    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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    tags {[key: string]: string}
    (Optional) 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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    key_size int
    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. Defaults to Standard.
    tags Mapping[str, str]
    (Optional) A mapping of tags to assign to the resource.
    validity_in_years 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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    tags Map<String>
    (Optional) A mapping of tags to assign to the resource.
    validityInYears Number
    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 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 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.
    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 Sequence[str]
    Reasons why App Service Certificate is not renewable at the current moment.
    certificates Sequence[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.
    appServiceCertificateNotRenewableReasons List<String>
    Reasons why App Service Certificate is not renewable at the current moment.
    certificates List<Property Map>
    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.

    Look up 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
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_service_certificate_not_renewable_reasons: Optional[Sequence[str]] = None,
            auto_renew: Optional[bool] = None,
            certificates: Optional[Sequence[CertificateOrderCertificateArgs]] = None,
            csr: Optional[str] = None,
            distinguished_name: Optional[str] = None,
            domain_verification_token: Optional[str] = None,
            expiration_time: Optional[str] = None,
            intermediate_thumbprint: Optional[str] = None,
            is_private_key_external: Optional[bool] = None,
            key_size: Optional[int] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            product_type: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            root_thumbprint: Optional[str] = None,
            signed_certificate_thumbprint: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            validity_in_years: Optional[int] = None) -> CertificateOrder
    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)
    public static CertificateOrder get(String name, Output<String> id, CertificateOrderState 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:
    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<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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    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>
    (Optional) 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 []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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    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
    (Optional) A mapping of tags to assign to the resource.
    ValidityInYears int
    Duration in years (must be between 1 and 3). Defaults to 1.
    appServiceCertificateNotRenewableReasons List<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 List<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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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 Integer
    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. Defaults to Standard.
    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>
    (Optional) A mapping of tags to assign to the resource.
    validityInYears Integer
    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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    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}
    (Optional) 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 Sequence[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 Sequence[CertificateOrderCertificateArgs]
    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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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 int
    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. Defaults to Standard.
    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 Mapping[str, str]
    (Optional) A mapping of tags to assign to the resource.
    validity_in_years int
    Duration in years (must be between 1 and 3). Defaults to 1.
    appServiceCertificateNotRenewableReasons List<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 List<Property Map>
    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.

    NOTE: Either csr or distinguished_name must be set - but not both.

    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. Defaults to Standard.
    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>
    (Optional) A mapping of tags to assign to the resource.
    validityInYears Number
    Duration in years (must be between 1 and 3). Defaults to 1.

    Supporting Types

    CertificateOrderCertificate, CertificateOrderCertificateArgs

    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 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.
    certificate_name str
    The name of the App Service Certificate.
    key_vault_id str
    Key Vault resource Id.
    key_vault_secret_name str
    Key Vault secret name.
    provisioning_state str
    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.

    Import

    App Service Certificate Orders can be imported using the resource id, e.g.

    $ pulumi import azure:appservice/certificateOrder:CertificateOrder example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.CertificateRegistration/certificateOrders/certificateorder1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi