Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. web
  5. getCertificate
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.web.getCertificate

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Description for Get a certificate. Azure REST API version: 2022-09-01.

Other available API versions: 2016-03-01, 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.

Using getCertificate

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 getCertificate(args: GetCertificateArgs, opts?: InvokeOptions): Promise<GetCertificateResult>
function getCertificateOutput(args: GetCertificateOutputArgs, opts?: InvokeOptions): Output<GetCertificateResult>
Copy
def get_certificate(name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCertificateResult
def get_certificate_output(name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCertificateResult]
Copy
func LookupCertificate(ctx *Context, args *LookupCertificateArgs, opts ...InvokeOption) (*LookupCertificateResult, error)
func LookupCertificateOutput(ctx *Context, args *LookupCertificateOutputArgs, opts ...InvokeOption) LookupCertificateResultOutput
Copy

> Note: This function is named LookupCertificate in the Go SDK.

public static class GetCertificate 
{
    public static Task<GetCertificateResult> InvokeAsync(GetCertificateArgs args, InvokeOptions? opts = null)
    public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
public static Output<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:getCertificate
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the certificate.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the certificate.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the certificate.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the certificate.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the certificate.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the certificate.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.

getCertificate Result

The following output properties are available:

CerBlob string
Raw bytes of .cer file
ExpirationDate string
Certificate expiration date.
FriendlyName string
Friendly name of the certificate.
HostingEnvironmentProfile Pulumi.AzureNative.Web.Outputs.HostingEnvironmentProfileResponse
Specification for the App Service Environment to use for the certificate.
Id string
Resource Id.
IssueDate string
Certificate issue Date.
Issuer string
Certificate issuer.
KeyVaultSecretStatus string
Status of the Key Vault secret.
Location string
Resource Location.
Name string
Resource Name.
PublicKeyHash string
Public key hash.
SelfLink string
Self link.
SiteName string
App name.
SubjectName string
Subject name of the certificate.
Thumbprint string
Certificate thumbprint.
Type string
Resource type.
Valid bool
Is the certificate valid?.
CanonicalName string
CNAME of the certificate to be issued via free certificate
DomainValidationMethod string
Method of domain validation for free cert
HostNames List<string>
Host names the certificate applies to.
KeyVaultId string
Key Vault Csm resource Id.
KeyVaultSecretName string
Key Vault secret name.
Kind string
Kind of resource.
PfxBlob string
Pfx blob.
ServerFarmId string
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
Tags Dictionary<string, string>
Resource tags.
CerBlob string
Raw bytes of .cer file
ExpirationDate string
Certificate expiration date.
FriendlyName string
Friendly name of the certificate.
HostingEnvironmentProfile HostingEnvironmentProfileResponse
Specification for the App Service Environment to use for the certificate.
Id string
Resource Id.
IssueDate string
Certificate issue Date.
Issuer string
Certificate issuer.
KeyVaultSecretStatus string
Status of the Key Vault secret.
Location string
Resource Location.
Name string
Resource Name.
PublicKeyHash string
Public key hash.
SelfLink string
Self link.
SiteName string
App name.
SubjectName string
Subject name of the certificate.
Thumbprint string
Certificate thumbprint.
Type string
Resource type.
Valid bool
Is the certificate valid?.
CanonicalName string
CNAME of the certificate to be issued via free certificate
DomainValidationMethod string
Method of domain validation for free cert
HostNames []string
Host names the certificate applies to.
KeyVaultId string
Key Vault Csm resource Id.
KeyVaultSecretName string
Key Vault secret name.
Kind string
Kind of resource.
PfxBlob string
Pfx blob.
ServerFarmId string
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
Tags map[string]string
Resource tags.
cerBlob String
Raw bytes of .cer file
expirationDate String
Certificate expiration date.
friendlyName String
Friendly name of the certificate.
hostingEnvironmentProfile HostingEnvironmentProfileResponse
Specification for the App Service Environment to use for the certificate.
id String
Resource Id.
issueDate String
Certificate issue Date.
issuer String
Certificate issuer.
keyVaultSecretStatus String
Status of the Key Vault secret.
location String
Resource Location.
name String
Resource Name.
publicKeyHash String
Public key hash.
selfLink String
Self link.
siteName String
App name.
subjectName String
Subject name of the certificate.
thumbprint String
Certificate thumbprint.
type String
Resource type.
valid Boolean
Is the certificate valid?.
canonicalName String
CNAME of the certificate to be issued via free certificate
domainValidationMethod String
Method of domain validation for free cert
hostNames List<String>
Host names the certificate applies to.
keyVaultId String
Key Vault Csm resource Id.
keyVaultSecretName String
Key Vault secret name.
kind String
Kind of resource.
pfxBlob String
Pfx blob.
serverFarmId String
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
tags Map<String,String>
Resource tags.
cerBlob string
Raw bytes of .cer file
expirationDate string
Certificate expiration date.
friendlyName string
Friendly name of the certificate.
hostingEnvironmentProfile HostingEnvironmentProfileResponse
Specification for the App Service Environment to use for the certificate.
id string
Resource Id.
issueDate string
Certificate issue Date.
issuer string
Certificate issuer.
keyVaultSecretStatus string
Status of the Key Vault secret.
location string
Resource Location.
name string
Resource Name.
publicKeyHash string
Public key hash.
selfLink string
Self link.
siteName string
App name.
subjectName string
Subject name of the certificate.
thumbprint string
Certificate thumbprint.
type string
Resource type.
valid boolean
Is the certificate valid?.
canonicalName string
CNAME of the certificate to be issued via free certificate
domainValidationMethod string
Method of domain validation for free cert
hostNames string[]
Host names the certificate applies to.
keyVaultId string
Key Vault Csm resource Id.
keyVaultSecretName string
Key Vault secret name.
kind string
Kind of resource.
pfxBlob string
Pfx blob.
serverFarmId string
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
tags {[key: string]: string}
Resource tags.
cer_blob str
Raw bytes of .cer file
expiration_date str
Certificate expiration date.
friendly_name str
Friendly name of the certificate.
hosting_environment_profile HostingEnvironmentProfileResponse
Specification for the App Service Environment to use for the certificate.
id str
Resource Id.
issue_date str
Certificate issue Date.
issuer str
Certificate issuer.
key_vault_secret_status str
Status of the Key Vault secret.
location str
Resource Location.
name str
Resource Name.
public_key_hash str
Public key hash.
self_link str
Self link.
site_name str
App name.
subject_name str
Subject name of the certificate.
thumbprint str
Certificate thumbprint.
type str
Resource type.
valid bool
Is the certificate valid?.
canonical_name str
CNAME of the certificate to be issued via free certificate
domain_validation_method str
Method of domain validation for free cert
host_names Sequence[str]
Host names the certificate applies to.
key_vault_id str
Key Vault Csm resource Id.
key_vault_secret_name str
Key Vault secret name.
kind str
Kind of resource.
pfx_blob str
Pfx blob.
server_farm_id str
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
tags Mapping[str, str]
Resource tags.
cerBlob String
Raw bytes of .cer file
expirationDate String
Certificate expiration date.
friendlyName String
Friendly name of the certificate.
hostingEnvironmentProfile Property Map
Specification for the App Service Environment to use for the certificate.
id String
Resource Id.
issueDate String
Certificate issue Date.
issuer String
Certificate issuer.
keyVaultSecretStatus String
Status of the Key Vault secret.
location String
Resource Location.
name String
Resource Name.
publicKeyHash String
Public key hash.
selfLink String
Self link.
siteName String
App name.
subjectName String
Subject name of the certificate.
thumbprint String
Certificate thumbprint.
type String
Resource type.
valid Boolean
Is the certificate valid?.
canonicalName String
CNAME of the certificate to be issued via free certificate
domainValidationMethod String
Method of domain validation for free cert
hostNames List<String>
Host names the certificate applies to.
keyVaultId String
Key Vault Csm resource Id.
keyVaultSecretName String
Key Vault secret name.
kind String
Kind of resource.
pfxBlob String
Pfx blob.
serverFarmId String
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
tags Map<String>
Resource tags.

Supporting Types

HostingEnvironmentProfileResponse

Name This property is required. string
Name of the App Service Environment.
Type This property is required. string
Resource type of the App Service Environment.
Id string
Resource ID of the App Service Environment.
Name This property is required. string
Name of the App Service Environment.
Type This property is required. string
Resource type of the App Service Environment.
Id string
Resource ID of the App Service Environment.
name This property is required. String
Name of the App Service Environment.
type This property is required. String
Resource type of the App Service Environment.
id String
Resource ID of the App Service Environment.
name This property is required. string
Name of the App Service Environment.
type This property is required. string
Resource type of the App Service Environment.
id string
Resource ID of the App Service Environment.
name This property is required. str
Name of the App Service Environment.
type This property is required. str
Resource type of the App Service Environment.
id str
Resource ID of the App Service Environment.
name This property is required. String
Name of the App Service Environment.
type This property is required. String
Resource type of the App Service Environment.
id String
Resource ID of the App Service Environment.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native