ConfigurationOperations Classe

Operações de ConfigurationOperations.

Herança

builtins.object

ConfigurationOperations

Construtor

ConfigurationOperations(client, config, serializer, deserializer)

Parâmetros

client

Obrigatório

Cliente para solicitações de serviço.

config

Obrigatório

Configuração do cliente de serviço.

serializer

Obrigatório

Um serializador de modelo de objeto.

deserializer

Obrigatório

Um desserializador de 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 gerenciamento automático de dispositivo/módulo. O identificador de configuração e o Conteúdo não podem ser atualizados.
delete	Exclui uma configuração no Hub IoT para gerenciamento automático de dispositivo/módulo.
get	Obtém uma configuração no Hub IoT para gerenciamento automático de dispositivo/módulo.
get_configurations	Obtém configurações no Hub IoT para gerenciamento automático de dispositivo/módulo. Não há suporte para paginação.
test_queries	Valida a condição de destino e as consultas de métrica 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

Obrigatório

O identificador exclusivo do dispositivo de borda.

content

ConfigurationContent

Obrigatório

O conteúdo da configuração.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

HttpOperationError

create_or_update

Cria ou atualiza uma configuração no Hub IoT para gerenciamento automático de dispositivo/módulo. 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

Obrigatório

O identificador exclusivo da configuração.

configuration

Configuration

Obrigatório

A configuração a ser criada ou atualizada.

if_match

str

valor padrão: None

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

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Configuração ou ClientRawResponse se raw=true

Tipo de retorno

Configuration,

ClientRawResponse

Exceções

HttpOperationError

delete

Exclui uma configuração no Hub IoT para gerenciamento automático de dispositivo/módulo.

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

Parâmetros

id

str

Obrigatório

O identificador exclusivo da configuração.

if_match

str

valor padrão: None

A cadeia de caracteres que representa uma ETag fraca para a configuração, de acordo com RFC7232. A operação de exclusão será executada somente se essa ETag corresponder ao valor mantido pelo servidor, indicando que a configuração não foi modificada desde a última recuperação. Para forçar uma exclusão incondicional, defina If-Match para o caractere curinga (*).

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

HttpOperationError

get

Obtém uma configuração no Hub IoT para gerenciamento automático de dispositivo/módulo.

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

Parâmetros

id

str

Obrigatório

O identificador exclusivo da configuração.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Configuração ou ClientRawResponse se raw=true

Tipo de retorno

Configuration,

ClientRawResponse

Exceções

HttpOperationError

get_configurations

Obtém configurações no Hub IoT para gerenciamento automático de dispositivo/módulo. Não há suporte para paginação.

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

Parâmetros

top

int

valor padrão: None

O número de configurações a serem recuperadas. O valor será substituído se for maior que a contagem máxima de implantação para o Hub IoT.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

list ou ClientRawResponse se raw=true

Tipo de retorno

list[Configuration],

ClientRawResponse

Exceções

HttpOperationError

test_queries

Valida a condição de destino e as consultas de métrica personalizadas para uma configuração no Hub IoT.

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

Parâmetros

input

ConfigurationQueriesTestInput

Obrigatório

A configuração para a condição de destino e consultas de métrica personalizadas.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

ConfigurationQueriesTestResponse ou ClientRawResponse se raw=true

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