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

We recommend using Azure Native.

Azure Classic v5.52.0 published on Monday, Oct 2, 2023 by Pulumi

azure.appservice.getCertificateOrder

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.52.0 published on Monday, Oct 2, 2023 by Pulumi

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

    Example Usage

    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 main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/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
    	})
    }
    
    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.applyValue(getCertificateOrderResult -> getCertificateOrderResult.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)
    
    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);
    
    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:appservice/getCertificateOrder:getCertificateOrder
      arguments:
        # arguments dictionary

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

    name String

    The name of the App Service.

    resourceGroupName String

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

    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 Boolean

    Whether the private key is external or not.

    keySize Integer

    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 Integer

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

    certificates Sequence[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 int

    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 Mapping[str, str]

    A mapping of tags to assign to the resource.

    validity_in_years int

    Duration in years (must be between 1 and 3).

    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.

    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.

    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 Map<String>

    A mapping of tags to assign to the resource.

    validityInYears Number

    Duration in years (must be between 1 and 3).

    Supporting Types

    GetCertificateOrderCertificate

    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.

    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.52.0 published on Monday, Oct 2, 2023 by Pulumi