ProvisioningDeviceClient Classe

Cliente que pode ser utilizado para executar o registo de um dispositivo com o serviço de aprovisionamento com a Chave Simétrica ou a autenticação X509.

Inicializa o cliente de aprovisionamento.

NOTA: este inicializador não deve ser chamado diretamente. Em vez disso, os métodos de classe que começam com create_from_ devem ser utilizados para criar um objeto de cliente.

Herança

azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

Construtor

ProvisioningDeviceClient(pipeline)

Parâmetros

Name	Description
pipeline Necessário	<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline> Instância do objeto de pipeline de aprovisionamento.

Métodos

create_from_symmetric_key	Crie um cliente que pode ser utilizado para executar o registo de um dispositivo com o serviço de aprovisionamento através da autenticação de Chave Simétrica.
create_from_x509_certificate	Crie um cliente que pode ser utilizado para executar o registo de um dispositivo com o serviço de aprovisionamento através da autenticação de certificado X509.
register	Registe o dispositivo no serviço de aprovisionamento. Antes de devolver o cliente, também irá desligar-se do serviço de aprovisionamento. Se for efetuada uma tentativa de registo enquanto um registo anterior estiver em curso, poderá gerar um erro. Assim que o dispositivo for registado com êxito, o cliente deixará de ser operável.

create_from_symmetric_key

Crie um cliente que pode ser utilizado para executar o registo de um dispositivo com o serviço de aprovisionamento através da autenticação de Chave Simétrica.

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

Parâmetros

Name	Description
provisioning_host Necessário	str Anfitrião a executar o Serviço de Aprovisionamento de Dispositivos. Pode encontrar-se no portal do Azure no separador Descrição Geral como o ponto final global do dispositivo da cadeia.
registration_id Necessário	str O ID de registo utilizado para identificar exclusivamente um dispositivo no Serviço de Aprovisionamento de Dispositivos. O ID de registo é alfanumérico, cadeia minúscula e pode conter hífenes.
id_scope Necessário	str O âmbito do ID utilizado para identificar exclusivamente o serviço de aprovisionamento específico através do qual o dispositivo será registado. O âmbito do ID é atribuído a um Serviço de Aprovisionamento de Dispositivos quando é criado pelo utilizador e é gerado pelo serviço e é imutável, garantindo a exclusividade.
symmetric_key Necessário	str A chave que será utilizada para criar o token de assinatura de acesso partilhado para autenticar o dispositivo com o Serviço de Aprovisionamento de Dispositivos. Por predefinição, o Serviço de Aprovisionamento de Dispositivos cria novas chaves simétricas com um comprimento predefinido de 32 bytes quando as novas inscrições são guardadas com a opção Gerar automaticamente chaves ativada. Os utilizadores podem fornecer as suas próprias chaves simétricas para inscrições ao desativar esta opção dentro de 16 bytes e 64 bytes e no formato Base64 válido.
server_verification_cert Necessário	str Opção de Configuração. A cadeia de certificados fidedigna. Necessário ao utilizar a ligação a um ponto final que tenha uma raiz de confiança não padrão, como um gateway de protocolo.
gateway_hostname Necessário	str Opção de Configuração. O nome do anfitrião do gateway para o dispositivo de gateway.
websockets Necessário	bool Opção de Configuração. A predefinição é Falso. Defina como verdadeiro se utilizar MQTT através de websockets.
cipher Necessário	str ou list(str) Opção de Configuração. Conjuntos de cifras para TLS/SSL, como uma cadeia em "Formato de lista de cifras OpenSSL" ou como uma lista de cadeias de conjuntos de cifras.
proxy_options Necessário	ProxyOptions Opções para enviar tráfego através de servidores proxy.
keepalive Necessário	int Período máximo em segundos entre comunicações com o mediador. Se não estiverem a ser trocadas outras mensagens, esta ação controla a taxa a que o cliente enviará mensagens de ping para o mediador. Se não for fornecido o valor predefinido de 60 segundos, será utilizado.

Devoluções

Tipo	Description
	Uma instância ProvisioningDeviceClient que pode registar-se através da Chave Simétrica.

Exceções

Tipo	Description
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Crie um cliente que pode ser utilizado para executar o registo de um dispositivo com o serviço de aprovisionamento através da autenticação de certificado X509.

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

Parâmetros

Name	Description
provisioning_host Necessário	str Anfitrião a executar o Serviço de Aprovisionamento de Dispositivos. Pode encontrar-se no portal do Azure no separador Descrição Geral como o ponto final global do dispositivo da cadeia.
registration_id Necessário	str O ID de registo utilizado para identificar exclusivamente um dispositivo no Serviço de Aprovisionamento de Dispositivos. O ID de registo é alfanumérico, cadeia minúscula e pode conter hífenes.
id_scope Necessário	str O âmbito do ID é utilizado para identificar exclusivamente o serviço de aprovisionamento específico através do qual o dispositivo será registado. O âmbito do ID é atribuído a um Serviço de Aprovisionamento de Dispositivos quando é criado pelo utilizador e é gerado pelo serviço e é imutável, garantindo a exclusividade.
x509 Necessário	X509 O certificado x509, para utilizar o certificado, o objeto de inscrição tem de conter o certificado (o certificado de raiz ou um dos certificados de AC intermédios). Se o certificado for proveniente de um ficheiro CER, tem de ser codificado com base64.
server_verification_cert Necessário	str Opção de Configuração. A cadeia de certificados fidedigna. Necessário ao utilizar a ligação a um ponto final que tenha uma raiz de confiança não padrão, como um gateway de protocolo.
gateway_hostname Necessário	str Opção de Configuração. O nome do anfitrião do gateway para o dispositivo de gateway.
websockets Necessário	bool Opção de Configuração. A predefinição é Falso. Defina como verdadeiro se utilizar MQTT através de websockets.
cipher Necessário	str ou list(str) Opção de Configuração. Conjuntos de cifras para TLS/SSL, como uma cadeia em "Formato de lista de cifras OpenSSL" ou como uma lista de cadeias de conjuntos de cifras.
proxy_options Necessário	ProxyOptions Opções para enviar tráfego através de servidores proxy.
keepalive Necessário	int Período máximo em segundos entre comunicações com o mediador. Se não estiverem a ser trocadas outras mensagens, esta ação controla a taxa a que o cliente enviará mensagens de ping para o mediador. Se não for fornecido o valor predefinido de 60 segundos, será utilizado.

Devoluções

Tipo	Description
	Um ProvisioningDeviceClient que pode registar-se através de certificados de cliente X509.

Exceções

Tipo	Description
TypeError if given an unrecognized parameter.

register

Registe o dispositivo no serviço de aprovisionamento.

Antes de devolver o cliente, também irá desligar-se do serviço de aprovisionamento. Se for efetuada uma tentativa de registo enquanto um registo anterior estiver em curso, poderá gerar um erro.

Assim que o dispositivo for registado com êxito, o cliente deixará de ser operável.

async register()

Devoluções

Tipo	Description
RegistrationResult	RegistrationResult a indicar o resultado do registo.

Exceções

Tipo	Description
CredentialError	se as credenciais forem inválidas e não for possível estabelecer uma ligação.
ConnectionFailedError	se o estabelecimento de uma ligação resultar em falha.
ConnectionDroppedError	se a ligação for perdida durante a execução.
ClientError	se ocorrer uma falha inesperada durante a execução.

Atributos

provisioning_payload