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

IoTHubConfigurationManager Класс

  • Ссылка

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

Инициализатор для клиента службы Configuration Manager.

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

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

Конструктор

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

Параметры

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

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

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

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

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

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

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

Методы

apply_configuration_on_edge_device

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

Создает конфигурацию для устройств или модулей Центра Интернета вещей.
delete_configuration

Удаляет конфигурацию из Центра Интернета вещей.
from_connection_string

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

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

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

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

Извлекает конфигурацию Центра Интернета вещей для определенного устройства.
get_configurations

Извлекает несколько конфигураций для устройств и модулей Центра Интернета вещей. Возвращает указанное число конфигураций. Разбиение на страницы не поддерживается.
test_configuration_queries

Проверяет запрос целевого условия и пользовательские запросы метрик для конфигурации.
update_configuration

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

apply_configuration_on_edge_device

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

apply_configuration_on_edge_device(device_id, configuration_content)

Параметры

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

Имя (id) пограничного устройства.
device_id
Обязательно

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

Тип Описание

Объект.

Исключения

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

create_configuration

Создает конфигурацию для устройств или модулей Центра Интернета вещей.

create_configuration(configuration)

Параметры

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

Идентификатор конфигурации.
configuration
Обязательно
Configuration

Создаваемая конфигурация.

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

Тип Описание

Объект Configuration, содержащий созданную конфигурацию.

Исключения

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

delete_configuration

Удаляет конфигурацию из Центра Интернета вещей.

delete_configuration(configuration_id, etag=None)

Параметры

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

Идентификатор конфигурации.
configuration
Обязательно
Configuration

Создаваемая конфигурация.
etag
str

Значение etag (if_match), используемое для операции удаления.

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

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

Тип Описание

Объект configuration, содержащий обновленную конфигурацию.

Исключения

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

from_connection_string

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

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

from_connection_string(connection_string)

Параметры

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

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

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

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

Исключения

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

from_token_credential

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

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

from_token_credential(url, token_credential)

Параметры

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

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

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

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

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

Исключения

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

get_configuration

Извлекает конфигурацию Центра Интернета вещей для определенного устройства.

get_configuration(configuration_id)

Параметры

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

Идентификатор конфигурации.

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

Тип Описание

Объект Configuration.

Исключения

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

get_configurations

Извлекает несколько конфигураций для устройств и модулей Центра Интернета вещей. Возвращает указанное число конфигураций. Разбиение на страницы не поддерживается.

get_configurations(max_count=None)

Параметры

Имя Описание
max_count
int

Максимальное количество запрошенных конфигураций.

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

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

Тип Описание

Объект list[Configuration].

Исключения

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

test_configuration_queries

Проверяет запрос целевого условия и пользовательские запросы метрик для конфигурации.

test_configuration_queries(configuration_queries_test_input)

Параметры

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

Тестовые входные данные запросов.

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

Тип Описание

Объект ConfigurationQueriesTestResponse.

Исключения

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

update_configuration

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

update_configuration(configuration, etag)

Параметры

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

Идентификатор конфигурации.
configuration
Обязательно
Configuration

Конфигурация содержит обновленную конфигурацию.
etag
Обязательно
str

Значение etag (if_match), используемое для операции обновления.

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

Тип Описание

Объект configuration, содержащий обновленную конфигурацию.

Исключения

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