JobsOperations クラス

JobsOperations 操作。

継承
builtins.object
JobsOperations

コンストラクター

JobsOperations(client, config, serializer, deserializer)

パラメーター

client
必須

サービス要求のクライアント。

config
必須

サービス クライアントの構成。

serializer
必須

オブジェクト モデル シリアライザー。

deserializer
必須

オブジェクト モデル逆シリアライザー。

変数

api_version

Api のバージョン。 定数値: "2021-04-12"

メソッド

cancel_import_export_job

IoT Hubのインポート ジョブまたはエクスポート ジョブを取り消します。

cancel_scheduled_job

IoT Hubでスケジュールされたジョブを取り消します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs 」を参照してください。

create_import_export_job

IoT Hubに新しいインポートまたはエクスポート ジョブを作成します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities 」を参照してください。

create_scheduled_job

スケジュールされた時刻にIoT Hubでツインの更新またはダイレクト メソッドをスケジュールする新しいジョブを作成します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs 」を参照してください。

get_import_export_job

IoT Hubのインポート ジョブまたはエクスポート ジョブの状態を取得します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities 」を参照してください。

get_import_export_jobs

IoT Hub内のすべてのインポート ジョブとエクスポート ジョブの状態を取得します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities 」を参照してください。

get_scheduled_job

IoT Hubからスケジュールされたジョブの詳細を取得します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs 」を参照してください。

query_scheduled_jobs

IoT Hub クエリを使用してジョブに関する情報を取得します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 」を参照してください。

cancel_import_export_job

IoT Hubのインポート ジョブまたはエクスポート ジョブを取り消します。

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

パラメーター

id
str
必須

ジョブの一意識別子。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

object または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

cancel_scheduled_job

IoT Hubでスケジュールされたジョブを取り消します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs 」を参照してください。

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

パラメーター

id
str
必須

ジョブの一意識別子。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

jobResponse または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

create_import_export_job

IoT Hubに新しいインポートまたはエクスポート ジョブを作成します。 詳細については、「 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)

パラメーター

job_properties
JobProperties
必須

ジョブの仕様。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

jobProperties または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

create_scheduled_job

スケジュールされた時刻にIoT Hubでツインの更新またはダイレクト メソッドをスケジュールする新しいジョブを作成します。 詳細については、「 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)

パラメーター

id
str
必須

ジョブの一意識別子。

job_request
JobRequest
必須

ジョブ要求情報。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

jobResponse または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

get_import_export_job

IoT Hubのインポート ジョブまたはエクスポート ジョブの状態を取得します。 詳細については、「 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)

パラメーター

id
str
必須

ジョブの一意識別子。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

jobProperties または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

get_import_export_jobs

IoT Hub内のすべてのインポート ジョブとエクスポート ジョブの状態を取得します。 詳細については、「 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)

パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

list または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

get_scheduled_job

IoT Hubからスケジュールされたジョブの詳細を取得します。 詳細については、「 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs 」を参照してください。

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

パラメーター

id
str
必須

ジョブの一意識別子。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

jobResponse または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

query_scheduled_jobs

IoT Hub クエリを使用してジョブに関する情報を取得します。 詳細については、「 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)

パラメーター

job_type
str
既定値: None

ジョブの種類。 使用可能なジョブの種類の一覧については、以下を参照してください https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs

job_status
str
既定値: None

ジョブの状態。 使用可能な状態の一覧については、以下を参照してください https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

queryResult または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

属性

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