Partilhar via

ConfigurationOperations Classe

  • Referência

Configuração Operações operações.

Herança
builtins.object
ConfigurationOperations

Construtor

ConfigurationOperations(client, config, serializer, deserializer)

Parâmetros

client
Necessário

Cliente para pedidos de serviço.

config
Necessário

Configuração do cliente de serviço.

serializer
Necessário

Um serializador modelo de objeto.

deserializer
Necessário

Um deserializador modelo de objeto.

Variáveis

api_version

Versão da Api. Valor constante: "2021-04-12".

Métodos

apply_on_edge_device

Aplica o conteúdo de configuração a um dispositivo de borda.
create_or_update

Cria ou atualiza uma configuração no Hub IoT para a gestão automática de dispositivos/módulos. O identificador de configuração e o conteúdo não podem ser atualizados.
delete

Elimina uma configuração no Hub IoT para a gestão automática do dispositivo/módulo.
get

Obtém uma configuração no Hub IoT para a gestão automática do dispositivo/módulo.
get_configurations

Obtém configurações no Hub IoT para gestão automática de dispositivos/módulos. A paginação não é apoiada.
test_queries

Valida a condição do alvo e consultas métricas personalizadas para uma configuração no Hub IoT.

apply_on_edge_device

Aplica o conteúdo de configuração a um dispositivo de borda.

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

Parâmetros

id
str
Necessário

O identificador único do dispositivo de borda.

content
ConfigurationContent
Necessário

O conteúdo de configuração.

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config
Necessário

A configuração da operação sobrepõe-se.

Devoluções

Nenhum ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

None,
ClientRawResponse

Exceções

HttpOperationError

create_or_update

Cria ou atualiza uma configuração no Hub IoT para a gestão automática de dispositivos/módulos. O identificador de configuração e o conteúdo não podem ser atualizados.

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

Parâmetros

id
str
Necessário

O identificador único da configuração.

configuration
Configuration
Necessário

A configuração a ser criada ou atualizada.

if_match
str
valor predefinido: None

A cadeia que representa um ETag fraco para a configuração, de acordo com RFC7232. Isto não deve ser definido ao criar uma configuração, mas pode ser definido ao atualizar uma configuração.

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config
Necessário

A configuração da operação sobrepõe-se.

Devoluções

Configuração ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

Configuration,
ClientRawResponse

Exceções

HttpOperationError

delete

Elimina uma configuração no Hub IoT para a gestão automática do dispositivo/módulo.

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

Parâmetros

id
str
Necessário

O identificador único da configuração.

if_match
str
valor predefinido: None

A cadeia que representa um ETag fraco para a configuração, de acordo com RFC7232. A operação de eliminação só é realizada se este ETag corresponder ao valor mantido pelo servidor, indicando que a configuração não foi modificada desde que foi recuperada pela última vez. Para forçar uma eliminação incondicional, desempare If-Match ao carácter wildcard (*).

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config
Necessário

A configuração da operação sobrepõe-se.

Devoluções

Nenhum ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

None,
ClientRawResponse

Exceções

HttpOperationError

get

Obtém uma configuração no Hub IoT para a gestão automática do dispositivo/módulo.

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

Parâmetros

id
str
Necessário

O identificador único da configuração.

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config
Necessário

A configuração da operação sobrepõe-se.

Devoluções

Configuração ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

Configuration,
ClientRawResponse

Exceções

HttpOperationError

get_configurations

Obtém configurações no Hub IoT para gestão automática de dispositivos/módulos. A paginação não é apoiada.

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

Parâmetros

top
int
valor predefinido: None

O número de configurações para recuperar. O valor será ultrapassado se for superior à contagem máxima de implantação para o Hub IoT.

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config
Necessário

A configuração da operação sobrepõe-se.

Devoluções

lista ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

list[Configuration],
ClientRawResponse

Exceções

HttpOperationError

test_queries

Valida a condição do alvo e consultas métricas personalizadas para uma configuração no Hub IoT.

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

Parâmetros

input
ConfigurationQueriesTestInput
Necessário

A configuração para a condição de alvo e consultas métricas personalizadas.

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config
Necessário

A configuração da operação sobrepõe-se.

Devoluções

ConfiguraçõesQueriesTestResponse ou ClientRawResponse se cru=verdadeiro

Tipo de retorno

ConfigurationQueriesTestResponse,
ClientRawResponse

Exceções

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