IoTHubModuleClient 클래스

Azure IoT Hub 또는 Azure IoT Edge instance 연결하는 동기 모듈 클라이언트입니다.

IoTHubModuleClient에 대한 이니셜라이저입니다.

이 이니셜라이저는 직접 호출해서는 안 됩니다. 대신 '>>create_from_<<' 클래스메토드 중 하나를 사용하여 인스턴스화합니다.

상속

azure.iot.device.iothub.sync_clients.GenericIoTHubClient

IoTHubModuleClient

azure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClient

IoTHubModuleClient

생성자

IoTHubModuleClient(mqtt_pipeline, http_pipeline)

매개 변수

mqtt_pipeline

<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>

필수

IoTHub 엔드포인트에 연결하는 데 사용되는 파이프라인입니다.

http_pipeline

<xref:azure.iot.device.iothub.pipeline.HTTPPipeline>

필수

HTTP를 통해 IoTHub 엔드포인트에 연결하는 데 사용되는 파이프라인입니다.

메서드

connect	클라이언트를 Azure IoT Hub 또는 Azure IoT Edge Hub instance 연결합니다. 대상은 이 개체를 초기화할 때 제공된 auth_provider 매개 변수를 통해 전달된 자격 증명에 따라 선택됩니다. 이는 동기 호출입니다. 즉, 서비스에 대한 연결이 완전히 설정될 때까지 이 함수가 반환되지 않습니다.
create_from_connection_string	IoTHub 디바이스 또는 모듈 연결 문자열에서 클라이언트를 인스턴스화합니다.
create_from_edge_environment	IoT Edge 환경에서 클라이언트를 인스턴스화합니다. 이 메서드는 IoT Edge 컨테이너 내부 또는 Edge 개발을 위해 구성된 디버깅 환경에서만 실행할 수 있습니다(예: Visual Studio, Visual Studio Code).
create_from_sastoken	미리 만든 SAS 토큰 문자열에서 클라이언트 인스턴스화
create_from_x509_certificate	X509 인증서 인증을 사용하여 클라이언트를 인스턴스화합니다.
disconnect	Azure IoT Hub 또는 Azure IoT Edge Hub instance 클라이언트 연결을 끊습니다. 클라이언트 instance 완전히 완료된 경우 이 함수를 호출하는 것이 좋습니다. 이는 동기 호출이므로 서비스에 대한 연결이 완전히 닫히기 전까지는 이 함수가 반환되지 않습니다.
get_twin	Azure IoT Hub 또는 Azure IoT Edge Hub 서비스에서 디바이스 또는 모듈 쌍을 가져옵니다. 이는 동기 호출입니다. 즉, 이 함수는 서비스에서 쌍을 검색할 때까지 반환되지 않습니다.
invoke_method	클라이언트에서 디바이스 또는 모듈 클라이언트로 메서드를 호출하고 메서드 호출에 대한 응답을 받습니다.
patch_twin_reported_properties	Azure IoT Hub 또는 Azure IoT Edge Hub 서비스를 사용하여 reported 속성을 업데이트합니다. 이는 동기 호출입니다. 즉, 패치가 서비스로 전송되고 승인될 때까지 이 함수가 반환되지 않습니다. 서비스가 패치 작업에 대한 오류를 반환하는 경우 이 함수는 적절한 오류를 발생합니다.
receive_message_on_input	다른 모듈에서 특정 입력으로 전송된 입력 메시지를 수신합니다. 버전 2.3.0 이후 사용되지 않음: 대신 .on_message_received 속성을 사용하여 처리기를 설정하는 것이 좋습니다.
receive_method_request	Azure IoT Hub 또는 Azure IoT Edge Hub를 통해 메서드 요청을 받습니다. 버전 2.3.0 이후 사용되지 않음: 대신 .on_method_request_received 속성을 사용하여 처리기를 설정하는 것이 좋습니다.
receive_twin_desired_properties_patch	Azure IoT Hub 또는 Azure IoT Edge Hub를 통해 원하는 속성 패치를 받습니다. 동기 호출입니다. 즉, 다음을 의미합니다. block=True이면 다음 중 하나가 발생할 때까지 이 함수가 차단됩니다. 원하는 속성 패치는 Azure IoT Hub 또는 Azure IoT Edge Hub에서 수신됩니다. 제공된 경우 시간 제한 기간이 경과합니다. 시간 제한이 발생하면 이 함수는 받은 편지함임프티 예외를 발생합니다. block=False이면 이 함수는 파이프라인에서 수신했지만 아직 애플리케이션에 반환되지 않은 원하는 속성 패치를 반환합니다. 파이프라인에서 원하는 속성 패치를 수신하지 않은 경우 이 함수는 InboxEmpty 예외를 발생합니다. 버전 2.3.0 이후 사용되지 않음: 대신 .on_twin_desired_properties_patch_received 속성을 사용하여 처리기를 설정하는 것이 좋습니다.
send_message	Azure IoT Hub 또는 Azure IoT Edge Hub instance 기본 이벤트 엔드포인트에 메시지를 보냅니다. 이는 동기 이벤트입니다. 즉, 이 함수는 이벤트가 서비스로 전송되고 서비스에서 이벤트 수신을 승인할 때까지 반환되지 않습니다. 서비스에 대한 연결이 이전에 연결 호출로 열리지 않은 경우 이 함수는 이벤트를 보내기 전에 연결을 엽니다.
send_message_to_output	지정된 모듈 출력에 이벤트/메시지를 보냅니다. 이러한 이벤트는 나가는 이벤트이며 "출력 이벤트"를 의미합니다. 이는 동기 이벤트입니다. 즉, 이 함수는 이벤트가 서비스로 전송되고 서비스에서 이벤트 수신을 승인할 때까지 반환되지 않습니다. 서비스에 대한 연결이 이전에 연결 호출로 열리지 않은 경우 이 함수는 이벤트를 보내기 전에 연결을 엽니다.
send_method_response	Azure IoT Hub 또는 Azure IoT Edge Hub를 통해 메서드 요청에 응답을 보냅니다. 이는 동기 이벤트입니다. 즉, 이 함수는 이벤트가 서비스로 전송되고 서비스에서 이벤트 수신을 승인할 때까지 반환되지 않습니다. 서비스에 대한 연결이 이전에 연결 호출로 열리지 않은 경우 이 함수는 이벤트를 보내기 전에 연결을 엽니다.
shutdown	정상 종료를 위해 클라이언트를 종료합니다. 이 메서드가 호출되면 추가 클라이언트 호출을 시도하면 ClientError가 발생합니다.
update_sastoken	인증에 사용되는 클라이언트의 SAS 토큰을 업데이트한 다음 연결을 다시 인증합니다. 이 API는 클라이언트가 처음에 SAS 토큰을 사용하여 만든 경우에만 사용할 수 있습니다.

connect

클라이언트를 Azure IoT Hub 또는 Azure IoT Edge Hub instance 연결합니다.

대상은 이 개체를 초기화할 때 제공된 auth_provider 매개 변수를 통해 전달된 자격 증명에 따라 선택됩니다.

이는 동기 호출입니다. 즉, 서비스에 대한 연결이 완전히 설정될 때까지 이 함수가 반환되지 않습니다.

connect()

예외

CredentialError

자격 증명이 유효하지 않으며 연결을 설정할 수 없는 경우 입니다.

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시간이 초과되면 입니다.

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

create_from_connection_string

IoTHub 디바이스 또는 모듈 연결 문자열에서 클라이언트를 인스턴스화합니다.

create_from_connection_string(connection_string, **kwargs)

매개 변수

connection_string

str

필수

연결하려는 IoTHub에 대한 연결 문자열입니다.

server_verification_cert

str

필수

구성 옵션. 신뢰할 수 있는 인증서 체인입니다. 프로토콜 게이트웨이와 같이 비표준 신뢰 루트가 있는 엔드포인트에 연결을 사용할 때 필요합니다.

websockets

bool

필수

구성 옵션. 기본값은 False입니다. websocket을 통해 MQTT를 사용하는 경우 true로 설정합니다.

cipher

str 또는 list(str)

필수

구성 옵션. TLS/SSL용 암호 도구 모음, "OpenSSL 암호 목록 형식"의 문자열 또는 암호 그룹 문자열 목록입니다.

product_info

str

필수

구성 옵션. 기본값은 빈 문자열입니다. 문자열에는 사용자 에이전트 문자열에 추가되는 임의의 제품 정보가 포함됩니다.

proxy_options

ProxyOptions

필수

프록시 서버를 통해 트래픽을 보내는 옵션입니다.

sastoken_ttl

int

필수

인증에 사용되는 생성된 SasToken의 TTL(Time to Live) 시간입니다(초). 기본값은 3600초(1시간)입니다.

keep_alive

int

필수

broker와의 통신 사이의 최대 기간(초)입니다. 다른 메시지가 교환되지 않는 경우 클라이언트가 broker에 ping 메시지를 보내는 속도를 제어합니다. 제공되지 않은 경우 기본값인 60초가 사용됩니다.

auto_connect

bool

필수

연결을 설정해야 하는 메서드가 호출될 때 클라이언트를 IoTHub에 자동으로 연결합니다. (기본값: True)

connection_retry

bool

필수

끊은 연결 다시 설정 시도(기본값: True)

connection_retry_interval

int

필수

삭제된 연결을 다시 설정하려는 시도 사이의 간격(초)(기본값: 10)

ensure_desired_properties

bool

필수

다시 연결 시 가장 최근에 원하는 속성 패치가 수신되었는지 확인합니다(기본값:True).

반환

인증에 연결 문자열을 사용하는 IoTHub 클라이언트의 instance.

예외

ValueError if given an invalid connection_string.

TypeError if given an unsupported parameter.

create_from_edge_environment

IoT Edge 환경에서 클라이언트를 인스턴스화합니다.

이 메서드는 IoT Edge 컨테이너 내부 또는 Edge 개발을 위해 구성된 디버깅 환경에서만 실행할 수 있습니다(예: Visual Studio, Visual Studio Code).

create_from_edge_environment(**kwargs)

매개 변수

websockets

bool

필수

구성 옵션. 기본값은 False입니다. websocket을 통해 MQTT를 사용하는 경우 true로 설정합니다.

cipher

str 또는 list(str)

필수

구성 옵션. TLS/SSL용 암호 도구 모음, "OpenSSL 암호 목록 형식"의 문자열 또는 암호 그룹 문자열 목록입니다.

product_info

str

필수

구성 옵션. 기본값은 빈 문자열입니다. 문자열에는 사용자 에이전트 문자열에 추가되는 임의의 제품 정보가 포함됩니다.

proxy_options

ProxyOptions

필수

프록시 서버를 통해 트래픽을 보내는 옵션입니다.

sastoken_ttl

int

필수

인증에 사용되는 생성된 SasToken의 TTL(Time to Live) 시간입니다(초). 기본값은 3600초(1시간)입니다.

keep_alive

int

필수

broker와의 통신 사이의 최대 기간(초)입니다. 다른 메시지가 교환되지 않는 경우 클라이언트가 broker에 ping 메시지를 보내는 속도를 제어합니다. 제공되지 않은 경우 기본값인 60초가 사용됩니다.

auto_connect

bool

필수

연결을 설정해야 하는 메서드가 호출될 때 클라이언트를 IoTHub에 자동으로 연결합니다. (기본값: True)

connection_retry

bool

필수

끊은 연결 다시 설정 시도(기본값: True)

connection_retry_interval

int

필수

삭제된 연결을 다시 설정하려는 시도 사이의 간격(초)(기본값: 10)

반환

인증에 IoT Edge 환경을 사용하는 IoTHub 클라이언트의 instance.

예외

OSError if the IoT Edge container is not configured correctly.

ValueError if debug variables are invalid.

TypeError if given an unsupported parameter.

create_from_sastoken

미리 만든 SAS 토큰 문자열에서 클라이언트 인스턴스화

create_from_sastoken(sastoken, **kwargs)

매개 변수

sastoken

str

필수

SAS 토큰 문자열

server_verification_cert

str

필수

구성 옵션. 신뢰할 수 있는 인증서 체인입니다. 프로토콜 게이트웨이와 같이 비표준 신뢰 루트가 있는 엔드포인트에 연결을 사용할 때 필요합니다.

gateway_hostname

str

필수

구성 옵션. 게이트웨이 디바이스의 게이트웨이 호스트 이름입니다.

websockets

bool

필수

구성 옵션. 기본값은 False입니다. websocket을 통해 MQTT를 사용하는 경우 true로 설정합니다.

cipher

str 또는 list(str)

필수

구성 옵션. TLS/SSL에 대한 암호 그룹, "OpenSSL 암호 목록 형식"의 문자열 또는 암호 그룹 문자열 목록입니다.

product_info

str

필수

구성 옵션. 기본값은 빈 문자열입니다. 문자열에는 사용자 에이전트 문자열에 추가되는 임의의 제품 정보가 포함됩니다.

proxy_options

ProxyOptions

필수

프록시 서버를 통해 트래픽을 보내는 옵션입니다.

keep_alive

int

필수

broker와의 통신 사이의 최대 기간(초)입니다. 다른 메시지가 교환되지 않는 경우 클라이언트가 broker에 ping 메시지를 보내는 속도를 제어합니다. 제공되지 않은 경우 기본값인 60초가 사용됩니다.

auto_connect

bool

필수

연결을 설정해야 하는 메서드가 호출될 때 클라이언트를 IoTHub에 자동으로 연결합니다. (기본값: True)

connection_retry

bool

필수

끊은 연결 다시 설정 시도(기본값: True)

connection_retry_interval

int

필수

끊은 연결을 다시 설정하려는 시도 사이의 간격(초)(기본값: 10)

ensure_desired_properties

bool

필수

다시 연결 시 가장 최근에 원하는 속성 패치가 수신되었는지 확인합니다(기본값:True).

예외

TypeError if given an unsupported parameter.

ValueError if the sastoken parameter is invalid.

create_from_x509_certificate

X509 인증서 인증을 사용하여 클라이언트를 인스턴스화합니다.

create_from_x509_certificate(x509, hostname, device_id, module_id, **kwargs)

매개 변수

hostname

str

필수

IotHub를 실행하는 호스트입니다. 개요 탭의 Azure Portal 문자열 호스트 이름으로 찾을 수 있습니다.

x509

X509

필수

전체 x509 인증서 개체입니다. 인증서를 사용하려면 등록 개체에 인증서(루트 인증서 또는 중간 CA 인증서 중 하나)가 포함되어야 합니다. 인증서가 CER 파일에서 가져온 경우 base64로 인코딩되어야 합니다.

device_id

str

필수

IoTHub에서 디바이스를 고유하게 식별하는 데 사용되는 ID

module_id

str

필수

IoTHub의 디바이스에서 모듈을 고유하게 식별하는 데 사용되는 ID입니다.

server_verification_cert

str

필수

구성 옵션. 신뢰할 수 있는 인증서 체인입니다. 프로토콜 게이트웨이와 같이 비표준 신뢰 루트가 있는 엔드포인트에 연결을 사용할 때 필요합니다.

gateway_hostname

str

필수

구성 옵션. 게이트웨이 디바이스의 게이트웨이 호스트 이름입니다.

websockets

bool

필수

구성 옵션. 기본값은 False입니다. websocket을 통해 MQTT를 사용하는 경우 true로 설정합니다.

cipher

str 또는 list(str)

필수

구성 옵션. TLS/SSL에 대한 암호 그룹, "OpenSSL 암호 목록 형식"의 문자열 또는 암호 그룹 문자열 목록입니다.

product_info

str

필수

구성 옵션. 기본값은 빈 문자열입니다. 문자열에는 사용자 에이전트 문자열에 추가되는 임의의 제품 정보가 포함됩니다.

proxy_options

ProxyOptions

필수

프록시 서버를 통해 트래픽을 보내는 옵션입니다.

keep_alive

int

필수

broker와의 통신 사이의 최대 기간(초)입니다. 다른 메시지가 교환되지 않는 경우 클라이언트가 broker에 ping 메시지를 보내는 속도를 제어합니다. 제공되지 않은 경우 기본값인 60초가 사용됩니다.

auto_connect

bool

필수

연결을 설정해야 하는 메서드가 호출될 때 클라이언트를 IoTHub에 자동으로 연결합니다. (기본값: True)

connection_retry

bool

필수

끊은 연결 다시 설정 시도(기본값: True)

connection_retry_interval

int

필수

끊은 연결을 다시 설정하려는 시도 사이의 간격(초)(기본값: 10)

ensure_desired_properties

bool

필수

다시 연결 시 가장 최근에 원하는 속성 패치가 수신되었는지 확인합니다(기본값:True).

반환

인증에 X509 인증서를 사용하는 IoTHub 클라이언트의 instance.

예외

TypeError if given an unsupported parameter.

disconnect

Azure IoT Hub 또는 Azure IoT Edge Hub instance 클라이언트 연결을 끊습니다.

클라이언트 instance 완전히 완료된 경우 이 함수를 호출하는 것이 좋습니다.

이는 동기 호출이므로 서비스에 대한 연결이 완전히 닫히기 전까지는 이 함수가 반환되지 않습니다.

disconnect()

예외

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

get_twin

Azure IoT Hub 또는 Azure IoT Edge Hub 서비스에서 디바이스 또는 모듈 쌍을 가져옵니다.

이는 동기 호출입니다. 즉, 이 함수는 서비스에서 쌍을 검색할 때까지 반환되지 않습니다.

get_twin()

반환

JSON 받아쓰기로 트윈 완료

반환 형식

dict

예외

CredentialError

자격 증명이 잘못되었으며 연결을 설정할 수 없는 경우

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시도가 시간 초과된 경우

NoConnectionError

클라이언트가 연결되지 않은 경우(자동 연결을 사용하도록 설정되지 않은 경우)

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

invoke_method

클라이언트에서 디바이스 또는 모듈 클라이언트로 메서드를 호출하고 메서드 호출에 대한 응답을 받습니다.

invoke_method(method_params, device_id, module_id=None)

매개 변수

method_params

dict

필수

methodName(str), 페이로드(str), connectTimeoutInSeconds(int), responseTimeoutInSeconds(int)를 포함해야 합니다.

device_id

str

필수

메서드가 호출될 대상 디바이스의 디바이스 ID입니다.

module_id

str

기본값: None

메서드가 호출될 대상 모듈의 모듈 ID입니다. (선택 사항)

반환

method_result 상태 및 페이로드를 포함해야 합니다.

반환 형식

dict

예외

CredentialError

자격 증명이 유효하지 않으며 연결을 설정할 수 없는 경우 입니다.

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시간이 초과되면 입니다.

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

patch_twin_reported_properties

Azure IoT Hub 또는 Azure IoT Edge Hub 서비스를 사용하여 reported 속성을 업데이트합니다.

이는 동기 호출입니다. 즉, 패치가 서비스로 전송되고 승인될 때까지 이 함수가 반환되지 않습니다.

서비스가 패치 작업에 대한 오류를 반환하는 경우 이 함수는 적절한 오류를 발생합니다.

patch_twin_reported_properties(reported_properties_patch)

매개 변수

reported_properties_patch

dict

필수

JSON 받아쓰기로 쌍 Reported 속성 패치

예외

CredentialError

자격 증명이 잘못되었으며 연결을 설정할 수 없는 경우

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시도가 시간 초과된 경우

NoConnectionError

클라이언트가 연결되지 않은 경우(자동 연결을 사용하도록 설정되지 않은 경우)

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

receive_message_on_input

다른 모듈에서 특정 입력으로 전송된 입력 메시지를 수신합니다.

버전 2.3.0 이후 사용되지 않음: 대신 .on_message_received 속성을 사용하여 처리기를 설정하는 것이 좋습니다.

receive_message_on_input(input_name, block=True, timeout=None)

매개 변수

input_name

str

필수

메시지를 받을 입력 이름입니다.

block

bool

필수

메시지가 수신될 때까지 작업을 차단해야 하는지를 나타냅니다.

timeout

int

필수

필요에 따라 차단 시간이 초과될 때까지 몇 초를 제공합니다.

반환

지정된 입력으로 전송된 메시지 또는 차단 기간이 끝날 때까지 메서드 요청을 받지 않은 경우 None입니다.

예외

CredentialError

자격 증명이 유효하지 않으며 연결을 설정할 수 없는 경우 입니다.

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시간이 초과되면 입니다.

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

receive_method_request

Azure IoT Hub 또는 Azure IoT Edge Hub를 통해 메서드 요청을 받습니다.

버전 2.3.0 이후 사용되지 않음: 대신 .on_method_request_received 속성을 사용하여 처리기를 설정하는 것이 좋습니다.

receive_method_request(method_name=None, block=True, timeout=None)

매개 변수

method_name

str

기본값: None

필요에 따라 요청을 받을 메서드의 이름을 제공합니다. 이 매개 변수를 지정하지 않으면 다른 receive_method 요청에 의해 아직 구체적으로 대상으로 지정되지 않은 모든 메서드가 수신됩니다.

block

bool

기본값: True

요청이 수신될 때까지 작업을 차단해야 하는지를 나타냅니다.

timeout

int

기본값: None

필요에 따라 차단 시간이 초과될 때까지 몇 초를 제공합니다.

반환

수신된 메서드 요청을 나타내는 MethodRequest 개체 또는 차단 기간이 끝날 때까지 메서드 요청을 받지 않은 경우 None입니다.

예외

CredentialError

자격 증명이 유효하지 않으며 연결을 설정할 수 없는 경우 입니다.

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시간이 초과되면 입니다.

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

receive_twin_desired_properties_patch

Azure IoT Hub 또는 Azure IoT Edge Hub를 통해 원하는 속성 패치를 받습니다.

동기 호출입니다. 즉, 다음을 의미합니다.

1. block=True이면 다음 중 하나가 발생할 때까지 이 함수가 차단됩니다.

   • 원하는 속성 패치는 Azure IoT Hub 또는 Azure IoT Edge Hub에서 수신됩니다.

   • 제공된 경우 시간 제한 기간이 경과합니다. 시간 제한이 발생하면 이 함수는 받은 편지함임프티 예외를 발생합니다.

2. block=False이면 이 함수는 파이프라인에서 수신했지만 아직 애플리케이션에 반환되지 않은 원하는 속성 패치를 반환합니다. 파이프라인에서 원하는 속성 패치를 수신하지 않은 경우 이 함수는 InboxEmpty 예외를 발생합니다.

버전 2.3.0 이후 사용되지 않음: 대신 .on_twin_desired_properties_patch_received 속성을 사용하여 처리기를 설정하는 것이 좋습니다.

receive_twin_desired_properties_patch(block=True, timeout=None)

매개 변수

block

bool

기본값: True

요청이 수신될 때까지 작업을 차단해야 하는지를 나타냅니다.

timeout

int

기본값: None

필요에 따라 차단 시간이 초과될 때까지 몇 초를 제공합니다.

반환

JSON 받아쓰기로 쌍 Desired 속성 패치 또는 차단 기간이 끝날 때까지 패치가 수신되지 않은 경우 없음

반환 형식

dict,

None

예외

CredentialError

자격 증명이 유효하지 않으며 연결을 설정할 수 없는 경우 입니다.

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시간이 초과되면 입니다.

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

send_message

Azure IoT Hub 또는 Azure IoT Edge Hub instance 기본 이벤트 엔드포인트에 메시지를 보냅니다.

이는 동기 이벤트입니다. 즉, 이 함수는 이벤트가 서비스로 전송되고 서비스에서 이벤트 수신을 승인할 때까지 반환되지 않습니다.

서비스에 대한 연결이 이전에 연결 호출로 열리지 않은 경우 이 함수는 이벤트를 보내기 전에 연결을 엽니다.

send_message(message)

매개 변수

message

Message

필수

보낼 실제 메시지입니다. Message 클래스의 instance 아닌 전달된 모든 항목은 Message 개체로 변환됩니다.

예외

CredentialError

자격 증명이 잘못되었으며 연결을 설정할 수 없는 경우

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시도가 시간 초과된 경우

NoConnectionError

클라이언트가 연결되지 않은 경우(자동 연결을 사용하도록 설정되지 않은 경우)

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

ValueError if the message fails size validation.

send_message_to_output

지정된 모듈 출력에 이벤트/메시지를 보냅니다.

이러한 이벤트는 나가는 이벤트이며 "출력 이벤트"를 의미합니다.

이는 동기 이벤트입니다. 즉, 이 함수는 이벤트가 서비스로 전송되고 서비스에서 이벤트 수신을 승인할 때까지 반환되지 않습니다.

서비스에 대한 연결이 이전에 연결 호출로 열리지 않은 경우 이 함수는 이벤트를 보내기 전에 연결을 엽니다.

send_message_to_output(message, output_name)

매개 변수

message

Message

필수

지정된 출력으로 보낼 메시지입니다. Message 클래스의 instance 아닌 전달된 모든 항목은 Message 개체로 변환됩니다.

output_name

str

필수

이벤트를 보낼 출력의 이름입니다.

예외

CredentialError

자격 증명이 잘못되었으며 연결을 설정할 수 없는 경우

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시도가 시간 초과된 경우

NoConnectionError

클라이언트가 연결되지 않은 경우(자동 연결을 사용하도록 설정되지 않은 경우)

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

ValueError if the message fails size validation.

send_method_response

Azure IoT Hub 또는 Azure IoT Edge Hub를 통해 메서드 요청에 응답을 보냅니다.

이는 동기 이벤트입니다. 즉, 이 함수는 이벤트가 서비스로 전송되고 서비스에서 이벤트 수신을 승인할 때까지 반환되지 않습니다.

서비스에 대한 연결이 이전에 연결 호출로 열리지 않은 경우 이 함수는 이벤트를 보내기 전에 연결을 엽니다.

send_method_response(method_response)

매개 변수

method_response

MethodResponse

필수

보낼 MethodResponse입니다.

예외

CredentialError

자격 증명이 잘못되었으며 연결을 설정할 수 없는 경우

ConnectionFailedError

연결을 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

연결 시도가 시간 초과된 경우

NoConnectionError

클라이언트가 연결되지 않은 경우(자동 연결을 사용하도록 설정되지 않은 경우)

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

shutdown

정상 종료를 위해 클라이언트를 종료합니다.

이 메서드가 호출되면 추가 클라이언트 호출을 시도하면 ClientError가 발생합니다.

shutdown()

예외

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

update_sastoken

인증에 사용되는 클라이언트의 SAS 토큰을 업데이트한 다음 연결을 다시 인증합니다.

이 API는 클라이언트가 처음에 SAS 토큰을 사용하여 만든 경우에만 사용할 수 있습니다.

update_sastoken(sastoken)

매개 변수

sastoken

str

필수

클라이언트에서 사용할 새 SAS 토큰 문자열

예외

ValueError if the sastoken parameter is invalid

CredentialError

자격 증명이 잘못되었으며 연결을 다시 설정할 수 없는 경우

ConnectionFailedError

연결을 다시 설정하면 오류가 발생합니다.

ConnectionDroppedError

실행 중에 연결이 끊어지면 입니다.

OperationTimeout

재인증 시도가 시간 초과되면 입니다.

ClientError

클라이언트가 처음에 SAS 토큰으로 만들어지지 않은 경우 입니다.

ClientError

실행 중에 예기치 않은 오류가 발생하면 입니다.

특성

connected

전송이 연결되어 있는지 여부를 나타내는 읽기 전용 속성입니다.

on_background_exception

처리기 함수 또는 코루틴은 백그라운드 예외가 발생할 때 호출됩니다.

함수 또는 코루틴 정의는 하나의 위치 인수(예외 개체)를 사용해야 합니다.

on_connection_state_change

연결 상태가 변경될 때 호출될 처리기 함수 또는 코루틴입니다.

함수 또는 코루틴 정의는 위치 인수를 사용하지 않아야 합니다.

on_message_received

입력 메시지를 받을 때 호출되는 처리기 함수 또는 코루틴입니다.

함수 정의 또는 코루틴은 하나의 위치 인수(개체)를 Message 사용해야 합니다.

on_method_request_received

메서드 요청을 받을 때 호출될 처리기 함수 또는 코루틴입니다.

클라이언트의 .send_method_response() 메서드를 사용하여 함수 또는 코루틴에서 메서드 요청을 승인해야 합니다.

함수 또는 코루틴 정의는 하나의 위치 인수(개체)를 MethodRequest 사용해야 합니다.

on_new_sastoken_required

클라이언트에 새 SAS 토큰이 필요할 때 호출되는 처리기 함수 또는 코루틴입니다. SAS 토큰이 만료되기 약 2분 전에 발생합니다. Windows 플랫폼에서 수명이 약 49일을 초과하는 경우 SAS 수명에 관계없이 49일 후에 새 토큰이 필요합니다.

이 처리기는 .create_from_sastoken() 메서드를 통해 만든 클라이언트를 사용하는 경우에만 필요합니다.

새 토큰은 클라이언트의 .update_sastoken() 메서드를 사용하여 함수 또는 코루틴에서 제공할 수 있습니다.

함수 또는 코루틴 정의는 위치 인수를 사용하지 않아야 합니다.

on_twin_desired_properties_patch_received

쌍 desired 속성 패치가 수신될 때 호출되는 처리기 함수 또는 코루틴입니다.

함수 또는 코루틴 정의는 하나의 위치 인수(JSON 사전 개체 형식의 트윈 패치)를 사용해야 합니다.