GetCertificateOrder

Use this data source to access information about an existing App Service Certificate Order.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.AppService.GetCertificateOrder.InvokeAsync(new Azure.AppService.GetCertificateOrderArgs
        {
            Name = "example-cert-order",
            ResourceGroupName = "example-resources",
        }));
        this.CertificateOrderId = example.Apply(example => example.Id);
    }

    [Output("certificateOrderId")]
    public Output<string> CertificateOrderId { get; set; }
}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := appservice.LookupCertificateOrder(ctx, &appservice.LookupCertificateOrderArgs{
            Name:              "example-cert-order",
            ResourceGroupName: "example-resources",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("certificateOrderId", example.Id)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.appservice.get_certificate_order(name="example-cert-order",
    resource_group_name="example-resources")
pulumi.export("certificateOrderId", example.id)

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

const example = azure.appservice.getCertificateOrder({
    name: "example-cert-order",
    resourceGroupName: "example-resources",
});
export const certificateOrderId = example.then(example => example.id);

Using GetCertificateOrder

function getCertificateOrder(args: GetCertificateOrderArgs, opts?: InvokeOptions): Promise<GetCertificateOrderResult>

function  get_certificate_order(name=None, resource_group_name=None, opts=None)

func LookupCertificateOrder(ctx *Context, args *LookupCertificateOrderArgs, opts ...InvokeOption) (*LookupCertificateOrderResult, error)

Note: This function is named LookupCertificateOrder in the Go SDK.

public static class GetCertificateOrder {
    public static Task<GetCertificateOrderResult> InvokeAsync(GetCertificateOrderArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the App Service.
ResourceGroupName string: The Name of the Resource Group where the App Service exists.

Name string: The name of the App Service.
ResourceGroupName string: The Name of the Resource Group where the App Service exists.

name string: The name of the App Service.
resourceGroupName string: The Name of the Resource Group where the App Service exists.

name str: The name of the App Service.
resource_group_name str: The Name of the Resource Group where the App Service exists.

GetCertificateOrder Result

The following output properties are available:

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.
Certificates List<GetCertificateOrderCertificate>: 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.
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.
KeySize int: Certificate key size.
Location string: The Azure location where the App Service exists.
Name string
ProductType string: Certificate product type, such as Standard or WildCard.
ResourceGroupName string
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).

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.
Certificates []GetCertificateOrderCertificate: 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.
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.
KeySize int: Certificate key size.
Location string: The Azure location where the App Service exists.
Name string
ProductType string: Certificate product type, such as Standard or WildCard.
ResourceGroupName string
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).

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.
certificates GetCertificateOrderCertificate[]: 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.
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.
keySize number: Certificate key size.
location string: The Azure location where the App Service exists.
name string
productType string: Certificate product type, such as Standard or WildCard.
resourceGroupName string
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).

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.
certificates List[GetCertificateOrderCertificate]: 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.
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.
key_size float: Certificate key size.
location str: The Azure location where the App Service exists.
name str
product_type str: Certificate product type, such as Standard or WildCard.
resource_group_name str
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).

Supporting Types

GetCertificateOrderCertificate

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

GetCertificateOrder

Example Usage

Using GetCertificateOrder

GetCertificateOrder Result

Supporting Types

GetCertificateOrderCertificate

Package Details

On This Page