你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Web 证书 2020-12-01

• 最新
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01

Bicep 资源定义

可以使用针对以下操作部署证书资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Web/certificates 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Web/certificates@2020-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    canonicalName: 'string'
    domainValidationMethod: 'string'
    hostNames: [
      'string'
    ]
    keyVaultId: 'string'
    keyVaultSecretName: 'string'
    password: 'string'
    pfxBlob: any()
    serverFarmId: 'string'
  }
}

属性值

certificates

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符： 不得使用： / 不得以空格或句点结尾。
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。 请参阅 模板中的标记
kind	资源类型。	string
properties	特定于证书资源的属性	CertificateProperties

CertificateProperties

名称	说明	值
canonicalName	要通过免费证书颁发的证书的 CNAME	string
domainValidationMethod	免费证书的域验证方法	字符串
主机 名	证书适用的主机名。	string[]
keyVaultId	密钥保管库 Csm 资源 ID。	字符串
keyVaultSecretName	密钥保管库机密名称。	字符串
password	证书密码。	字符串
pfxBlob	Pfx blob。	对于 Bicep，可以使用 any () 函数。
serverFarmId	关联的App 服务计划的资源 ID，格式为：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
创建并分配标准App 服务证书	创建标准App 服务证书，使用应用服务应用对其进行验证，并在证书准备就绪后创建 SSL 绑定
创建和分配通配符App 服务证书	创建通配符App 服务证书，使用应用服务域对其进行验证，并在证书准备就绪后在App 服务应用上创建 SSL 绑定
创建应用服务托管证书	(适用于 WebApp 的免费) APEX (根域) 创建托管证书
ILB ASE 或 ILB ASE v2 的 SSL 证书	Configures the default SSL certificate for an ILB ASE or an ILB ASE v2（为 ILB ASE 或 ILB ASE v2 配置默认的 SSL 证书）
Web 应用与 密钥保管库 集成	从密钥保管库机密部署 Web 应用证书，并将其用于创建 SSL 绑定
具有自定义域和可选 SSL 绑定的 Web 应用	使用自定义域创建 Web 应用，并根据需要添加用于 https 加密的 SSL 证书。

ARM 模板资源定义

可以使用针对以下操作部署证书资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Web/certificates 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Web/certificates",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "canonicalName": "string",
    "domainValidationMethod": "string",
    "hostNames": [ "string" ],
    "keyVaultId": "string",
    "keyVaultSecretName": "string",
    "password": "string",
    "pfxBlob": {},
    "serverFarmId": "string"
  }
}

属性值

certificates

名称	说明	Value
type	资源类型	“Microsoft.Web/certificates”
apiVersion	资源 API 版本	'2020-12-01'
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符： 不得使用： / 不得以空格或句点结尾。
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。 请参阅 模板中的标记
kind	资源类型。	string
properties	证书资源特定的属性	CertificateProperties

CertificateProperties

名称	说明	值
canonicalName	要通过免费证书颁发的证书的 CNAME	string
domainValidationMethod	免费证书的域验证方法	字符串
主机 名	证书适用的主机名。	string[]
keyVaultId	密钥保管库 Csm 资源 ID。	string
keyVaultSecretName	密钥保管库机密名称。	字符串
password	证书密码。	string
pfxBlob	Pfx blob。
serverFarmId	关联的App 服务计划的资源 ID，格式为：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
创建和分配标准App 服务证书	创建标准App 服务证书，使用应用服务应用对其进行验证，并在证书准备就绪后创建 SSL 绑定
创建和分配通配符App 服务证书	创建通配符App 服务证书，使用应用服务域对其进行验证，并在证书准备就绪后在App 服务应用上创建 SSL 绑定
创建应用服务托管证书	为 WebApp 创建 (免费) APEX (根域) 的托管证书
ILB ASE 或 ILB ASE v2 的 SSL 证书	Configures the default SSL certificate for an ILB ASE or an ILB ASE v2（为 ILB ASE 或 ILB ASE v2 配置默认的 SSL 证书）
Web 应用与 密钥保管库 集成	从密钥保管库机密部署 Web 应用证书，并将其用于创建 SSL 绑定
具有自定义域和可选 SSL 绑定的 Web 应用	使用自定义域创建 Web 应用 和 ，并选择性地添加用于 https 加密的 SSL 证书。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署证书资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Web/certificates 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/certificates@2020-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      canonicalName = "string"
      domainValidationMethod = "string"
      hostNames = [
        "string"
      ]
      keyVaultId = "string"
      keyVaultSecretName = "string"
      password = "string"
      serverFarmId = "string"
    }
    kind = "string"
  })
}

属性值

certificates

名称	说明	Value
type	资源类型	“Microsoft.Web/certificates@2020-12-01”
name	资源名称	字符串 (必需) 字符限制：1-260 有效字符： 不得使用： / 不得以空格或句点结尾。
location	资源位置。	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
kind	资源类型。	string
properties	证书资源特定的属性	CertificateProperties

CertificateProperties

名称	说明	值
canonicalName	要通过免费证书颁发的证书的 CNAME	string
domainValidationMethod	免费证书的域验证方法	字符串
主机 名	证书适用的主机名。	string[]
keyVaultId	密钥保管库 Csm 资源 ID。	string
keyVaultSecretName	密钥保管库机密名称。	字符串
password	证书密码。	字符串
pfxBlob	Pfx blob。
serverFarmId	关联的App 服务计划的资源 ID，格式为：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。	字符串