다음을 통해 공유

IoTHubJobManager 클래스

  • 참조

자동 생성된 IotHub REST API를 기반으로 IoTHub Job Manager 작업에 편리한 API를 제공하는 클래스

Job Manager 서비스 클라이언트에 대한 이니셜라이저입니다.

성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다.

상속
builtins.object
IoTHubJobManager

생성자

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

매개 변수

Name Description
connection_string
str

connection_str 인증을 사용하는 경우 IoTHub와의 연결을 인증하는 데 사용되는 IoTHub 연결 문자열입니다. 기본값: 없음

기본값: None
host
str

토큰 자격 증명 인증을 사용하는 경우 Azure 서비스 URL입니다. 기본값: 없음

기본값: None
auth
str

토큰 자격 증명 인증을 사용하는 경우 Azure 인증 개체입니다. 기본값: 없음

기본값: None

메서드

cancel_import_export_job

IoT Hub에서 가져오기/내보내기 작업을 취소합니다.
cancel_scheduled_job

IoT Hub에서 예약된 작업을 취소합니다.
create_import_export_job

IoT Hub에서 새 가져오기/내보내기 작업을 만듭니다.
create_scheduled_job

IoT Hub에서 업데이트 쌍 또는 디바이스 직접 메서드를 예약하는 새 작업을 만듭니다.
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 Hub를 쿼리하여 IoT Hub 쿼리 언어를 사용하여 작업에 대한 정보를 검색합니다.

cancel_import_export_job

IoT Hub에서 가져오기/내보내기 작업을 취소합니다.

cancel_import_export_job(job_id)

매개 변수

Name Description
job_id
필수
str

작업의 ID입니다.

반환

형식 Description

개체입니다.

예외

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

cancel_scheduled_job

IoT Hub에서 예약된 작업을 취소합니다.

cancel_scheduled_job(job_id)

매개 변수

Name Description
job_id
필수
str

작업의 ID입니다.

반환

형식 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 Hub에서 새 가져오기/내보내기 작업을 만듭니다.

create_import_export_job(job_properties)

매개 변수

Name 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 Hub에서 업데이트 쌍 또는 디바이스 직접 메서드를 예약하는 새 작업을 만듭니다.

create_scheduled_job(job_id, job_request)

매개 변수

Name Description
job_id
필수
str

작업의 ID입니다.
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)

매개 변수

Name 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)

매개 변수

Name 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)

매개 변수

Name Description
job_id
필수
str

작업의 ID입니다.

반환

형식 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)

매개 변수

Name Description
job_id
필수
str

작업의 ID입니다.

반환

형식 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 Hub를 쿼리하여 IoT Hub 쿼리 언어를 사용하여 작업에 대한 정보를 검색합니다.

query_scheduled_jobs(job_type, job_status)

매개 변수

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