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

Certificates - Create Or Update

Service:

App Service

API Version:

2023-12-01

Create或更新证书的说明。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}?api-version=2023-12-01

URI 参数

名称	在	必需	类型	说明
name	path	True	string	证书的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Azure 订阅 ID。 这是一个 GUID 格式的字符串， (例如 00000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

请求正文

名称	必需	类型	说明
location	True	string	资源位置。
kind		string	资源类型。
properties.canonicalName		string	要通过免费证书颁发的证书的 CNAME
properties.domainValidationMethod		string	免费证书的域验证方法
properties.hostNames		string[]	证书适用的主机名。
properties.keyVaultId		string	密钥保管库 Csm 资源 ID。
properties.keyVaultSecretName		string	密钥保管库机密名称。
properties.password		string	证书密码。
properties.pfxBlob		string	Pfx blob。
properties.serverFarmId		string	关联的App 服务计划的资源 ID，格式为：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	Certificate	没问题。
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create Or Update Certificate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282?api-version=2023-12-01

{
  "location": "East US",
  "properties": {
    "hostNames": [
      "ServerCert"
    ],
    "password": "<password>"
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282",
  "name": "testc6282",
  "type": "Microsoft.Web/certificates",
  "location": "East US",
  "properties": {
    "friendlyName": "",
    "subjectName": "ServerCert",
    "hostNames": [
      "ServerCert"
    ],
    "issuer": "CACert",
    "issueDate": "2015-11-12T23:40:25+00:00",
    "expirationDate": "2039-12-31T23:59:59+00:00",
    "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE"
  }
}

定义

名称	说明
Certificate	应用的 SSL 证书。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
HostingEnvironmentProfile	要用于此资源的应用服务环境的规范。
KeyVaultSecretStatus	密钥保管库机密的状态。

Certificate

应用的 SSL 证书。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
location	string	资源位置。
name	string	资源名称。
properties.canonicalName	string	要通过免费证书颁发的证书的 CNAME
properties.cerBlob	string	.cer 文件的原始字节数
properties.domainValidationMethod	string	免费证书的域验证方法
properties.expirationDate	string	证书过期日期。
properties.friendlyName	string	证书的友好名称。
properties.hostNames	string[]	证书适用的主机名。
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	要用于证书的应用服务环境的规范。
properties.issueDate	string	证书颁发日期。
properties.issuer	string	证书颁发者。
properties.keyVaultId	string	密钥保管库 Csm 资源 ID。
properties.keyVaultSecretName	string	密钥保管库机密名称。
properties.keyVaultSecretStatus	KeyVaultSecretStatus	密钥保管库机密的状态。
properties.password	string	证书密码。
properties.pfxBlob	string	Pfx blob。
properties.publicKeyHash	string	公钥哈希。
properties.selfLink	string	自我链接。
properties.serverFarmId	string	关联的App 服务计划的资源 ID，格式为：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。
properties.siteName	string	应用名称。
properties.subjectName	string	证书的使用者名称。
properties.thumbprint	string	证书指纹。
properties.valid	boolean	证书是否有效？。
tags	object	资源标记。
type	string	资源类型。

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

HostingEnvironmentProfile

要用于此资源的应用服务环境的规范。

名称	类型	说明
id	string	应用服务环境的资源 ID。
name	string	应用服务环境的名称。
type	string	应用服务环境的资源类型。

KeyVaultSecretStatus

密钥保管库机密的状态。

名称	类型	说明
AzureServiceUnauthorizedToAccessKeyVault	string
CertificateOrderFailed	string
ExternalPrivateKey	string
Initialized	string
KeyVaultDoesNotExist	string
KeyVaultSecretDoesNotExist	string
OperationNotPermittedOnKeyVault	string
Succeeded	string
Unknown	string
UnknownError	string
WaitingOnCertificateOrder	string