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

App Service Certificate Orders - Create Or Update Certificate

参考

Service:: App Service

API Version:: 2023-12-01

有关创建或更新证书并与密钥保管库机密关联的说明。

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

URI 参数

名称	在	必需	类型	说明
certificateOrderName	path	True	string	证书订单的名称。
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.keyVaultId		string	密钥保管库资源 ID。
properties.keyVaultSecretName		string	密钥保管库机密名称。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	AppServiceCertificateResource	App 服务证书已创建。
201 Created	AppServiceCertificateResource	App 服务证书创建操作正在进行中
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 Certificate

Sample Request

HTTP

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

{
  "location": "Global",
  "properties": {
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
    "keyVaultSecretName": "SampleSecretName1"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1",
  "name": "SampleCertName1",
  "type": "Microsoft.CertificateRegistration/certificateOrders/certificates",
  "location": "Global",
  "properties": {
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
    "keyVaultSecretName": "SampleSecretName1",
    "provisioningState": "Succeeded"
  }
}

Status code:: 201

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.CertificateRegistration/certificateOrders/SampleCertificateOrderName/certificates/SampleCertName1",
  "name": "SampleCertName1",
  "type": "Microsoft.CertificateRegistration/certificateOrders/certificates",
  "location": "Global",
  "properties": {
    "keyVaultId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
    "keyVaultSecretName": "SampleSecretName1",
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
AppServiceCertificateResource	密钥保管库通过 Azure 购买的证书的容器 ARM 资源。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
KeyVaultSecretStatus	密钥保管库机密的状态。

AppServiceCertificateResource

密钥保管库通过 Azure 购买的证书的容器 ARM 资源。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
location	string	资源位置。
name	string	资源名称。
properties.keyVaultId	string	密钥保管库资源 ID。
properties.keyVaultSecretName	string	密钥保管库机密名称。
properties.provisioningState	KeyVaultSecretStatus	密钥保管库机密的状态。
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	详细的错误说明和调试信息。

KeyVaultSecretStatus

密钥保管库机密的状态。

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

Share via