Certificados Microsoft.Web 2023-01-01

Definição de recurso do Bicep

O tipo de recurso de certificados pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Web/certificates, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.Web/certificates@2023-01-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    canonicalName: 'string'
    domainValidationMethod: 'string'
    hostNames: [
      'string'
    ]
    keyVaultId: 'string'
    keyVaultSecretName: 'string'
    password: 'string'
    pfxBlob: any(...)
    serverFarmId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores da propriedade

Microsoft.Web/certificates

Nome Descrição Valor
tipo Tipo de recurso. cadeia
local Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades específicas do recurso de certificado CertificateProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

Propriedades do certificado

Nome Descrição Valor
CanonicalName CNAME do certificado a ser emitido por meio de certificado gratuito cadeia
domainValidationMethod Método de validação de domínio para certificado gratuito cadeia
nomes de host Nomeia o host ao qual o certificado se aplica. cadeia de caracteres[]
keyVaultId ID do recurso do Csm do Key Vault. cadeia
keyVaultSecretName Nome do segredo do Key Vault. cadeia
senha Senha do certificado. cadeia
pfxBlob Blob Pfx. qualquer
serverFarmId ID de recurso do plano do Serviço de Aplicativo associado, formatado como: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". cadeia

Tags de recursos

Nome Descrição Valor

Definição de recurso de modelo do ARM

O tipo de recurso de certificados pode ser implantado com operações de destino:

Exemplos de uso

Modelos de início rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
criar um certificado gerenciado dos Serviços de Aplicativo

Implantar no Azure
Criar APEX (certificado gerenciado) (domínio raiz) para WebApp
criar e atribuir um certificado padrão do Serviço de Aplicativo

Implantar no Azure
Cria um Certificado do Serviço de Aplicativo padrão, verifica-o usando um aplicativo do serviço de aplicativo e cria associações SSL quando o certificado estiver pronto
Criar e atribuir um de Certificado do Serviço de Aplicativo curinga

Implantar no Azure
Cria um Certificado do Serviço de Aplicativo curinga, verifica-o usando um domínio do serviço de aplicativo e cria associações SSL em um Aplicativo do Serviço de Aplicativo quando o certificado estiver pronto
certificado SSL para um ASE ILB ou um ILB ASE v2

Implantar no Azure
Configura o certificado SSL padrão para um ASE ILB ou um ILB ASE v2
integração do aplicativo Web com o Key Vault

Implantar no Azure
Implantar um certificado de aplicativo Web do segredo do Key Vault e usá-lo para criar associação SSL
Aplicativo Web com um domínio personalizado e uma associação SSL opcional

Implantar no Azure
Crie um aplicativo Web e com um domínio personalizado e, opcionalmente, adicione um certificado SSL para criptografia https.

Formato de recurso

Para criar um recurso Microsoft.Web/certificates, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Web/certificates",
  "apiVersion": "2023-01-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "canonicalName": "string",
    "domainValidationMethod": "string",
    "hostNames": [ "string" ],
    "keyVaultId": "string",
    "keyVaultSecretName": "string",
    "password": "string",
    "pfxBlob": {},
    "serverFarmId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores da propriedade

Microsoft.Web/certificates

Nome Descrição Valor
apiVersion A versão da API '2023-01-01'
tipo Tipo de recurso. cadeia
local Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades específicas do recurso de certificado CertificateProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.Web/certificates'

Propriedades do certificado

Nome Descrição Valor
CanonicalName CNAME do certificado a ser emitido por meio de certificado gratuito cadeia
domainValidationMethod Método de validação de domínio para certificado gratuito cadeia
nomes de host Nomeia o host ao qual o certificado se aplica. cadeia de caracteres[]
keyVaultId ID do recurso do Csm do Key Vault. cadeia
keyVaultSecretName Nome do segredo do Key Vault. cadeia
senha Senha do certificado. cadeia
pfxBlob Blob Pfx. qualquer
serverFarmId ID de recurso do plano do Serviço de Aplicativo associado, formatado como: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". cadeia

Tags de recursos

Nome Descrição Valor

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de certificados pode ser implantado com operações de destino:

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do certificado do Serviço de Aplicativo.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "certificate_password" {
  type        = string
  description = "The password for the PFX certificate"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "certificate" {
  type      = "Microsoft.Web/certificates@2021-02-01"
  name      = var.resource_name
  parent_id = azapi_resource.resourceGroup.id
  location  = var.location
  body = {
    properties = {
      pfxBlob  = filebase64("testdata/app_service_certificate.pfx")
      password = var.certificate_password
    }
  }
}

Formato de recurso

Para criar um recurso Microsoft.Web/certificates, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/certificates@2023-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      canonicalName = "string"
      domainValidationMethod = "string"
      hostNames = [
        "string"
      ]
      keyVaultId = "string"
      keyVaultSecretName = "string"
      password = "string"
      pfxBlob = ?
      serverFarmId = "string"
    }
  }
}

Valores da propriedade

Microsoft.Web/certificates

Nome Descrição Valor
tipo Tipo de recurso. cadeia
local Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades específicas do recurso de certificado CertificateProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.Web/certificates@2023-01-01"

Propriedades do certificado

Nome Descrição Valor
CanonicalName CNAME do certificado a ser emitido por meio de certificado gratuito cadeia
domainValidationMethod Método de validação de domínio para certificado gratuito cadeia
nomes de host Nomeia o host ao qual o certificado se aplica. cadeia de caracteres[]
keyVaultId ID do recurso do Csm do Key Vault. cadeia
keyVaultSecretName Nome do segredo do Key Vault. cadeia
senha Senha do certificado. cadeia
pfxBlob Blob Pfx. qualquer
serverFarmId ID de recurso do plano do Serviço de Aplicativo associado, formatado como: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". cadeia

Tags de recursos

Nome Descrição Valor