Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 4.1 KB

app_service_certificate.html.markdown

File metadata and controls

97 lines (61 loc) · 4.1 KB
Raw
subcategory layout page_title description
App Service (Web Apps)
azurerm
Azure Resource Manager: azurerm_app_service_certificate
Manages an App Service certificate.

azurerm_app_service_certificate

Manages an App Service certificate.

Example Usage

This example provisions an App Service Certificate from a Local File. Additional examples of how to use the azurerm_app_service_certificate resource can be found in the ./examples/app-service/certificate` directory within the Github Repository.

resource "azurerm_resource_group" "example" {
  name     = "example-resources"
  location = "West Europe"
}

resource "azurerm_app_service_certificate" "example" {
  name                = "example-cert"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location
  pfx_blob            = filebase64("certificate.pfx")
  password            = "terraform"
}

Argument Reference

The following arguments are supported:

  • name - (Required) Specifies the name of the certificate. Changing this forces a new resource to be created.

  • resource_group_name - (Required) The name of the resource group in which to create the certificate. Changing this forces a new resource to be created.

  • location - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • pfx_blob - (Optional) The base64-encoded contents of the certificate. Changing this forces a new resource to be created.

-> NOTE: Either pfx_blob or key_vault_secret_id must be set - but not both.

  • password - (Optional) The password to access the certificate's private key. Changing this forces a new resource to be created.

  • hosting_environment_profile_id - (Optional) Must be specified when the certificate is for an App Service Environment hosted App Service. Changing this forces a new resource to be created.

  • key_vault_secret_id - (Optional) The ID of the Key Vault secret. Changing this forces a new resource to be created.

-> NOTE: If using key_vault_secret_id, the WebApp Service Resource Principal ID abfa0a7c-a6b6-4736-8310-5855508787cd must have 'Secret -> get' and 'Certificate -> get' permissions on the Key Vault containing the certificate. (Source: App Service Blog) If you use Terraform to create the access policy you have to specify the Object ID of this Principal. This Object ID can be retrieved via following data reference, since it is different in every AAD Tenant:

data "azuread_service_principal" "MicrosoftWebApp" {
  application_id = "abfa0a7c-a6b6-4736-8310-5855508787cd"
}

Attributes Reference

The following attributes are exported:

  • id - The App Service certificate ID.

  • friendly_name - The friendly name of the certificate.

  • subject_name - The subject name of the certificate.

  • host_names - List of host names the certificate applies to.

  • issuer - The name of the certificate issuer.

  • issue_date - The issue date for the certificate.

  • expiration_date - The expiration date for the certificate.

  • thumbprint - The thumbprint for the certificate.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the App Service Certificate.
  • update - (Defaults to 30 minutes) Used when updating the App Service Certificate.
  • read - (Defaults to 5 minutes) Used when retrieving the App Service Certificate.
  • delete - (Defaults to 30 minutes) Used when deleting the App Service Certificate.

Import

App Service Certificates can be imported using the resource id, e.g.

terraform import azurerm_app_service_certificate.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Web/certificates/certificate1