Compartilhar via


CertificatesOperations Classe

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

IotHubClient's

Atributo <xref:certificates>.

Herança
builtins.object
CertificatesOperations

Construtor

CertificatesOperations(*args, **kwargs)

Métodos

create_or_update

Carregue o certificado no Hub IoT.

Adiciona novo ou substitui o certificado existente.

delete

Exclua um certificado X509.

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

generate_verification_code

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

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

get

Obtenha o certificado.

Retorna o certificado.

list_by_iot_hub

Obtenha a lista de certificados.

Retorna a lista de certificados.

verify

Verifique a posse da chave privada do certificado.

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

create_or_update

Carregue o certificado no Hub IoT.

Adiciona novo ou substitui o certificado existente.

async 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
Obrigatório

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

resource_name
str
Obrigatório

O nome do Hub IoT. Obrigatórios.

certificate_name
str
Obrigatório

O nome do certificado. Obrigatórios.

certificate_description
CertificateDescription ou IO
Obrigatório

O corpo do certificado. É um tipo CertificateDescription ou um tipo de E/S. Obrigatórios.

if_match
str
Obrigatório

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

content_type
str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls
callable

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

Retornos

CertificateDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

delete

Exclua um certificado X509.

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

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

Parâmetros

resource_group_name
str
Obrigatório

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

resource_name
str
Obrigatório

O nome do Hub IoT. Obrigatórios.

certificate_name
str
Obrigatório

O nome do certificado. Obrigatórios.

if_match
str
Obrigatório

ETag do Certificado. Obrigatórios.

cls
callable

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

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

Exceções

generate_verification_code

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

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

async 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
Obrigatório

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

resource_name
str
Obrigatório

O nome do Hub IoT. Obrigatórios.

certificate_name
str
Obrigatório

O nome do certificado. Obrigatórios.

if_match
str
Obrigatório

ETag do Certificado. Obrigatórios.

cls
callable

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

Retornos

CertificateWithNonceDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

get

Obtenha o certificado.

Retorna o certificado.

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

Parâmetros

resource_group_name
str
Obrigatório

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

resource_name
str
Obrigatório

O nome do Hub IoT. Obrigatórios.

certificate_name
str
Obrigatório

O nome do certificado. Obrigatórios.

cls
callable

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

Retornos

CertificateDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

list_by_iot_hub

Obtenha a lista de certificados.

Retorna a lista de certificados.

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

Parâmetros

resource_group_name
str
Obrigatório

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

resource_name
str
Obrigatório

O nome do Hub IoT. Obrigatórios.

cls
callable

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

Retornos

CertificateListDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

verify

Verifique a posse da chave privada do certificado.

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

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

Parâmetros

resource_group_name
str
Obrigatório

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

resource_name
str
Obrigatório

O nome do Hub IoT. Obrigatórios.

certificate_name
str
Obrigatório

O nome do certificado. Obrigatórios.

if_match
str
Obrigatório

ETag do Certificado. Obrigatórios.

certificate_verification_body
CertificateVerificationDescription ou IO
Obrigatório

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

content_type
str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls
callable

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

Retornos

CertificateDescription ou o resultado de cls(response)

Tipo de retorno

Exceções

Atributos

models

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