@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* SSL certificate for an app.
*
* Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.
*
* Other available API versions: 2016-03-01, 2018-02-01, 2018-11-01, 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01, 2024-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native web [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Certificate extends pulumi.CustomResource {
/**
* Get an existing Certificate resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Certificate;
/**
* Returns true if the given object is an instance of Certificate. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Certificate;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* CNAME of the certificate to be issued via free certificate
*/
readonly canonicalName: pulumi.Output<string | undefined>;
/**
* Raw bytes of .cer file
*/
readonly cerBlob: pulumi.Output<string>;
/**
* Method of domain validation for free cert
*/
readonly domainValidationMethod: pulumi.Output<string | undefined>;
/**
* Certificate expiration date.
*/
readonly expirationDate: pulumi.Output<string>;
/**
* Friendly name of the certificate.
*/
readonly friendlyName: pulumi.Output<string>;
/**
* Host names the certificate applies to.
*/
readonly hostNames: pulumi.Output<string[] | undefined>;
/**
* Specification for the App Service Environment to use for the certificate.
*/
readonly hostingEnvironmentProfile: pulumi.Output<outputs.web.HostingEnvironmentProfileResponse>;
/**
* Certificate issue Date.
*/
readonly issueDate: pulumi.Output<string>;
/**
* Certificate issuer.
*/
readonly issuer: pulumi.Output<string>;
/**
* Key Vault Csm resource Id.
*/
readonly keyVaultId: pulumi.Output<string | undefined>;
/**
* Key Vault secret name.
*/
readonly keyVaultSecretName: pulumi.Output<string | undefined>;
/**
* Status of the Key Vault secret.
*/
readonly keyVaultSecretStatus: pulumi.Output<string>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
readonly kind: pulumi.Output<string | undefined>;
/**
* Resource Location.
*/
readonly location: pulumi.Output<string>;
/**
* Resource Name.
*/
readonly name: pulumi.Output<string>;
/**
* Pfx blob.
*/
readonly pfxBlob: pulumi.Output<string | undefined>;
/**
* Public key hash.
*/
readonly publicKeyHash: pulumi.Output<string>;
/**
* Self link.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
*/
readonly serverFarmId: pulumi.Output<string | undefined>;
/**
* App name.
*/
readonly siteName: pulumi.Output<string>;
/**
* Subject name of the certificate.
*/
readonly subjectName: pulumi.Output<string>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Certificate thumbprint.
*/
readonly thumbprint: pulumi.Output<string>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Is the certificate valid?.
*/
readonly valid: pulumi.Output<boolean>;
/**
* Create a Certificate resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Certificate resource.
*/
export interface CertificateArgs {
/**
* CNAME of the certificate to be issued via free certificate
*/
canonicalName?: pulumi.Input<string>;
/**
* Method of domain validation for free cert
*/
domainValidationMethod?: pulumi.Input<string>;
/**
* Host names the certificate applies to.
*/
hostNames?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Key Vault Csm resource Id.
*/
keyVaultId?: pulumi.Input<string>;
/**
* Key Vault secret name.
*/
keyVaultSecretName?: pulumi.Input<string>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
kind?: pulumi.Input<string>;
/**
* Resource Location.
*/
location?: pulumi.Input<string>;
/**
* Name of the certificate.
*/
name?: pulumi.Input<string>;
/**
* Certificate password.
*/
password?: pulumi.Input<string>;
/**
* Pfx blob.
*/
pfxBlob?: pulumi.Input<string>;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
*/
serverFarmId?: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}