Partager via


CertificatesOperations Classe

Avertissement

NE PAS instancier cette classe directement.

Au lieu de cela, vous devez accéder aux opérations suivantes via

IotHubClientEst

attribut<xref:certificates> ;

Héritage
builtins.object
CertificatesOperations

Constructeur

CertificatesOperations(*args, **kwargs)

Méthodes

create_or_update

Chargez le certificat sur le hub IoT.

Ajoute un nouveau certificat ou remplace un certificat existant.

delete

Supprimez un certificat X509.

Supprime un certificat X509 existant ou ne fait rien s’il n’existe pas.

generate_verification_code

Générez le code de vérification pour le flux de preuve de possession.

Génère le code de vérification pour le flux de preuve de possession. Le code de vérification sera utilisé pour générer un certificat feuille.

get

Obtenez le certificat.

Retourne le certificat.

list_by_iot_hub

Obtenez la liste des certificats.

Retourne la liste des certificats.

verify

Vérifiez la possession de la clé privée du certificat.

Vérifie la possession de la clé privée du certificat en fournissant le certificat feuille émis par le certificat de vérification pré-chargé.

create_or_update

Chargez le certificat sur le hub IoT.

Ajoute un nouveau certificat ou remplace un certificat existant.

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

Paramètres

resource_group_name
str
Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name
str
Obligatoire

Nom du hub IoT. Obligatoire.

certificate_name
str
Obligatoire

Nom du certificat. Obligatoire.

certificate_description
CertificateBodyDescription ou IO
Obligatoire

Corps du certificat. Il s’agit d’un type CertificateBodyDescription ou d’un type d’E/S. Obligatoire.

if_match
str
Obligatoire

ETag du certificat. Ne spécifiez pas pour la création d’un tout nouveau certificat. Obligatoire pour mettre à jour un certificat existant. La valeur par défaut est Aucun.

content_type
str

Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

CertificateDescription ou le résultat de cls(response)

Type de retour

Exceptions

delete

Supprimez un certificat X509.

Supprime un certificat X509 existant ou ne fait rien s’il n’existe pas.

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

Paramètres

resource_group_name
str
Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name
str
Obligatoire

Nom du hub IoT. Obligatoire.

certificate_name
str
Obligatoire

Nom du certificat. Obligatoire.

if_match
str
Obligatoire

ETag du certificat. Obligatoire.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Aucun ou le résultat de cls(response)

Type de retour

Exceptions

generate_verification_code

Générez le code de vérification pour le flux de preuve de possession.

Génère le code de vérification pour le flux de preuve de possession. Le code de vérification sera utilisé pour générer un certificat feuille.

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

Paramètres

resource_group_name
str
Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name
str
Obligatoire

Nom du hub IoT. Obligatoire.

certificate_name
str
Obligatoire

Nom du certificat. Obligatoire.

if_match
str
Obligatoire

ETag du certificat. Obligatoire.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

CertificateWithNonceDescription ou le résultat de cls(response)

Type de retour

Exceptions

get

Obtenez le certificat.

Retourne le certificat.

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

Paramètres

resource_group_name
str
Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name
str
Obligatoire

Nom du hub IoT. Obligatoire.

certificate_name
str
Obligatoire

Nom du certificat. Obligatoire.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

CertificateDescription ou le résultat de cls(response)

Type de retour

Exceptions

list_by_iot_hub

Obtenez la liste des certificats.

Retourne la liste des certificats.

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

Paramètres

resource_group_name
str
Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name
str
Obligatoire

Nom du hub IoT. Obligatoire.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

CertificateListDescription ou le résultat de cls(response)

Type de retour

Exceptions

verify

Vérifiez la possession de la clé privée du certificat.

Vérifie la possession de la clé privée du certificat en fournissant le certificat feuille émis par le certificat de vérification pré-chargé.

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

Paramètres

resource_group_name
str
Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name
str
Obligatoire

Nom du hub IoT. Obligatoire.

certificate_name
str
Obligatoire

Nom du certificat. Obligatoire.

if_match
str
Obligatoire

ETag du certificat. Obligatoire.

certificate_verification_body
CertificateVerificationDescription ou IO
Obligatoire

Nom du certificat. Type CertificateVerificationDescription ou type E/S. Obligatoire.

content_type
str

Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

CertificateDescription ou le résultat de cls(response)

Type de retour

Exceptions

Attributs

models

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