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

Certificates - Create Or Update

参考

Service:: IoT Hub

API Version:: 2018-04-01

将证书上传到 IoT 中心。
添加新证书或替换现有证书。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}?api-version=2018-04-01

URI 参数

名称	在	必需	类型	说明
certificateName	path	True	string	证书的名称 Regex pattern: `^[A-Za-z0-9-._]{1,64}$`
resourceGroupName	path	True	string	包含 IoT 中心的资源组的名称。
resourceName	path	True	string	IoT 中心的名称。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

请求头

名称	必需	类型	说明
If-Match		string	证书的 ETag。不要指定用于创建全新的证书。更新现有证书所必需的。

请求正文

名称	类型	说明
certificate	string	X509 叶证书的 base-64 表示形式.cer文件或仅 .pem 文件内容。

响应

名称	类型	说明
200 OK	CertificateDescription	如果证书已存在且更新成功，则操作将返回 HTTP 状态代码 201 (正常) 。
201 Created	CertificateDescription	如果证书不存在创建成功，则操作返回 HTTP 状态代码 201 (正常) 。
Other Status Codes	ErrorDetails	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Certificates_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/iothub/certificates/cert?api-version=2018-04-01

{
  "certificate": "############################################"
}

Sample Response

Status code:: 201

{
  "properties": {
    "subject": "CN=testdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:23:50 GMT"
  },
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert",
  "name": "cert",
  "type": "Microsoft.Devices/IotHubs/Certificates",
  "etag": "AAAAAAExpNs="
}

Status code:: 200

{
  "properties": {
    "subject": "CN=testdevice1",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25",
    "isVerified": false,
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "updated": "Thu, 12 Oct 2017 19:23:50 GMT"
  },
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert",
  "name": "cert",
  "type": "Microsoft.Devices/IotHubs/Certificates",
  "etag": "AAAAAAExpNs="
}

定义

名称	说明
CertificateBodyDescription	JSON 序列化的 X509 证书。
CertificateDescription	X509 证书。
CertificateProperties	X509 CA 证书的说明。
ErrorDetails	错误详细信息。

CertificateBodyDescription

JSON 序列化的 X509 证书。

名称	类型	说明
certificate	string	X509 叶证书的 base-64 表示形式.cer文件或仅 .pem 文件内容。

CertificateDescription

X509 证书。

名称	类型	说明
etag	string	实体标记。
id	string	资源标识符。
name	string	证书的名称。
properties	CertificateProperties	X509 CA 证书的说明。
type	string	资源类型。

CertificateProperties

X509 CA 证书的说明。

名称	类型	说明
certificate	string	证书内容
created	string	证书的创建日期和时间。
expiry	string	证书的过期日期和时间。
isVerified	boolean	确定是否已验证证书。
subject	string	证书的使用者名称。
thumbprint	string	证书的指纹。
updated	string	证书的上次更新日期与时间。

ErrorDetails

错误详细信息。

名称	类型	说明
code	string	错误代码。
details	string	错误详细信息。
httpStatusCode	string	HTTP 状态代码。
message	string	错误消息。