Compartir a través de

ConfigurationOperations Clase

  • Referencia

Operaciones configurationOperations.

Herencia
builtins.object
ConfigurationOperations

Constructor

ConfigurationOperations(client, config, serializer, deserializer)

Parámetros

client
Requerido

Cliente para solicitudes de servicio.

config
Requerido

Configuración del cliente de servicio.

serializer
Requerido

Serializador de modelo de objetos.

deserializer
Requerido

Deserializador de modelo de objetos.

Variables

api_version

Versión de la API. Valor constante: "2021-04-12".

Métodos

apply_on_edge_device

Aplica el contenido de configuración a un dispositivo perimetral.
create_or_update

Crea o actualiza una configuración en el IoT Hub para la administración automática de dispositivos o módulos. No se puede actualizar el identificador de configuración y el contenido.
delete

Elimina una configuración en el IoT Hub para la administración automática de dispositivos o módulos.
get

Obtiene una configuración en el IoT Hub para la administración automática de dispositivos o módulos.
get_configurations

Obtiene las configuraciones de la IoT Hub para la administración automática de dispositivos o módulos. No se admite la paginación.
test_queries

Valida la condición de destino y las consultas de métricas personalizadas para una configuración en el IoT Hub.

apply_on_edge_device

Aplica el contenido de configuración a un dispositivo perimetral.

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

Parámetros

id
str
Requerido

Identificador único del dispositivo perimetral.

content
ConfigurationContent
Requerido

Contenido de configuración.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,
ClientRawResponse

Excepciones

HttpOperationError

create_or_update

Crea o actualiza una configuración en el IoT Hub para la administración automática de dispositivos o módulos. No se puede actualizar el identificador de configuración y el contenido.

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

Parámetros

id
str
Requerido

Identificador único de la configuración.

configuration
Configuration
Requerido

Configuración que se va a crear o actualizar.

if_match
str
valor predeterminado: None

Cadena que representa una ETag débil para la configuración, según RFC7232. Esto no debe establecerse al crear una configuración, pero se puede establecer al actualizar una configuración.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Configuración o ClientRawResponse si raw=true

Tipo de valor devuelto

Configuration,
ClientRawResponse

Excepciones

HttpOperationError

delete

Elimina una configuración en el IoT Hub para la administración automática de dispositivos o módulos.

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

Parámetros

id
str
Requerido

Identificador único de la configuración.

if_match
str
valor predeterminado: None

Cadena que representa una ETag débil para la configuración, según RFC7232. La operación de eliminación solo se realiza si esta ETag coincide con el valor mantenido por el servidor, lo que indica que la configuración no se ha modificado desde que se recuperó por última vez. Para forzar una eliminación incondicional, establezca If-Match en el carácter comodín (*).

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,
ClientRawResponse

Excepciones

HttpOperationError

get

Obtiene una configuración en el IoT Hub para la administración automática de dispositivos o módulos.

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

Parámetros

id
str
Requerido

Identificador único de la configuración.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Configuración o ClientRawResponse si raw=true

Tipo de valor devuelto

Configuration,
ClientRawResponse

Excepciones

HttpOperationError

get_configurations

Obtiene las configuraciones de la IoT Hub para la administración automática de dispositivos o módulos. No se admite la paginación.

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

Parámetros

top
int
valor predeterminado: None

Número de configuraciones que se van a recuperar. El valor se invalidará si es mayor que el número máximo de implementaciones para la IoT Hub.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

list[Configuration],
ClientRawResponse

Excepciones

HttpOperationError

test_queries

Valida la condición de destino y las consultas de métricas personalizadas para una configuración en el IoT Hub.

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

Parámetros

input
ConfigurationQueriesTestInput
Requerido

Configuración de la condición de destino y las consultas de métricas personalizadas.

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

ConfigurationQueriesTestResponse o ClientRawResponse si raw=true

Tipo de valor devuelto

ConfigurationQueriesTestResponse,
ClientRawResponse

Excepciones

HttpOperationError

Atributos

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'>