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 ハブにアップロードします。

新しい証明書を追加するか、既存の証明書を置き換えます。

create_or_update(resource_group_name: str, resource_name: str, certificate_name: str, certificate_description: _models.CertificateDescription, 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

CertificateDescription または IO

必須

証明書の本文。 CertificateDescription 型または IO 型のいずれかです。 必須。

if_match

str

必須

証明書の ETag。 まったく新しい証明書を作成するために を指定しないでください。 既存の証明書を更新するために必要です。 既定値は [なし] です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

CertificateDescription または cls(response) の結果

の戻り値の型 :

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(response) の結果

の戻り値の型 :

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(response) の結果

の戻り値の型 :

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(response) の結果

の戻り値の型 :

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(response) の結果

の戻り値の型 :

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

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

CertificateDescription または cls(response) の結果

の戻り値の型 :

CertificateDescription

例外

HttpResponseError

属性

models

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