JobsOperations Classe

Operações jobsOperations.

Herança

builtins.object

JobsOperations

Construtor

JobsOperations(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

cancel_import_export_job	Cancela um trabalho de importação ou exportação no Hub IoT.
cancel_scheduled_job	Cancela um trabalho agendado no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.
create_import_export_job	Cria um novo trabalho de importação ou exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.
create_scheduled_job	Cria um novo trabalho para agendar atualizações de gêmeos ou métodos diretos no Hub IoT em um horário agendado. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.
get_import_export_job	Obtém o status de um trabalho de importação ou exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.
get_import_export_jobs	Obtém o status de todos os trabalhos de importação e exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.
get_scheduled_job	Obtém detalhes de um trabalho agendado do Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.
query_scheduled_jobs	Obtém as informações sobre trabalhos usando uma consulta Hub IoT. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações.

cancel_import_export_job

Cancela um trabalho de importação ou exportação no Hub IoT.

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

Parâmetros

id

str

Obrigatório

O identificador exclusivo do trabalho.

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

object ou ClientRawResponse se raw=true

Tipo de retorno

object,

ClientRawResponse

Exceções

HttpOperationError

cancel_scheduled_job

Cancela um trabalho agendado no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.

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

Parâmetros

id

str

Obrigatório

O identificador exclusivo do trabalho.

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

JobResponse ou ClientRawResponse se raw=true

Tipo de retorno

JobResponse,

ClientRawResponse

Exceções

HttpOperationError

create_import_export_job

Cria um novo trabalho de importação ou exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.

create_import_export_job(job_properties, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_properties

JobProperties

Obrigatório

As especificações do trabalho.

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

JobProperties ou ClientRawResponse se raw=true

Tipo de retorno

JobProperties,

ClientRawResponse

Exceções

HttpOperationError

create_scheduled_job

Cria um novo trabalho para agendar atualizações de gêmeos ou métodos diretos no Hub IoT em um horário agendado. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.

create_scheduled_job(id, job_request, custom_headers=None, raw=False, **operation_config)

Parâmetros

id

str

Obrigatório

O identificador exclusivo do trabalho.

job_request

JobRequest

Obrigatório

As informações de solicitação de trabalho.

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

JobResponse ou ClientRawResponse se raw=true

Tipo de retorno

JobResponse,

ClientRawResponse

Exceções

HttpOperationError

get_import_export_job

Obtém o status de um trabalho de importação ou exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.

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

Parâmetros

id

str

Obrigatório

O identificador exclusivo do trabalho.

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

JobProperties ou ClientRawResponse se raw=true

Tipo de retorno

JobProperties,

ClientRawResponse

Exceções

HttpOperationError

get_import_export_jobs

Obtém o status de todos os trabalhos de importação e exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.

get_import_export_jobs(custom_headers=None, raw=False, **operation_config)

Parâmetros

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[JobProperties],

ClientRawResponse

Exceções

HttpOperationError

get_scheduled_job

Obtém detalhes de um trabalho agendado do Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.

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

Parâmetros

id

str

Obrigatório

O identificador exclusivo do trabalho.

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

JobResponse ou ClientRawResponse se raw=true

Tipo de retorno

JobResponse,

ClientRawResponse

Exceções

HttpOperationError

query_scheduled_jobs

Obtém as informações sobre trabalhos usando uma consulta Hub IoT. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações.

query_scheduled_jobs(job_type=None, job_status=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_type

str

valor padrão: None

O tipo de trabalho. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs para obter uma lista de possíveis tipos de trabalho.

job_status

str

valor padrão: None

O status do trabalho. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs para obter uma lista de possíveis status.

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

QueryResult ou ClientRawResponse se raw=true

Tipo de retorno

QueryResult,

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