Share via

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

IoTHubJobManager 类

  • 参考

一个类，用于基于自动生成的 IotHub REST API，为 IoTHub 作业管理器操作提供便捷 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 服务客户端的类方法初始值设定项。 从连接字符串创建 IoTHubJobManager 类。

成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 来与 IoTHub 通信。
from_token_credential

IoTHubJobManager 服务客户端的类方法初始值设定项。 从主机名 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)

参数

名称 说明
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 服务客户端的类方法初始值设定项。 从连接字符串创建 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 服务客户端的类方法初始值设定项。 从主机名 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 中心查询语言检索有关作业的信息。

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:.>