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

CertificatesOperations 类

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

IotHubClient的

<xref:certificates> 属性。

继承

builtins.object

CertificatesOperations

构造函数

CertificatesOperations(*args, **kwargs)

方法

create_or_update	将证书上传到 IoT 中心。 添加新证书或替换现有证书。
delete	删除 X509 证书。 删除现有的 X509 证书;如果不存在，则不执行任何操作。
generate_verification_code	为所有权证明流生成验证码。 为所有权证明流生成验证码。 验证码将用于生成叶证书。
get	获取证书。 返回证书。
list_by_iot_hub	获取证书列表。 返回证书列表。
verify	验证证书的私钥所有权。 通过提供验证预上传证书颁发的叶证书来验证证书的私钥所有权。

create_or_update

将证书上传到 IoT 中心。

添加新证书或替换现有证书。

create_or_update(resource_group_name: str, resource_name: str, certificate_name: str, certificate_description: _models.CertificateBodyDescription, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CertificateDescription

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

certificate_name

str

必需

证书的名称。 必需。

certificate_description

CertificateBodyDescription 或 IO

必需

证书正文。 是 CertificateBodyDescription 类型或 IO 类型。 必需。

if_match

str

必需

证书的 ETag。 不要指定用于创建全新的证书。 更新现有证书所必需的。 默认值为 None。

content_type

str

正文参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

将传递直接响应的自定义类型或函数

返回

CertificateDescription 或 cls 的结果 (响应)

返回类型

CertificateDescription

例外

HttpResponseError

delete

删除 X509 证书。

删除现有的 X509 证书;如果不存在，则不执行任何操作。

delete(resource_group_name: str, resource_name: str, certificate_name: str, if_match: str, **kwargs: Any) -> None

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

certificate_name

str

必需

证书的名称。 必需。

if_match

str

必需

证书的 ETag。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

generate_verification_code

为所有权证明流生成验证码。

为所有权证明流生成验证码。 验证码将用于生成叶证书。

generate_verification_code(resource_group_name: str, resource_name: str, certificate_name: str, if_match: str, **kwargs: Any) -> CertificateWithNonceDescription

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

certificate_name

str

必需

证书的名称。 必需。

if_match

str

必需

证书的 ETag。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

CertificateWithNonceDescription 或 cls 的结果 (响应)

返回类型

CertificateWithNonceDescription

例外

HttpResponseError

get

获取证书。

返回证书。

get(resource_group_name: str, resource_name: str, certificate_name: str, **kwargs: Any) -> CertificateDescription

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

certificate_name

str

必需

证书的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

CertificateDescription 或 cls 的结果 (响应)

返回类型

CertificateDescription

例外

HttpResponseError

list_by_iot_hub

获取证书列表。

返回证书列表。

list_by_iot_hub(resource_group_name: str, resource_name: str, **kwargs: Any) -> CertificateListDescription

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

CertificateListDescription 或 cls 的结果 (响应)

返回类型

CertificateListDescription

例外

HttpResponseError

verify

验证证书的私钥所有权。

通过提供验证预上传证书颁发的叶证书来验证证书的私钥所有权。

verify(resource_group_name: str, resource_name: str, certificate_name: str, if_match: str, certificate_verification_body: _models.CertificateVerificationDescription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CertificateDescription

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

certificate_name

str

必需

证书的名称。 必需。

if_match

str

必需

证书的 ETag。 必需。

certificate_verification_body

CertificateVerificationDescription 或 IO

必需

证书的名称。 是 CertificateVerificationDescription 类型还是 IO 类型。 必需。

content_type

str

正文参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

将传递直接响应的自定义类型或函数

返回

CertificateDescription 或 cls 的结果 (响应)

返回类型

CertificateDescription

例外

HttpResponseError

属性

models

models = <module 'azure.mgmt.iothub.v2020_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2020_03_01\\models\\__init__.py'>