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

ConfigurationOperations Класс

  • Ссылка

Операции ConfigurationOperations.

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

Конструктор

ConfigurationOperations(client, config, serializer, deserializer)

Параметры

client
Обязательно

Клиент для запросов на обслуживание.

config
Обязательно

Настройка клиента службы.

serializer
Обязательно

Сериализатор объектной модели.

deserializer
Обязательно

Десериализатор объектной модели.

Переменные

api_version

Версия API. Постоянное значение: "2021-04-12".

Методы

apply_on_edge_device

Применяет содержимое конфигурации к пограничному устройству.
create_or_update

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

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

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

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

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

apply_on_edge_device

Применяет содержимое конфигурации к пограничному устройству.

apply_on_edge_device(id, content, custom_headers=None, raw=False, **operation_config)

Параметры

id
str
Обязательно

Уникальный идентификатор пограничного устройства.

content
ConfigurationContent
Обязательно

Содержимое конфигурации.

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

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config
Обязательно

Переопределения конфигурации операций.

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

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,
ClientRawResponse

Исключения

HttpOperationError

create_or_update

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

create_or_update(id, configuration, if_match=None, custom_headers=None, raw=False, **operation_config)

Параметры

id
str
Обязательно

Уникальный идентификатор конфигурации.

configuration
Configuration
Обязательно

Конфигурация для создания или обновления.

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

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

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

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config
Обязательно

Переопределения конфигурации операций.

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

Configuration или ClientRawResponse, если raw=true

Возвращаемый тип

Configuration,
ClientRawResponse

Исключения

HttpOperationError

delete

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

delete(id, if_match=None, custom_headers=None, raw=False, **operation_config)

Параметры

id
str
Обязательно

Уникальный идентификатор конфигурации.

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

Строка, представляющая слабый ETag для конфигурации согласно RFC7232. Операция удаления выполняется только в том случае, если этот ETag соответствует значению, поддерживаемого сервером, указывая, что конфигурация не была изменена с момента последнего получения. Чтобы принудительно выполнить безусловное удаление, задайте для If-Match подстановочный знак (*).

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

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config
Обязательно

Переопределения конфигурации операций.

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

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,
ClientRawResponse

Исключения

HttpOperationError

get

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

get(id, custom_headers=None, raw=False, **operation_config)

Параметры

id
str
Обязательно

Уникальный идентификатор конфигурации.

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

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config
Обязательно

Переопределения конфигурации операций.

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

Configuration или ClientRawResponse, если raw=true

Возвращаемый тип

Configuration,
ClientRawResponse

Исключения

HttpOperationError

get_configurations

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

get_configurations(top=None, custom_headers=None, raw=False, **operation_config)

Параметры

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

Количество извлекаемых конфигураций. Значение будет переопределено, если превышает максимальное число развертываний для Центр Интернета вещей.

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

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config
Обязательно

Переопределения конфигурации операций.

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

list или ClientRawResponse, если raw=true

Возвращаемый тип

list[Configuration],
ClientRawResponse

Исключения

HttpOperationError

test_queries

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

test_queries(input, custom_headers=None, raw=False, **operation_config)

Параметры

input
ConfigurationQueriesTestInput
Обязательно

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

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

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом.

operation_config
Обязательно

Переопределения конфигурации операций.

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

ConfigurationQueriesTestResponse или ClientRawResponse, если raw=true

Возвращаемый тип

ConfigurationQueriesTestResponse,
ClientRawResponse

Исключения

HttpOperationError

Атрибуты

models 

models = <module 'azure.iot.hub.protocol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>