CertificatesOperations 類別

警告

請勿直接具現化此類別。

相反地，您應該透過 存取下列作業

IotHubClient's

<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 中樞。

新增或取代現有的憑證。

async 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。 請勿指定建立全新的憑證。 更新現有憑證的必要專案。 預設值為 [無]。

content_type

str

Body 參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls

callable

將傳遞直接回應的自訂類型或函式

傳回

CertificateDescription 或 cls 的結果 (回應)

傳回類型

CertificateDescription

例外狀況

HttpResponseError

delete

刪除 X509 憑證。

刪除現有的 X509 憑證，如果不存在則不執行任何動作。

async 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

產生擁有權證明流程的驗證碼。

產生擁有權證明流程的驗證碼。 驗證碼將用來產生分葉憑證。

async 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

取得憑證。

傳回憑證。

async 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

取得憑證清單。

傳回憑證清單。

async 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

確認憑證的私密金鑰擁有權。

提供驗證預先上傳憑證所簽發的分葉憑證，以驗證憑證的私密金鑰擁有權。

async 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

Body 參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls

callable

將傳遞直接回應的自訂類型或函式

傳回

CertificateDescription 或 cls 的結果 (回應)

傳回類型

CertificateDescription

例外狀況

HttpResponseError

屬性

models

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