We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.appservice.getCertificateOrder
Start a Neo task
Explain and create an azure.appservice.getCertificateOrder resource
Use this data source to access information about an existing App Service Certificate Order.
Example Usage
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);
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)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
"github.com/pulumi/pulumi/sdk/v3/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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.AppService.GetCertificateOrder.Invoke(new()
{
Name = "example-cert-order",
ResourceGroupName = "example-resources",
});
return new Dictionary<string, object?>
{
["certificateOrderId"] = example.Apply(getCertificateOrderResult => getCertificateOrderResult.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.appservice.AppserviceFunctions;
import com.pulumi.azure.appservice.inputs.GetCertificateOrderArgs;
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) {
final var example = AppserviceFunctions.getCertificateOrder(GetCertificateOrderArgs.builder()
.name("example-cert-order")
.resourceGroupName("example-resources")
.build());
ctx.export("certificateOrderId", example.id());
}
}
variables:
example:
fn::invoke:
function: azure:appservice:getCertificateOrder
arguments:
name: example-cert-order
resourceGroupName: example-resources
outputs:
certificateOrderId: ${example.id}
Using getCertificateOrder
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCertificateOrder(args: GetCertificateOrderArgs, opts?: InvokeOptions): Promise<GetCertificateOrderResult>
function getCertificateOrderOutput(args: GetCertificateOrderOutputArgs, opts?: InvokeOptions): Output<GetCertificateOrderResult>def get_certificate_order(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCertificateOrderResult
def get_certificate_order_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCertificateOrderResult]func LookupCertificateOrder(ctx *Context, args *LookupCertificateOrderArgs, opts ...InvokeOption) (*LookupCertificateOrderResult, error)
func LookupCertificateOrderOutput(ctx *Context, args *LookupCertificateOrderOutputArgs, opts ...InvokeOption) LookupCertificateOrderResultOutput> Note: This function is named LookupCertificateOrder in the Go SDK.
public static class GetCertificateOrder
{
public static Task<GetCertificateOrderResult> InvokeAsync(GetCertificateOrderArgs args, InvokeOptions? opts = null)
public static Output<GetCertificateOrderResult> Invoke(GetCertificateOrderInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCertificateOrderResult> getCertificateOrder(GetCertificateOrderArgs args, InvokeOptions options)
public static Output<GetCertificateOrderResult> getCertificateOrder(GetCertificateOrderArgs args, InvokeOptions options)
fn::invoke:
function: azure:appservice/getCertificateOrder:getCertificateOrder
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The name of the App Service.
- Resource
Group stringName - The Name of the Resource Group where the App Service exists.
- Name string
- The name of the App Service.
- Resource
Group stringName - The Name of the Resource Group where the App Service exists.
- name String
- The name of the App Service.
- resource
Group StringName - The Name of the Resource Group where the App Service exists.
- name string
- The name of the App Service.
- resource
Group stringName - The Name of the Resource Group where the App Service exists.
- name str
- The name of the App Service.
- resource_
group_ strname - The Name of the Resource Group where the App Service exists.
- name String
- The name of the App Service.
- resource
Group StringName - The Name of the Resource Group where the App Service exists.
getCertificateOrder Result
The following output properties are available:
- App
Service List<string>Certificate Not Renewable Reasons - 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<Get
Certificate Order Certificate> - State of the Key Vault secret. A
certificatesblock as defined below. - Csr string
- Last CSR that was created for this order.
- Distinguished
Name string - The Distinguished Name for the App Service Certificate Order.
- Domain
Verification stringToken - Domain verification token.
- Expiration
Time string - Certificate expiration time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Intermediate
Thumbprint string - Certificate thumbprint intermediate certificate.
- Is
Private boolKey External - Whether the private key is external or not.
- Key
Size int - Certificate key size.
- Location string
- The Azure location where the App Service exists.
- Name string
- Product
Type string - Certificate product type, such as
StandardorWildCard. - Resource
Group stringName - Root
Thumbprint string - Certificate thumbprint for root certificate.
- Signed
Certificate stringThumbprint - Certificate thumbprint for signed certificate.
- Status string
- Current order status.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Validity
In intYears - Duration in years (must be between 1 and 3).
- App
Service []stringCertificate Not Renewable Reasons - 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
[]Get
Certificate Order Certificate - State of the Key Vault secret. A
certificatesblock as defined below. - Csr string
- Last CSR that was created for this order.
- Distinguished
Name string - The Distinguished Name for the App Service Certificate Order.
- Domain
Verification stringToken - Domain verification token.
- Expiration
Time string - Certificate expiration time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Intermediate
Thumbprint string - Certificate thumbprint intermediate certificate.
- Is
Private boolKey External - Whether the private key is external or not.
- Key
Size int - Certificate key size.
- Location string
- The Azure location where the App Service exists.
- Name string
- Product
Type string - Certificate product type, such as
StandardorWildCard. - Resource
Group stringName - Root
Thumbprint string - Certificate thumbprint for root certificate.
- Signed
Certificate stringThumbprint - Certificate thumbprint for signed certificate.
- Status string
- Current order status.
- map[string]string
- A mapping of tags to assign to the resource.
- Validity
In intYears - Duration in years (must be between 1 and 3).
- app
Service List<String>Certificate Not Renewable Reasons - Reasons why App Service Certificate is not renewable at the current moment.
- auto
Renew Boolean - true if the certificate should be automatically renewed when it expires; otherwise, false.
- certificates
List<Get
Certificate Order Certificate> - State of the Key Vault secret. A
certificatesblock as defined below. - csr String
- Last CSR that was created for this order.
- distinguished
Name String - The Distinguished Name for the App Service Certificate Order.
- domain
Verification StringToken - Domain verification token.
- expiration
Time String - Certificate expiration time.
- id String
- The provider-assigned unique ID for this managed resource.
- intermediate
Thumbprint String - Certificate thumbprint intermediate certificate.
- is
Private BooleanKey External - Whether the private key is external or not.
- key
Size Integer - Certificate key size.
- location String
- The Azure location where the App Service exists.
- name String
- product
Type String - Certificate product type, such as
StandardorWildCard. - resource
Group StringName - root
Thumbprint String - Certificate thumbprint for root certificate.
- signed
Certificate StringThumbprint - Certificate thumbprint for signed certificate.
- status String
- Current order status.
- Map<String,String>
- A mapping of tags to assign to the resource.
- validity
In IntegerYears - Duration in years (must be between 1 and 3).
- app
Service string[]Certificate Not Renewable Reasons - Reasons why App Service Certificate is not renewable at the current moment.
- auto
Renew boolean - true if the certificate should be automatically renewed when it expires; otherwise, false.
- certificates
Get
Certificate Order Certificate[] - State of the Key Vault secret. A
certificatesblock as defined below. - csr string
- Last CSR that was created for this order.
- distinguished
Name string - The Distinguished Name for the App Service Certificate Order.
- domain
Verification stringToken - Domain verification token.
- expiration
Time string - Certificate expiration time.
- id string
- The provider-assigned unique ID for this managed resource.
- intermediate
Thumbprint string - Certificate thumbprint intermediate certificate.
- is
Private booleanKey External - Whether the private key is external or not.
- key
Size number - Certificate key size.
- location string
- The Azure location where the App Service exists.
- name string
- product
Type string - Certificate product type, such as
StandardorWildCard. - resource
Group stringName - root
Thumbprint string - Certificate thumbprint for root certificate.
- signed
Certificate stringThumbprint - Certificate thumbprint for signed certificate.
- status string
- Current order status.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- validity
In numberYears - Duration in years (must be between 1 and 3).
- app_
service_ Sequence[str]certificate_ not_ renewable_ reasons - 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
Sequence[Get
Certificate Order Certificate] - State of the Key Vault secret. A
certificatesblock 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_ strtoken - 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_ boolkey_ external - Whether the private key is external or not.
- key_
size int - Certificate key size.
- location str
- The Azure location where the App Service exists.
- name str
- product_
type str - Certificate product type, such as
StandardorWildCard. - resource_
group_ strname - root_
thumbprint str - Certificate thumbprint for root certificate.
- signed_
certificate_ strthumbprint - Certificate thumbprint for signed certificate.
- status str
- Current order status.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- validity_
in_ intyears - Duration in years (must be between 1 and 3).
- app
Service List<String>Certificate Not Renewable Reasons - Reasons why App Service Certificate is not renewable at the current moment.
- auto
Renew Boolean - true if the certificate should be automatically renewed when it expires; otherwise, false.
- certificates List<Property Map>
- State of the Key Vault secret. A
certificatesblock as defined below. - csr String
- Last CSR that was created for this order.
- distinguished
Name String - The Distinguished Name for the App Service Certificate Order.
- domain
Verification StringToken - Domain verification token.
- expiration
Time String - Certificate expiration time.
- id String
- The provider-assigned unique ID for this managed resource.
- intermediate
Thumbprint String - Certificate thumbprint intermediate certificate.
- is
Private BooleanKey External - Whether the private key is external or not.
- key
Size Number - Certificate key size.
- location String
- The Azure location where the App Service exists.
- name String
- product
Type String - Certificate product type, such as
StandardorWildCard. - resource
Group StringName - root
Thumbprint String - Certificate thumbprint for root certificate.
- signed
Certificate StringThumbprint - Certificate thumbprint for signed certificate.
- status String
- Current order status.
- Map<String>
- A mapping of tags to assign to the resource.
- validity
In NumberYears - Duration in years (must be between 1 and 3).
Supporting Types
GetCertificateOrderCertificate
- Certificate
Name string - The name of the App Service Certificate.
- Key
Vault stringId - Key Vault resource Id.
- Key
Vault stringSecret Name - Key Vault secret name.
- Provisioning
State string - Status of the Key Vault secret.
- Certificate
Name string - The name of the App Service Certificate.
- Key
Vault stringId - Key Vault resource Id.
- Key
Vault stringSecret Name - Key Vault secret name.
- Provisioning
State string - Status of the Key Vault secret.
- certificate
Name String - The name of the App Service Certificate.
- key
Vault StringId - Key Vault resource Id.
- key
Vault StringSecret Name - Key Vault secret name.
- provisioning
State String - Status of the Key Vault secret.
- certificate
Name string - The name of the App Service Certificate.
- key
Vault stringId - Key Vault resource Id.
- key
Vault stringSecret Name - Key Vault secret name.
- provisioning
State string - Status of the Key Vault secret.
- certificate_
name str - The name of the App Service Certificate.
- key_
vault_ strid - Key Vault resource Id.
- key_
vault_ strsecret_ name - Key Vault secret name.
- provisioning_
state str - Status of the Key Vault secret.
- certificate
Name String - The name of the App Service Certificate.
- key
Vault StringId - Key Vault resource Id.
- key
Vault StringSecret Name - Key Vault secret name.
- provisioning
State String - Status of the Key Vault secret.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
