IoTHubJobManager 類別

類別，可根據自動產生的 IotHub REST API，為 IoTHub 作業管理員作業提供便利 API

Job Manager 服務用戶端的初始化運算式。

成功建立類別之後，已向 IoTHub 進行驗證，並準備好呼叫成員 API 來與 IoTHub 通訊。

繼承

builtins.object

IoTHubJobManager

建構函式

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

參數

名稱	Description
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 Service 用戶端的 Classmethod 初始化運算式。 從連接字串建立 IoTHubJobManager 類別。 成功建立類別之後，已向 IoTHub 進行驗證，並準備好呼叫成員 API 來與 IoTHub 通訊。
from_token_credential	IoTHubJobManager Service 用戶端的 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 中樞查詢語言擷取作業的相關資訊。

cancel_import_export_job

取消 IoT 中樞上的匯入/匯出作業。

cancel_import_export_job(job_id)

參數

名稱	Description
job_id 必要	str 作業的識別碼。

傳回

類型	Description
	物件。

例外狀況

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

cancel_scheduled_job

取消 IoT 中樞上的排程工作。

cancel_scheduled_job(job_id)

參數

名稱	Description
job_id 必要	str 作業的識別碼。

傳回

類型	Description
<xref:azure.iot.hub.models.JobResponse>	包含已取消之作業的 JobResponse 物件。

例外狀況

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

create_import_export_job

在 IoT 中樞上建立新的匯入/匯出作業。

create_import_export_job(job_properties)

參數

名稱	Description
job_properties 必要	<xref:azure.iot.hub.models.JobProperties> 指定作業規格。

傳回

類型	Description
<xref:azure.iot.hub.models.JobProperties>	包含已建立之作業的 JobProperties 物件。

例外狀況

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

create_scheduled_job

建立新的作業，以排程 IoT 中樞上的更新對應項或裝置直接方法。

create_scheduled_job(job_id, job_request)

參數

名稱	Description
job_id 必要	str 作業的識別碼。
job_request 必要	<xref:azure.iot.hub.models.JobRequest> 指定作業。

傳回

類型	Description
<xref:azure.iot.hub.models.JobResponse>	包含已建立之作業的 JobResponse 物件。

例外狀況

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

from_connection_string

IoTHubJobManager Service 用戶端的 Classmethod 初始化運算式。 從連接字串建立 IoTHubJobManager 類別。

成功建立類別之後，已向 IoTHub 進行驗證，並準備好呼叫成員 API 來與 IoTHub 通訊。

from_connection_string(connection_string)

參數

名稱	Description
connection_string 必要	str 用來驗證與 IoTHub 連線的 IoTHub 連接字串。

傳回

類型	Description
IoTHubJobManager

例外狀況

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

from_token_credential

IoTHubJobManager Service 用戶端的 Classmethod 初始化運算式。 從主機名稱 URL 和 Azure 權杖認證建立 IoTHubJobManager 類別。

成功建立類別之後，已向 IoTHub 進行驗證，並準備好呼叫成員 API 來與 IoTHub 通訊。

from_token_credential(url, token_credential)

參數

名稱	Description
url 必要	str azure 服務 URL (主機名稱) 。
token_credential 必要	<xref:azure.core.TokenCredential> Azure 權杖認證物件

傳回

類型	Description
IoTHubJobManager

例外狀況

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

get_import_export_job

擷取 IoTHub 上匯入/匯出作業的狀態。

get_import_export_job(job_id)

參數

名稱	Description
job_id 必要	str 作業的識別碼。

傳回

類型	Description
<xref:azure.iot.hub.models.JobProperties>	包含要求之作業的 JobProperties 物件。

例外狀況

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

get_import_export_jobs

擷取 IoTHub 上所有匯入/匯出作業的狀態。

get_import_export_jobs()

傳回

類型	Description
list[<xref:azure.iot.hub.models.JobProperties>]	list[job_properties] 物件。

例外狀況

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

get_scheduled_job

擷取 IoTHub 上排程工作的詳細資料。

get_scheduled_job(job_id)

參數

名稱	Description
job_id 必要	str 作業的識別碼。

傳回

類型	Description
<xref:azure.iot.hub.models.JobResponse>	包含所要求詳細資料的 JobResponse 物件。

例外狀況

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

query_scheduled_jobs

查詢 IoT 中樞，以使用IoT 中樞查詢語言擷取作業的相關資訊。

query_scheduled_jobs(job_type, job_status)

參數

名稱	Description
job_type 必要	str 作業的類型。
job_status 必要	str 作業的狀態。

傳回

類型	Description
<xref:azure.iot.hub.models.QueryResult>	包含作業的 QueryResult 物件。

例外狀況

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