JobsOperations Klasa

ZadaniaOperacje.

Dziedziczenie

builtins.object

JobsOperations

Konstruktor

JobsOperations(client, config, serializer, deserializer)

Parametry

client

Wymagane

Klient żądań obsługi.

config

Wymagane

Konfiguracja klienta usługi.

serializer

Wymagane

Serializator modelu obiektów.

deserializer

Wymagane

Deserializator modelu obiektów.

Zmienne

api_version

Wersja interfejsu API. Stała wartość: "2021-04-12".

Metody

cancel_import_export_job	Anuluje zadanie importu lub eksportu w IoT Hub.
cancel_scheduled_job	Anuluje zaplanowane zadanie w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.
create_import_export_job	Tworzy nowe zadanie importowania lub eksportowania w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
create_scheduled_job	Tworzy nowe zadanie do planowania aktualizacji bliźniaczej reprezentacji lub metod bezpośrednich w IoT Hub w zaplanowanym czasie. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.
get_import_export_job	Pobiera stan zadania importu lub eksportu w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
get_import_export_jobs	Pobiera stan wszystkich zadań importu i eksportu w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
get_scheduled_job	Pobiera szczegółowe informacje o zaplanowanym zadaniu z IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.
query_scheduled_jobs	Pobiera informacje o zadaniach przy użyciu zapytania IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

cancel_import_export_job

Anuluje zadanie importu lub eksportu w IoT Hub.

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

Parametry

id

str

Wymagane

Unikatowy identyfikator zadania.

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

object lub ClientRawResponse, jeśli raw=true

Typ zwracany

object,

ClientRawResponse

Wyjątki

HttpOperationError

cancel_scheduled_job

Anuluje zaplanowane zadanie w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

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

Parametry

id

str

Wymagane

Unikatowy identyfikator zadania.

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

JobResponse lub ClientRawResponse, jeśli raw=true

Typ zwracany

JobResponse,

ClientRawResponse

Wyjątki

HttpOperationError

create_import_export_job

Tworzy nowe zadanie importowania lub eksportowania w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

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

Parametry

job_properties

JobProperties

Wymagane

Specyfikacje zadania.

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

JobProperties lub ClientRawResponse, jeśli wartość raw=true

Typ zwracany

JobProperties,

ClientRawResponse

Wyjątki

HttpOperationError

create_scheduled_job

Tworzy nowe zadanie do planowania aktualizacji bliźniaczej reprezentacji lub metod bezpośrednich w IoT Hub w zaplanowanym czasie. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

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

Parametry

id

str

Wymagane

Unikatowy identyfikator zadania.

job_request

JobRequest

Wymagane

Informacje o żądaniu zadania.

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

JobResponse lub ClientRawResponse, jeśli raw=true

Typ zwracany

JobResponse,

ClientRawResponse

Wyjątki

HttpOperationError

get_import_export_job

Pobiera stan zadania importu lub eksportu w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

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

Parametry

id

str

Wymagane

Unikatowy identyfikator zadania.

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

JobProperties lub ClientRawResponse, jeśli wartość raw=true

Typ zwracany

JobProperties,

ClientRawResponse

Wyjątki

HttpOperationError

get_import_export_jobs

Pobiera stan wszystkich zadań importu i eksportu w IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

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

Parametry

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

list lub ClientRawResponse, jeśli raw=true

Typ zwracany

list[JobProperties],

ClientRawResponse

Wyjątki

HttpOperationError

get_scheduled_job

Pobiera szczegółowe informacje o zaplanowanym zadaniu z IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

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

Parametry

id

str

Wymagane

Unikatowy identyfikator zadania.

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

JobResponse lub ClientRawResponse, jeśli raw=true

Typ zwracany

JobResponse,

ClientRawResponse

Wyjątki

HttpOperationError

query_scheduled_jobs

Pobiera informacje o zadaniach przy użyciu zapytania IoT Hub. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

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

Parametry

job_type

str

wartość domyślna: None

Typ zadania. Zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs listę możliwych typów zadań.

job_status

str

wartość domyślna: None

Stan zadania. Zobacz https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs listę możliwych stanów.

custom_headers

dict

wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw

bool

wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config

Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

ZapytanieResult lub ClientRawResponse, jeśli raw=true

Typ zwracany

QueryResult,

ClientRawResponse

Wyjątki

HttpOperationError

Atrybuty

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