IoTHubJobManager Класс
Класс для предоставления удобных API-интерфейсов для операций Диспетчера заданий Интернета вещей на основе автоматически созданных интерфейсов REST API IotHub.
Инициализатор для клиента службы диспетчера заданий.
После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.
- Наследование
-
builtins.objectIoTHubJobManager
Конструктор
IoTHubJobManager(connection_string=None, host=None, auth=None)
Параметры
Имя | Описание |
---|---|
connection_string
|
Строка подключения Центра Интернета вещей, используемая для проверки подлинности подключения к Центру Интернета вещей, если мы используем connection_str проверку подлинности. Значение по умолчанию: нет значение по умолчанию: None
|
host
|
URL-адрес службы Azure, если мы используем проверку подлинности с помощью учетных данных маркера. Значение по умолчанию: нет значение по умолчанию: None
|
auth
|
Объект проверки подлинности Azure, если мы используем проверку подлинности с помощью учетных данных маркера. Значение по умолчанию: нет значение по умолчанию: None
|
Методы
cancel_import_export_job |
Отменяет задание импорта и экспорта в Центре Интернета вещей. |
cancel_scheduled_job |
Отменяет запланированное задание в Центре Интернета вещей. |
create_import_export_job |
Создает новое задание импорта и экспорта в Центре Интернета вещей. |
create_scheduled_job |
Создает новое задание для планирования обновления двойников или прямых методов устройства в Центре Интернета вещей. |
from_connection_string |
Инициализатор класса для клиента службы IoTHubJobManager. Создает класс IoTHubJobManager из строки подключения. После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub. |
from_token_credential |
Инициализатор класса для клиента службы IoTHubJobManager. Создает класс IoTHubJobManager на основе URL-адреса имени узла и учетных данных маркера Azure. После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub. |
get_import_export_job |
Извлекает состояние задания импорта и экспорта в Центре Интернета вещей. |
get_import_export_jobs |
Извлекает состояние всех заданий импорта и экспорта в Центре Интернета вещей. |
get_scheduled_job |
Извлекает сведения о запланированном задании на Сайте Интернета вещей. |
query_scheduled_jobs |
Запрос к Центру Интернета вещей для получения сведений о заданиях с помощью языка запросов Центр Интернета вещей. |
cancel_import_export_job
Отменяет задание импорта и экспорта в Центре Интернета вещей.
cancel_import_export_job(job_id)
Параметры
Имя | Описание |
---|---|
job_id
Обязательно
|
Идентификатор задания. |
Возвращаемое значение
Тип | Описание |
---|---|
Объект. |
Исключения
Тип | Описание |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
cancel_scheduled_job
Отменяет запланированное задание в Центре Интернета вещей.
cancel_scheduled_job(job_id)
Параметры
Имя | Описание |
---|---|
job_id
Обязательно
|
Идентификатор задания. |
Возвращаемое значение
Тип | Описание |
---|---|
<xref:azure.iot.hub.models.JobResponse>
|
Объект JobResponse, содержащий отмененное задание. |
Исключения
Тип | Описание |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_import_export_job
Создает новое задание импорта и экспорта в Центре Интернета вещей.
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
Создает новое задание для планирования обновления двойников или прямых методов устройства в Центре Интернета вещей.
create_scheduled_job(job_id, job_request)
Параметры
Имя | Описание |
---|---|
job_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 из строки подключения.
После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.
from_connection_string(connection_string)
Параметры
Имя | Описание |
---|---|
connection_string
Обязательно
|
Строка подключения IoTHub, используемая для проверки подлинности подключения к Центру Интернета вещей. |
Возвращаемое значение
Тип | Описание |
---|---|
Исключения
Тип | Описание |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_token_credential
Инициализатор класса для клиента службы IoTHubJobManager. Создает класс IoTHubJobManager на основе URL-адреса имени узла и учетных данных маркера Azure.
После успешного создания класс прошел проверку подлинности с помощью Центра Интернета вещей и готов вызывать API-интерфейсы-члены для взаимодействия с IoTHub.
from_token_credential(url, token_credential)
Параметры
Имя | Описание |
---|---|
url
Обязательно
|
URL-адрес службы Azure (имя узла). |
token_credential
Обязательно
|
<xref:azure.core.TokenCredential>
Объект учетных данных маркера Azure |
Возвращаемое значение
Тип | Описание |
---|---|
Исключения
Тип | Описание |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_import_export_job
Извлекает состояние задания импорта и экспорта в Центре Интернета вещей.
get_import_export_job(job_id)
Параметры
Имя | Описание |
---|---|
job_id
Обязательно
|
Идентификатор задания. |
Возвращаемое значение
Тип | Описание |
---|---|
<xref:azure.iot.hub.models.JobProperties>
|
Объект JobProperties, содержащий запрошенные задания. |
Исключения
Тип | Описание |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_import_export_jobs
Извлекает состояние всех заданий импорта и экспорта в Центре Интернета вещей.
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
Извлекает сведения о запланированном задании на Сайте Интернета вещей.
get_scheduled_job(job_id)
Параметры
Имя | Описание |
---|---|
job_id
Обязательно
|
Идентификатор задания. |
Возвращаемое значение
Тип | Описание |
---|---|
<xref:azure.iot.hub.models.JobResponse>
|
Объект JobResponse, содержащий запрошенные сведения. |
Исключения
Тип | Описание |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
query_scheduled_jobs
Запрос к Центру Интернета вещей для получения сведений о заданиях с помощью языка запросов Центр Интернета вещей.
query_scheduled_jobs(job_type, job_status)
Параметры
Имя | Описание |
---|---|
job_type
Обязательно
|
Тип заданий. |
job_status
Обязательно
|
Состояние заданий. |
Возвращаемое значение
Тип | Описание |
---|---|
<xref:azure.iot.hub.models.QueryResult>
|
Объект QueryResult, содержащий задания. |
Исключения
Тип | Описание |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python