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

DigitalTwinClient Класс

  • Ссылка

Класс для предоставления удобных API для операций DigitalTwin на основе автоматически созданных интерфейсов REST API IotHub.

Инициализатор для DigitalTwinClient.

После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.

Наследование
builtins.object
DigitalTwinClient

Конструктор

DigitalTwinClient(connection_string=None, host=None, auth=None)

Параметры

Имя Описание
connection_string
str

Строка подключения Центра Интернета вещей, используемая для проверки подлинности подключения к Центру Интернета вещей, если мы используем connection_str проверку подлинности. Значение по умолчанию: нет

значение по умолчанию: None
host
str

URL-адрес службы Azure, если мы используем проверку подлинности с помощью учетных данных маркера. Значение по умолчанию: нет

значение по умолчанию: None
auth
str

Объект проверки подлинности Azure, если мы используем проверку подлинности с помощью учетных данных маркера. Значение по умолчанию: нет

значение по умолчанию: None

Методы

from_connection_string

Инициализатор класса для клиента службы DigitalTwinClient. Создает класс DigitalTwinClient из строки подключения.

После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.
from_token_credential

Инициализатор класса для клиента службы DigitalTwinClient. Создает класс DigitalTwinClient на основе URL-адреса имени узла и учетных данных маркера Azure.

После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.
get_digital_twin

Получение цифрового двойника заданного устройства. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства.
invoke_command

Вызовите команду на определенном устройстве и получите результат. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства. :p aram str command_name: имя команды. полезные данные :p aram str: аргумент команды. :p aram int connect_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. :p aram int response_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. Значение должно быть в пределах 5–300.
invoke_component_command

Вызовите команду для компонента конкретного устройства и получите результат. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства. :p aram str component_path: имя компонента. :p aram str command_name: имя команды. полезные данные :p aram str: аргумент команды. :p aram int connect_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. :p aram int response_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. Значение должно быть в пределах 5–300. :type response_timeout_in_seconds: int
update_digital_twin

Обновите компонент цифрового двойника данного устройства с помощью объекта patch. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства. :p aram list[object]: объект json-patch для обновления Цифрового двойника. :p aram str etag: значение etag (if_match), используемое для операции обновления.

from_connection_string

Инициализатор класса для клиента службы DigitalTwinClient. Создает класс DigitalTwinClient из строки подключения.

После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.

from_connection_string(connection_string)

Параметры

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

Строка подключения IoTHub, используемая для проверки подлинности подключения к Центру Интернета вещей.

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

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

from_token_credential

Инициализатор класса для клиента службы DigitalTwinClient. Создает класс DigitalTwinClient на основе URL-адреса имени узла и учетных данных маркера Azure.

После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.

from_token_credential(url, token_credential)

Параметры

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

URL-адрес службы Azure (имя узла).
token_credential
Обязательно
<xref:azure.core.TokenCredential>

Объект учетных данных маркера Azure

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

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

get_digital_twin

Получение цифрового двойника заданного устройства. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства.

get_digital_twin(digital_twin_id)

Параметры

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

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

Тип Описание

Возвращаемый объект, содержащий Цифровой двойник.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_command

Вызовите команду на определенном устройстве и получите результат. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства. :p aram str command_name: имя команды. полезные данные :p aram str: аргумент команды. :p aram int connect_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. :p aram int response_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. Значение должно быть в пределах 5–300.

invoke_command(digital_twin_id, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)

Параметры

Имя Описание
digital_twin_id
Обязательно
command_name
Обязательно
payload
Обязательно
connect_timeout_in_seconds
значение по умолчанию: None
response_timeout_in_seconds
значение по умолчанию: None

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

Тип Описание

Результат вызванной команды.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_component_command

Вызовите команду для компонента конкретного устройства и получите результат. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства. :p aram str component_path: имя компонента. :p aram str command_name: имя команды. полезные данные :p aram str: аргумент команды. :p aram int connect_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. :p aram int response_timeout_in_seconds: максимальный интервал времени в секундах, в течение которой команда цифрового двойника будет ожидать ответа. Значение должно быть в пределах 5–300. :type response_timeout_in_seconds: int

invoke_component_command(digital_twin_id, component_path, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)

Параметры

Имя Описание
digital_twin_id
Обязательно
component_path
Обязательно
command_name
Обязательно
payload
Обязательно
connect_timeout_in_seconds
значение по умолчанию: None
response_timeout_in_seconds
значение по умолчанию: None

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

Тип Описание

Результат вызванной команды.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_digital_twin

Обновите компонент цифрового двойника данного устройства с помощью объекта patch. :p aram str digital_twin__id: идентификатор цифрового двойника данного устройства. :p aram list[object]: объект json-patch для обновления Цифрового двойника. :p aram str etag: значение etag (if_match), используемое для операции обновления.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Параметры

Имя Описание
digital_twin_id
Обязательно
digital_twin_patch
Обязательно
etag
значение по умолчанию: None

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

Тип Описание

Возвращаемый объект, содержащий обновленный Цифровой двойник.

Исключения

Тип Описание
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>