Поделиться через

ProvisioningDeviceClient Класс

  • Ссылка

Клиент, который можно использовать для регистрации устройства со службой подготовки с использованием симметричного ключа или проверки подлинности X509.

Инициализирует клиент подготовки.

ПРИМЕЧАНИЕ. Этот инициализатор не должен вызываться напрямую. Вместо этого для создания объекта клиента следует использовать методы класса, которые начинаются с create_from_ .

Наследование
azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient
ProvisioningDeviceClient

Конструктор

ProvisioningDeviceClient(pipeline)

Параметры

Имя Описание
pipeline
Обязательно
<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline>

Экземпляр объекта конвейера подготовки.

Методы

create_from_symmetric_key

Создайте клиент, который можно использовать для регистрации устройства со службой подготовки с использованием проверки подлинности с симметричным ключом.
create_from_x509_certificate

Создайте клиент, который можно использовать для регистрации устройства со службой подготовки с использованием проверки подлинности сертификата X509.
register

Регистрация устройства в службе подготовки

Это синхронный вызов, т. е. эта функция не будет возвращать, пока процесс регистрации не завершится успешно или попытка не приведет к сбою. Перед возвратом клиент также отключится от службы подготовки. Если попытка регистрации выполняется во время предыдущей регистрации, это может привести к ошибке.

После успешной регистрации устройства клиент больше не будет функционировать.

create_from_symmetric_key

Создайте клиент, который можно использовать для регистрации устройства со службой подготовки с использованием проверки подлинности с симметричным ключом.

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

Параметры

Имя Описание
provisioning_host
Обязательно
str

Узел, на котором запущена служба подготовки устройств. Можно найти в портал Azure на вкладке Обзор в виде строки Глобальная конечная точка устройства.
registration_id
Обязательно
str

Идентификатор регистрации, используемый для уникальной идентификации устройства в службе подготовки устройств. Идентификатор регистрации — буквенно-цифровой, строчная строка и может содержать дефисы.
id_scope
Обязательно
str

Идентификатор область, используемый для уникальной идентификации конкретной службы подготовки, которую устройство будет регистрировать. Идентификатор область назначается службе подготовки устройств при ее создании пользователем и создается службой и является неизменяемым, гарантируя уникальность.
symmetric_key
Обязательно
str

Ключ, который будет использоваться для создания маркера подписанного URL-адреса для проверки подлинности устройства с помощью службы подготовки устройств. По умолчанию Служба подготовки устройств создает симметричные ключи длиной 32 байта после сохранения новых регистраций с использованием параметра Автоматически создавать ключи. Пользователи могут предоставлять собственные симметричные ключи для регистраций, отключив этот параметр в пределах 16 и 64 байт и в допустимом формате Base64.
server_verification_cert
Обязательно
str

Параметр конфигурации. Цепочка доверенных сертификатов. Требуется при подключении к конечной точке, которая имеет нестандартный корень доверия, например шлюз протоколов.
gateway_hostname
Обязательно
str

Параметр конфигурации. Имя узла шлюза для устройства шлюза.
websockets
Обязательно
bool

Параметр конфигурации. Значение по умолчанию — False. Задайте значение true, если используется MQTT через websocket.
cipher
Обязательно
str или list(str)

Параметр конфигурации. Наборы шифров для TLS/SSL в виде строки в формате "Список шифров OpenSSL" или в виде списка строк набора шифров.
proxy_options
Обязательно
ProxyOptions

Параметры отправки трафика через прокси-серверы.
keepalive
Обязательно
int

Максимальный период в секундах между обменом данными с брокером. Если другие сообщения не обмениваются, это управляет скоростью, с которой клиент будет отправлять сообщения связи брокеру. Если значение не указано, будет использоваться значение по умолчанию 60 секунд.

Возвращаемое значение

Тип Описание

Экземпляр ProvisioningDeviceClient, который можно зарегистрировать с помощью симметричного ключа.

Исключения

Тип Описание
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Создайте клиент, который можно использовать для регистрации устройства со службой подготовки с использованием проверки подлинности сертификата X509.

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

Параметры

Имя Описание
provisioning_host
Обязательно
str

Узел, на котором запущена служба подготовки устройств. Можно найти в портал Azure на вкладке Обзор в виде строки Глобальная конечная точка устройства.
registration_id
Обязательно
str

Идентификатор регистрации, используемый для уникальной идентификации устройства в службе подготовки устройств. Идентификатор регистрации — буквенно-цифровой, строчная строка и может содержать дефисы.
id_scope
Обязательно
str

Идентификатор область используется для уникальной идентификации конкретной службы подготовки, которую устройство будет регистрировать. Идентификатор область назначается службе подготовки устройств при ее создании пользователем и создается службой и является неизменяемым, гарантируя уникальность.
x509
Обязательно
X509

Сертификат x509. Чтобы использовать сертификат, объект регистрации должен содержать сертификат (корневой сертификат или один из промежуточных сертификатов ЦС). Если сертификат поступает из CER-файла, он должен быть закодирован в кодировке Base64.
server_verification_cert
Обязательно
str

Параметр конфигурации. Цепочка доверенных сертификатов. Требуется при подключении к конечной точке, которая имеет нестандартный корень доверия, например шлюз протоколов.
gateway_hostname
Обязательно
str

Параметр конфигурации. Имя узла шлюза для устройства шлюза.
websockets
Обязательно
bool

Параметр конфигурации. Значение по умолчанию — False. Задайте значение true, если используется MQTT через websocket.
cipher
Обязательно
str или list(str)

Параметр конфигурации. Наборы шифров для TLS/SSL в виде строки в формате "Список шифров OpenSSL" или в виде списка строк набора шифров.
proxy_options
Обязательно
ProxyOptions

Параметры отправки трафика через прокси-серверы.
keepalive
Обязательно
int

Максимальный период в секундах между обменом данными с брокером. Если другие сообщения не обмениваются, это управляет скоростью, с которой клиент будет отправлять сообщения связи брокеру. Если значение не указано, будет использоваться значение по умолчанию 60 секунд.

Возвращаемое значение

Тип Описание

ProvisioningDeviceClient, который можно зарегистрировать с помощью сертификатов клиента X509.

Исключения

Тип Описание
TypeError if given an unrecognized parameter.

register

Регистрация устройства в службе подготовки

Это синхронный вызов, т. е. эта функция не будет возвращать, пока процесс регистрации не завершится успешно или попытка не приведет к сбою. Перед возвратом клиент также отключится от службы подготовки. Если попытка регистрации выполняется во время предыдущей регистрации, это может привести к ошибке.

После успешной регистрации устройства клиент больше не будет функционировать.

register()

Возвращаемое значение

Тип Описание
RegistrationResult

RegistrationResult , указывающий результат регистрации.

Исключения

Тип Описание
CredentialError

Значение , если учетные данные недопустимы и невозможно установить подключение.
ConnectionFailedError

значение , если установка подключения приводит к сбою.
ConnectionDroppedError

Значение , если соединение потеряно во время выполнения.
OperationTimeout

Значение , если время ожидания подключения истекает.
ClientError

значение , если во время выполнения произошел непредвиденный сбой.

Атрибуты

provisioning_payload