次の方法で共有

IoTHubJobManager クラス

  • リファレンス

自動生成された IotHub REST API に基づいて、IoTHub Job Manager 操作に便利な API を提供するクラス

ジョブ マネージャー サービス クライアントの初期化子。

作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。

継承
builtins.object
IoTHubJobManager

コンストラクター

IoTHubJobManager(connection_string=None, host=None, auth=None)

パラメーター

名前 説明
connection_string
str

connection_str認証を使用している場合に IoTHub との接続を認証するために使用される IoTHub 接続文字列。 既定値: なし

既定値: None
host
str

トークン資格情報認証を使用している場合は、Azure サービスの URL。 既定値: なし

既定値: None
auth
str

トークン資格情報認証を使用している場合は、Azure 認証オブジェクト。 既定値: なし

既定値: None

メソッド

cancel_import_export_job

IoT ハブ上のインポート/エクスポート ジョブを取り消します。
cancel_scheduled_job

IoT ハブでスケジュールされたジョブを取り消します。
create_import_export_job

IoT ハブに新しいインポート/エクスポート ジョブを作成します。
create_scheduled_job

IoT ハブで更新ツインまたはデバイス ダイレクト メソッドをスケジュールする新しいジョブを作成します。
from_connection_string

IoTHubJobManager サービス クライアントの Classmethod 初期化子。 接続文字列から IoTHubJobManager クラスを作成します。

作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
from_token_credential

IoTHubJobManager サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から IoTHubJobManager クラスを作成します。

作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
get_import_export_job

IoTHub 上のインポート/エクスポート ジョブの状態を取得します。
get_import_export_jobs

IoTHub 上のすべてのインポート/エクスポート ジョブの状態を取得します。
get_scheduled_job

IoTHub でスケジュールされたジョブの詳細を取得します。
query_scheduled_jobs

IoT ハブにクエリを実行し、IoT Hubクエリ言語を使用してジョブに関する情報を取得します。

cancel_import_export_job

IoT ハブ上のインポート/エクスポート ジョブを取り消します。

cancel_import_export_job(job_id)

パラメーター

名前 説明
job_id
必須
str

ジョブの ID。

戻り値

型 説明

オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

cancel_scheduled_job

IoT ハブでスケジュールされたジョブを取り消します。

cancel_scheduled_job(job_id)

パラメーター

名前 説明
job_id
必須
str

ジョブの ID。

戻り値

型 説明
<xref:azure.iot.hub.models.JobResponse>

取り消されたジョブを含む JobResponse オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_import_export_job

IoT ハブに新しいインポート/エクスポート ジョブを作成します。

create_import_export_job(job_properties)

パラメーター

名前 説明
job_properties
必須
<xref:azure.iot.hub.models.JobProperties>

ジョブの指定を指定します。

戻り値

型 説明
<xref:azure.iot.hub.models.JobProperties>

作成されたジョブを含む JobProperties オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_scheduled_job

IoT ハブで更新ツインまたはデバイス ダイレクト メソッドをスケジュールする新しいジョブを作成します。

create_scheduled_job(job_id, job_request)

パラメーター

名前 説明
job_id
必須
str

ジョブの ID。
job_request
必須
<xref:azure.iot.hub.models.JobRequest>

ジョブを指定します。

戻り値

型 説明
<xref:azure.iot.hub.models.JobResponse>

作成されたジョブを含む JobResponse オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

IoTHubJobManager サービス クライアントの Classmethod 初期化子。 接続文字列から IoTHubJobManager クラスを作成します。

作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。

from_connection_string(connection_string)

パラメーター

名前 説明
connection_string
必須
str

IoTHub との接続を認証するために使用される IoTHub 接続文字列。

戻り値

型 説明
IoTHubJobManager

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

IoTHubJobManager サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から IoTHubJobManager クラスを作成します。

作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。

from_token_credential(url, token_credential)

パラメーター

名前 説明
url
必須
str

Azure サービスの URL (ホスト名)。
token_credential
必須
<xref:azure.core.TokenCredential>

Azure トークン資格情報オブジェクト

戻り値

型 説明
IoTHubJobManager

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_import_export_job

IoTHub 上のインポート/エクスポート ジョブの状態を取得します。

get_import_export_job(job_id)

パラメーター

名前 説明
job_id
必須
str

ジョブの ID。

戻り値

型 説明
<xref:azure.iot.hub.models.JobProperties>

要求されたジョブを含む JobProperties オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_import_export_jobs

IoTHub 上のすべてのインポート/エクスポート ジョブの状態を取得します。

get_import_export_jobs()

戻り値

型 説明
list[<xref:azure.iot.hub.models.JobProperties>]

list[job_properties] オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_scheduled_job

IoTHub でスケジュールされたジョブの詳細を取得します。

get_scheduled_job(job_id)

パラメーター

名前 説明
job_id
必須
str

ジョブの ID。

戻り値

型 説明
<xref:azure.iot.hub.models.JobResponse>

要求された詳細を含む JobResponse オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

query_scheduled_jobs

IoT ハブにクエリを実行し、IoT Hubクエリ言語を使用してジョブに関する情報を取得します。

query_scheduled_jobs(job_type, job_status)

パラメーター

名前 説明
job_type
必須
str

ジョブの種類。
job_status
必須
str

ジョブの状態。

戻り値

型 説明
<xref:azure.iot.hub.models.QueryResult>

ジョブを含む QueryResult オブジェクト。

例外

型 説明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>