Compartilhar via

ProvisioningDeviceClient Classe

  • Referência

Cliente que pode ser usado para executar o registro de um dispositivo com o serviço de provisionamento usando a Chave Simétrica ou a autenticação X509.

Inicializa o cliente de provisionamento.

OBSERVAÇÃO: esse inicializador não deve ser chamado diretamente. Em vez disso, os métodos de classe que começam com create_from_ devem ser usados para criar um objeto cliente.

Herança
azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient
ProvisioningDeviceClient

Construtor

ProvisioningDeviceClient(pipeline)

Parâmetros

Nome Description
pipeline
Obrigatório
<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline>

Instância do objeto de pipeline de provisionamento.

Métodos

create_from_symmetric_key

Crie um cliente que possa ser usado para executar o registro de um dispositivo com o serviço de provisionamento usando a autenticação de Chave Simétrica.
create_from_x509_certificate

Crie um cliente que possa ser usado para executar o registro de um dispositivo com o serviço de provisionamento usando a autenticação de certificado X509.
register

Registrar o dispositivo com o serviço de provisionamento

Essa é uma chamada síncrona, o que significa que essa função não retornará até que o processo de registro seja concluído com êxito ou que a tentativa resulte em uma falha. Antes de retornar, o cliente também se desconectará do serviço de provisionamento. Se uma tentativa de registro for feita enquanto um registro anterior estiver em andamento, poderá gerar um erro.

Depois que o dispositivo for registrado com êxito, o cliente não será mais operável.

create_from_symmetric_key

Crie um cliente que possa ser usado para executar o registro de um dispositivo com o serviço de provisionamento usando a autenticação de Chave Simétrica.

create_from_symmetric_key(provisioning_host, registration_id, id_scope, symmetric_key, **kwargs)

Parâmetros

Nome Description
provisioning_host
Obrigatório
str

Host executando o Serviço de Provisionamento de Dispositivos. Pode ser encontrado no portal do Azure na guia Visão geral como a cadeia de caracteres Ponto de extremidade do dispositivo global.
registration_id
Obrigatório
str

A ID de registro usada para identificar exclusivamente um dispositivo no Serviço de Provisionamento de Dispositivos. A ID de registro é alfanumérica, cadeia de caracteres minúscula e pode conter hifens.
id_scope
Obrigatório
str

O escopo da ID usado para identificar exclusivamente o serviço de provisionamento específico pelo qual o dispositivo será registrado. O escopo da ID é atribuído a um Serviço de Provisionamento de Dispositivos quando ele é criado pelo usuário e é gerado pelo serviço e é imutável, garantindo exclusividade.
symmetric_key
Obrigatório
str

A chave que será usada para criar o token de assinatura de acesso compartilhado para autenticar o dispositivo com o Serviço de Provisionamento de Dispositivos. Por padrão, o serviço de provisionamento de dispositivos cria chaves simétricas com um tamanho padrão de 32 bytes quando novos registros são salvos com a opção Gerar chaves automaticamente habilitada. Os usuários podem fornecer suas próprias chaves simétricas para registros desabilitando essa opção em 16 bytes e 64 bytes e no formato Base64 válido.
server_verification_cert
Obrigatório
str

Opção de configuração. A cadeia de certificados confiáveis. Necessário ao usar a conexão com um ponto de extremidade que tem uma raiz de confiança não padrão, como um gateway de protocolo.
gateway_hostname
Obrigatório
str

Opção de configuração. O nome do host do gateway para o dispositivo de gateway.
websockets
Obrigatório
bool

Opção de configuração. O padrão é Falso. Defina como true se estiver usando MQTT em websockets.
cipher
Obrigatório
str ou list(str)

Opção de configuração. Pacotes de criptografia para TLS/SSL, como uma cadeia de caracteres em "Formato de lista de criptografia OpenSSL" ou como uma lista de cadeias de caracteres do conjunto de criptografias.
proxy_options
Obrigatório
ProxyOptions

Opções para enviar tráfego por meio de servidores proxy.
keepalive
Obrigatório
int

Período máximo em segundos entre as comunicações com o agente. Se nenhuma outra mensagem estiver sendo trocada, isso controlará a taxa na qual o cliente enviará mensagens de ping ao agente. Se não for fornecido, o valor padrão de 60 segundos será usado.

Retornos

Tipo Description

Uma instância de ProvisioningDeviceClient que pode ser registrada por meio da Chave Simétrica.

Exceções

Tipo Description
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Crie um cliente que possa ser usado para executar o registro de um dispositivo com o serviço de provisionamento usando a autenticação de certificado X509.

create_from_x509_certificate(provisioning_host, registration_id, id_scope, x509, **kwargs)

Parâmetros

Nome Description
provisioning_host
Obrigatório
str

Host executando o Serviço de Provisionamento de Dispositivos. Pode ser encontrado no portal do Azure na guia Visão geral como a cadeia de caracteres Ponto de extremidade do dispositivo global.
registration_id
Obrigatório
str

A ID de registro usada para identificar exclusivamente um dispositivo no Serviço de Provisionamento de Dispositivos. A ID de registro é alfanumérica, cadeia de caracteres minúscula e pode conter hifens.
id_scope
Obrigatório
str

O escopo da ID é usado para identificar exclusivamente o serviço de provisionamento específico pelo qual o dispositivo será registrado. O escopo da ID é atribuído a um Serviço de Provisionamento de Dispositivos quando ele é criado pelo usuário e é gerado pelo serviço e é imutável, garantindo exclusividade.
x509
Obrigatório
X509

O certificado x509, para usar o certificado, o objeto de registro precisa conter certificado (o certificado raiz ou um dos certificados de AUTORIDADE de certificação intermediários). Se o certificado vier de um arquivo CER, ele precisará ser codificado em base64.
server_verification_cert
Obrigatório
str

Opção de configuração. A cadeia de certificados confiáveis. Necessário ao usar a conexão com um ponto de extremidade que tem uma raiz de confiança não padrão, como um gateway de protocolo.
gateway_hostname
Obrigatório
str

Opção de configuração. O nome do host do gateway para o dispositivo de gateway.
websockets
Obrigatório
bool

Opção de configuração. O padrão é Falso. Defina como true se estiver usando MQTT em websockets.
cipher
Obrigatório
str ou list(str)

Opção de configuração. Pacotes de criptografia para TLS/SSL, como uma cadeia de caracteres em "Formato de lista de criptografia OpenSSL" ou como uma lista de cadeias de caracteres do conjunto de criptografias.
proxy_options
Obrigatório
ProxyOptions

Opções para enviar tráfego por meio de servidores proxy.
keepalive
Obrigatório
int

Período máximo em segundos entre as comunicações com o agente. Se nenhuma outra mensagem estiver sendo trocada, isso controlará a taxa na qual o cliente enviará mensagens de ping ao agente. Se não for fornecido, o valor padrão de 60 segundos será usado.

Retornos

Tipo Description

Um ProvisioningDeviceClient que pode ser registrado por meio de certificados de cliente X509.

Exceções

Tipo Description
TypeError if given an unrecognized parameter.

register

Registrar o dispositivo com o serviço de provisionamento

Essa é uma chamada síncrona, o que significa que essa função não retornará até que o processo de registro seja concluído com êxito ou que a tentativa resulte em uma falha. Antes de retornar, o cliente também se desconectará do serviço de provisionamento. Se uma tentativa de registro for feita enquanto um registro anterior estiver em andamento, poderá gerar um erro.

Depois que o dispositivo for registrado com êxito, o cliente não será mais operável.

register()

Retornos

Tipo Description
RegistrationResult

RegistrationResult indicando o resultado do registro.

Exceções

Tipo Description
CredentialError

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.
ConnectionFailedError

se o estabelecimento de uma conexão resultar em falha.
ConnectionDroppedError

se a conexão for perdida durante a execução.
OperationTimeout

se a conexão atingir o tempo limite.
ClientError

se houver uma falha inesperada durante a execução.

Atributos

provisioning_payload