ProvisioningDeviceClient 클래스

대칭 키 또는 X509 인증을 사용하여 프로비저닝 서비스를 사용하여 디바이스 등록을 실행하는 데 사용할 수 있는 클라이언트입니다.

프로비저닝 클라이언트를 초기화합니다.

참고: 이 이니셜라이저는 직접 호출해서는 안 됩니다. 대신 create_from_ 시작하는 클래스 메서드를 사용하여 클라이언트 개체를 만들어야 합니다.

상속

azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

생성자

ProvisioningDeviceClient(pipeline)

매개 변수

Name	Description
pipeline 필수	<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline> 프로비저닝 파이프라인 개체의 인스턴스입니다.

메서드

create_from_symmetric_key	대칭 키 인증을 사용하여 프로비저닝 서비스를 사용하여 디바이스 등록을 실행하는 데 사용할 수 있는 클라이언트를 만듭니다.
create_from_x509_certificate	X509 인증서 인증을 사용하여 프로비저닝 서비스를 사용하여 디바이스 등록을 실행하는 데 사용할 수 있는 클라이언트를 만듭니다.
register	프로비저닝 서비스에 디바이스 등록 이는 동기 호출입니다. 즉, 등록 프로세스가 성공적으로 완료되거나 시도가 실패할 때까지 이 함수가 반환되지 않습니다. 반환하기 전에 클라이언트는 프로비저닝 서비스에서도 연결을 끊습니다. 이전 등록이 진행 중인 동안 등록을 시도하면 오류가 발생할 수 있습니다. 디바이스가 성공적으로 등록되면 클라이언트는 더 이상 작동할 수 없습니다.

create_from_symmetric_key

대칭 키 인증을 사용하여 프로비저닝 서비스를 사용하여 디바이스 등록을 실행하는 데 사용할 수 있는 클라이언트를 만듭니다.

create_from_symmetric_key(provisioning_host, registration_id, id_scope, symmetric_key, **kwargs)

매개 변수

Name	Description
provisioning_host 필수	str Device Provisioning Service를 실행하는 호스트입니다. 개요 탭의 Azure Portal 전역 디바이스 엔드포인트 문자열로 찾을 수 있습니다.
registration_id 필수	str Device Provisioning Service에서 디바이스를 고유하게 식별하는 데 사용되는 등록 ID입니다. 등록 ID는 영숫자 소문자 문자열이며 하이픈을 포함할 수 있습니다.
id_scope 필수	str ID scope 디바이스가 등록할 특정 프로비저닝 서비스를 고유하게 식별하는 데 사용됩니다. ID scope 사용자가 생성하고 서비스에서 생성하고 변경할 수 없는 경우 Device Provisioning Service에 할당되어 고유성을 보장합니다.
symmetric_key 필수	str Device Provisioning Service를 사용하여 디바이스를 인증하기 위해 공유 액세스 서명 토큰을 만드는 데 사용할 키입니다. 기본적으로 Device Provisioning Service는 키 자동 생성 옵션을 활성화한 상태에서 새 등록을 저장하면 기본 길이가 32바이트인 새 대칭 키를 만듭니다. 사용자는 16바이트 및 64바이트 내에서 유효한 Base64 형식으로 이 옵션을 사용하지 않도록 설정하여 등록을 위한 고유한 대칭 키를 제공할 수 있습니다.
server_verification_cert 필수	str 구성 옵션. 신뢰할 수 있는 인증서 체인입니다. 프로토콜 게이트웨이와 같이 비표준 신뢰 루트가 있는 엔드포인트에 연결을 사용할 때 필요합니다.
gateway_hostname 필수	str 구성 옵션. 게이트웨이 디바이스의 게이트웨이 호스트 이름입니다.
websockets 필수	bool 구성 옵션. 기본값은 False입니다. websocket을 통해 MQTT를 사용하는 경우 true로 설정합니다.
cipher 필수	str 또는 list(str) 구성 옵션. TLS/SSL에 대한 암호 그룹, "OpenSSL 암호 목록 형식"의 문자열 또는 암호 그룹 문자열 목록입니다.
proxy_options 필수	ProxyOptions 프록시 서버를 통해 트래픽을 보내는 옵션입니다.
keepalive 필수	int broker와의 통신 사이의 최대 기간(초)입니다. 다른 메시지가 교환되지 않는 경우 클라이언트가 broker에 ping 메시지를 보내는 속도를 제어합니다. 제공되지 않은 경우 기본값인 60초가 사용됩니다.

반환

형식	Description
	대칭 키를 통해 등록할 수 있는 ProvisioningDeviceClient instance.

예외

형식	Description
TypeError if given an unrecognized parameter.

create_from_x509_certificate

X509 인증서 인증을 사용하여 프로비저닝 서비스를 사용하여 디바이스 등록을 실행하는 데 사용할 수 있는 클라이언트를 만듭니다.

create_from_x509_certificate(provisioning_host, registration_id, id_scope, x509, **kwargs)

매개 변수

Name	Description
provisioning_host 필수	str Device Provisioning Service를 실행하는 호스트입니다. 개요 탭의 Azure Portal 전역 디바이스 엔드포인트 문자열로 찾을 수 있습니다.
registration_id 필수	str Device Provisioning Service에서 디바이스를 고유하게 식별하는 데 사용되는 등록 ID입니다. 등록 ID는 영숫자 소문자 문자열이며 하이픈을 포함할 수 있습니다.
id_scope 필수	str ID scope 디바이스가 등록할 특정 프로비저닝 서비스를 고유하게 식별하는 데 사용됩니다. ID scope 사용자가 생성하고 서비스에서 생성하고 변경할 수 없는 경우 Device Provisioning Service에 할당되어 고유성을 보장합니다.
x509 필수	X509 x509 인증서, 인증서를 사용하려면 등록 개체에 인증서(루트 인증서 또는 중간 CA 인증서 중 하나)를 포함해야 합니다. 인증서가 CER 파일에서 가져온 경우 base64로 인코딩되어야 합니다.
server_verification_cert 필수	str 구성 옵션. 신뢰할 수 있는 인증서 체인입니다. 프로토콜 게이트웨이와 같이 비표준 신뢰 루트가 있는 엔드포인트에 연결을 사용할 때 필요합니다.
gateway_hostname 필수	str 구성 옵션. 게이트웨이 디바이스의 게이트웨이 호스트 이름입니다.
websockets 필수	bool 구성 옵션. 기본값은 False입니다. websocket을 통해 MQTT를 사용하는 경우 true로 설정합니다.
cipher 필수	str 또는 list(str) 구성 옵션. TLS/SSL에 대한 암호 그룹, "OpenSSL 암호 목록 형식"의 문자열 또는 암호 그룹 문자열 목록입니다.
proxy_options 필수	ProxyOptions 프록시 서버를 통해 트래픽을 보내는 옵션입니다.
keepalive 필수	int broker와의 통신 사이의 최대 기간(초)입니다. 다른 메시지가 교환되지 않는 경우 클라이언트가 broker에 ping 메시지를 보내는 속도를 제어합니다. 제공되지 않은 경우 기본값인 60초가 사용됩니다.

반환

형식	Description
	X509 클라이언트 인증서를 통해 등록할 수 있는 ProvisioningDeviceClient입니다.

예외

형식	Description
TypeError if given an unrecognized parameter.

register

프로비저닝 서비스에 디바이스 등록

이는 동기 호출입니다. 즉, 등록 프로세스가 성공적으로 완료되거나 시도가 실패할 때까지 이 함수가 반환되지 않습니다. 반환하기 전에 클라이언트는 프로비저닝 서비스에서도 연결을 끊습니다. 이전 등록이 진행 중인 동안 등록을 시도하면 오류가 발생할 수 있습니다.

디바이스가 성공적으로 등록되면 클라이언트는 더 이상 작동할 수 없습니다.

register()

반환

형식	Description
RegistrationResult	등록 결과를 나타내는 RegistrationResult입니다.

예외

형식	Description
CredentialError	자격 증명이 잘못되었으며 연결을 설정할 수 없는 경우
ConnectionFailedError	연결을 설정하면 오류가 발생합니다.
ConnectionDroppedError	실행 중에 연결이 끊어지면 입니다.
OperationTimeout	연결 시간이 초과되면 입니다.
ClientError	실행 중에 예기치 않은 오류가 발생하면 입니다.

특성

provisioning_payload