Partilhar via


CertificatesOperations Classe

Aviso

NÃO instancia esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

IotHubClient's

<xref:certificates> atributo.

Herança
builtins.object
CertificatesOperations

Construtor

CertificatesOperations(*args, **kwargs)

Métodos

create_or_update

Carregue o certificado para o hub IoT.

Adiciona um certificado novo ou substitui o certificado existente.

delete

Elimine um certificado X509.

Elimina um certificado X509 existente ou não faz nada se não existir.

generate_verification_code

Gerar código de verificação para comprovativo do fluxo de posse.

Gera código de verificação para comprovativo do fluxo de posse. O código de verificação será utilizado para gerar um certificado de folha.

get

Obtenha o certificado.

Devolve o certificado.

list_by_iot_hub

Obtenha a lista de certificados.

Devolve a lista de certificados.

verify

Verifique a posse da chave privada do certificado.

Verifica a posse da chave privada do certificado ao fornecer o certificado de folha emitido pelo certificado pré-carregado de verificação.

create_or_update

Carregue o certificado para o hub IoT.

Adiciona um certificado novo ou substitui o certificado existente.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name
str
Necessário

O nome do hub IoT. Obrigatório.

certificate_name
str
Necessário

O nome do certificado. Obrigatório.

certificate_description
CertificateDescription ou IO
Necessário

O corpo do certificado. É um tipo certificateDescription ou um tipo de E/S. Obrigatório.

if_match
str
Necessário

ETag do Certificado. Não especifique para criar um certificado novo. Necessário para atualizar um certificado existente. O valor predefinido é Nenhum.

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

CertificateDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

delete

Elimine um certificado X509.

Elimina um certificado X509 existente ou não faz nada se não existir.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name
str
Necessário

O nome do hub IoT. Obrigatório.

certificate_name
str
Necessário

O nome do certificado. Obrigatório.

if_match
str
Necessário

ETag do Certificado. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

Nenhum ou o resultado de cls(resposta)

Tipo de retorno

Exceções

generate_verification_code

Gerar código de verificação para comprovativo do fluxo de posse.

Gera código de verificação para comprovativo do fluxo de posse. O código de verificação será utilizado para gerar um certificado de folha.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name
str
Necessário

O nome do hub IoT. Obrigatório.

certificate_name
str
Necessário

O nome do certificado. Obrigatório.

if_match
str
Necessário

ETag do Certificado. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

CertificateWithNonceDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

get

Obtenha o certificado.

Devolve o certificado.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name
str
Necessário

O nome do hub IoT. Obrigatório.

certificate_name
str
Necessário

O nome do certificado. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

CertificateDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

list_by_iot_hub

Obtenha a lista de certificados.

Devolve a lista de certificados.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name
str
Necessário

O nome do hub IoT. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

CertificateListDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

verify

Verifique a posse da chave privada do certificado.

Verifica a posse da chave privada do certificado ao fornecer o certificado de folha emitido pelo certificado pré-carregado de verificação.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name
str
Necessário

O nome do hub IoT. Obrigatório.

certificate_name
str
Necessário

O nome do certificado. Obrigatório.

if_match
str
Necessário

ETag do Certificado. Obrigatório.

certificate_verification_body
CertificateVerificationDescription ou IO
Necessário

O nome do certificado. É um tipo CertificateVerificationDescription ou um tipo de E/S. Obrigatório.

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

CertificateDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

Atributos

models

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