IoTHubRegistryManager 클래스

참조

자동 생성된 IotHub REST API를 기반으로 IoTHub 레지스트리 관리자 작업에 편리한 API를 제공하는 클래스입니다.

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

사용자는 이를 직접 호출해서는 안 됩니다. 대신 from_connection_string() 또는 from_token_credential() 팩터리 메서드를 사용해야 합니다.

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

상속: builtins.object

IoTHubRegistryManager

생성자

IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)

매개 변수

Name	Description
connection_string	str connection_str 인증을 사용하는 경우 IoTHub와의 연결을 인증하는 데 사용되는 IoTHub 연결 문자열입니다. 기본값: 없음 기본값: None
host	str 토큰 자격 증명 인증을 사용하는 경우 Azure 서비스 URL입니다. 기본값: 없음 기본값: None
auth 필수	str 토큰 자격 증명 인증을 사용하는 경우 Azure 인증 개체입니다. 기본값: 없음
token_credential	기본값: None

메서드

bulk_create_or_update_devices	IoTHub ID 레지스트리에서 여러 디바이스의 ID를 만들거나 업데이트하거나 삭제합니다. IoTHub ID 레지스트리에서 여러 디바이스의 ID를 만들거나 업데이트하거나 삭제합니다. 디바이스 ID는 목록에서 한 번만 지정할 수 있습니다. 다른 디바이스에서 다른 작업(만들기, 업데이트, 삭제)이 허용됩니다. 호출당 최대 100대 디바이스를 지정할 수 있습니다. 대규모 작업의 경우 Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities)를 사용하여 가져오기 기능을 사용하는 것이 좋습니다.
create_device_with_certificate_authority	인증 기관을 사용하여 IoTHub에서 디바이스 ID를 만듭니다.
create_device_with_sas	SAS 인증을 사용하여 IoTHub에서 디바이스 ID를 만듭니다.
create_device_with_x509	X509 인증을 사용하여 IoTHub에서 디바이스 ID를 만듭니다.
create_module_with_certificate_authority	인증 기관을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 만듭니다.
create_module_with_sas	SAS 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 만듭니다.
create_module_with_x509	X509 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 만듭니다.
delete_device	IoTHub에서 디바이스 ID를 삭제합니다.
delete_module	IoTHub에서 디바이스에 대한 모듈 ID를 삭제합니다.
from_connection_string	레지스트리 관리자 서비스 클라이언트에 대한 Classmethod 이니셜라이저입니다. 연결 문자열에서 Registry Manager 클래스를 만듭니다. 성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다.
from_token_credential	레지스트리 관리자 서비스 클라이언트에 대한 Classmethod 이니셜라이저입니다. 호스트 이름 URL 및 Azure 토큰 자격 증명에서 Registry Manager 클래스를 만듭니다. 성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다.
get_device	IoTHub에서 디바이스 ID를 검색합니다.
get_device_registry_statistics	IoTHub 디바이스 레지스트리 통계를 검색합니다.
get_devices	IoTHub ID 레지스트리에서 여러 디바이스의 ID를 가져옵니다. 권장되지 않습니다. IoTHub 쿼리 언어를 사용하여 디바이스 쌍 및 디바이스 ID 정보를 검색합니다. 자세한 내용은 https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub 및 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language를 참조하세요.
get_module	IoTHub에서 디바이스에 대한 모듈 ID를 검색합니다.
get_module_twin	모듈 쌍을 가져옵니다.
get_modules	디바이스의 모든 모듈 ID를 검색합니다.
get_service_statistics	IoTHub 서비스 통계를 검색합니다.
get_twin	디바이스 쌍을 가져옵니다.
invoke_device_method	디바이스에서 직접 메서드를 호출합니다.
invoke_device_module_method	디바이스에서 직접 메서드를 호출합니다.
query_iot_hub	IoTHub를 쿼리하여 SQL과 유사한 언어를 사용하여 디바이스 쌍에 대한 정보를 검색합니다. 자세한 내용은 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 을 참조하세요. 결과의 페이지 매김이 지원됩니다. 디바이스 쌍에 대한 정보만 반환합니다.
replace_module_twin	모듈 쌍의 태그 및 원하는 속성을 바꿉니다.
replace_twin	디바이스 쌍의 태그 및 desired 속성을 바꿉니다.
send_c2d_message	IoTHub 디바이스에 C2D 메시지를 보냅니다.
update_device_with_certificate_authority	인증 기관을 사용하여 IoTHub에서 디바이스 ID를 업데이트.
update_device_with_sas	SAS 인증을 사용하여 IoTHub에서 디바이스 ID를 업데이트.
update_device_with_x509	X509 인증을 사용하여 IoTHub에서 디바이스 ID를 업데이트.
update_module_twin	모듈 쌍의 태그 및 원하는 속성을 업데이트.
update_module_with_certificate_authority	인증 기관을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 업데이트.
update_module_with_sas	SAS 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 업데이트.
update_module_with_x509	X509 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 업데이트.
update_twin	디바이스 쌍의 태그 및 원하는 속성을 업데이트.

bulk_create_or_update_devices

IoTHub ID 레지스트리에서 여러 디바이스의 ID를 만들거나 업데이트하거나 삭제합니다.

IoTHub ID 레지스트리에서 여러 디바이스의 ID를 만들거나 업데이트하거나 삭제합니다. 디바이스 ID는 목록에서 한 번만 지정할 수 있습니다. 다른 디바이스에서 다른 작업(만들기, 업데이트, 삭제)이 허용됩니다. 호출당 최대 100대 디바이스를 지정할 수 있습니다. 대규모 작업의 경우 Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities)를 사용하여 가져오기 기능을 사용하는 것이 좋습니다.

bulk_create_or_update_devices(devices)

매개 변수

Name	Description
devices 필수	list[ExportImportDevice] 작동할 디바이스 개체 목록입니다.

반환

형식	Description
	BulkRegistryOperationResult 개체입니다.

예외

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

create_device_with_certificate_authority

인증 기관을 사용하여 IoTHub에서 디바이스 ID를 만듭니다.

create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
status 필수	str 생성된 디바이스의 초기 상태입니다. (가능한 값: "enabled" 또는 "disabled").
iot_edge	bool 생성된 디바이스가 IoT Edge 디바이스인지 여부입니다. 기본값: False 기본값: False
status_reason	str 디바이스 ID의 이유는 상태. 기본값: 없음 기본값: None
device_scope	str 디바이스의 범위입니다. 기본값: 없음 에지 디바이스에 대해 자동 생성 및 변경할 수 없으며 리프 디바이스에서 수정하여 자식/부모 관계를 만듭니다. 리프 디바이스의 경우 부모 에지 디바이스를 설정하는 값은 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 기본값: None
parent_scopes	Union[list[str], str] 해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 기본값: 없음 에지 디바이스의 경우 부모 에지 디바이스를 설정하는 값을 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 리프 디바이스의 경우 이 값을 device_scope 동일한 값으로 설정하거나 서비스가 복사할 수 있도록 남겨둘 수 있습니다. 기본값: None

반환

형식	Description
	생성된 디바이스를 포함하는 디바이스 개체입니다.

예외

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

create_device_with_sas

SAS 인증을 사용하여 IoTHub에서 디바이스 ID를 만듭니다.

create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
primary_key 필수	str 기본 인증 키입니다.
secondary_key 필수	str 보조 인증 키입니다.
status 필수	str 생성된 디바이스의 초기 상태입니다. (가능한 값: "enabled" 또는 "disabled")
iot_edge	bool 생성된 디바이스가 IoT Edge 디바이스인지 여부입니다. 기본값: False 기본값: False
status_reason	str 디바이스 ID의 이유는 상태. 기본값: 없음 기본값: None
device_scope	str 디바이스의 범위입니다. 기본값: 없음 에지 디바이스에 대해 자동 생성 및 변경할 수 없으며 리프 디바이스에서 수정하여 자식/부모 관계를 만듭니다. 리프 디바이스의 경우 부모 에지 디바이스를 설정하는 값은 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 기본값: None
parent_scopes	Union[list[str], str] 해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 기본값: 없음 에지 디바이스의 경우 부모 에지 디바이스를 설정하는 값을 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 리프 디바이스의 경우 이 값을 device_scope 동일한 값으로 설정하거나 서비스가 복사할 수 있도록 남겨둘 수 있습니다. 기본값: None

반환

형식	Description
	생성된 디바이스를 포함하는 디바이스 개체입니다.

예외

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

create_device_with_x509

X509 인증을 사용하여 IoTHub에서 디바이스 ID를 만듭니다.

create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
primary_thumbprint 필수	str 기본 X509 지문.
secondary_thumbprint 필수	str 보조 X509 지문.
status 필수	str 생성된 디바이스의 초기 상태입니다. (가능한 값: "enabled" 또는 "disabled")
iot_edge	bool 생성된 디바이스가 IoT Edge 디바이스인지 여부입니다. 기본값: False 기본값: False
status_reason	str 디바이스 ID의 이유는 상태. 기본값: 없음 기본값: None
device_scope	str 디바이스의 범위입니다. 기본값: 없음 에지 디바이스에 대해 자동 생성 및 변경할 수 없으며 리프 디바이스에서 수정하여 자식/부모 관계를 만듭니다. 리프 디바이스의 경우 부모 에지 디바이스를 설정하는 값은 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 기본값: None
parent_scopes	Union[list[str], str] 해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 기본값: 없음 에지 디바이스의 경우 부모 에지 디바이스를 설정하는 값을 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 리프 디바이스의 경우 이 값을 device_scope 동일한 값으로 설정하거나 서비스가 복사할 수 있도록 남겨둘 수 있습니다. 기본값: None

반환

형식	Description
	생성된 디바이스를 포함하는 디바이스 개체입니다.

예외

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

create_module_with_certificate_authority

인증 기관을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 만듭니다.

create_module_with_certificate_authority(device_id, module_id, managed_by)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
managed_by 필수	str 관리자 디바이스(에지)의 이름입니다.

반환

형식	Description
	만든 모듈을 포함하는 Module 개체입니다.

예외

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

create_module_with_sas

SAS 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 만듭니다.

create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
managed_by 필수	str 관리자 디바이스(에지)의 이름입니다.
primary_key 필수	str 기본 인증 키입니다.
secondary_key 필수	str 보조 인증 키입니다.

반환

형식	Description
	만든 모듈을 포함하는 Module 개체입니다.

예외

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

create_module_with_x509

X509 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 만듭니다.

create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
managed_by 필수	str 관리자 디바이스(에지)의 이름입니다.
primary_thumbprint 필수	str 기본 X509 지문.
secondary_thumbprint 필수	str 보조 X509 지문.

반환

형식	Description
	만든 모듈을 포함하는 Module 개체입니다.

예외

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

delete_device

IoTHub에서 디바이스 ID를 삭제합니다.

delete_device(device_id, etag=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
etag	str 삭제 작업에 사용할 etag(if_match) 값입니다. 기본값: None

반환

형식	Description
	없음

예외

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

delete_module

IoTHub에서 디바이스에 대한 모듈 ID를 삭제합니다.

delete_module(device_id, module_id, etag=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
etag	str 삭제 작업에 사용할 etag(if_match) 값입니다. 기본값: None

반환

형식	Description
	없음

예외

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

from_connection_string

레지스트리 관리자 서비스 클라이언트에 대한 Classmethod 이니셜라이저입니다. 연결 문자열에서 Registry Manager 클래스를 만듭니다.

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

from_connection_string(connection_string)

매개 변수

Name	Description
connection_string 필수	str IoTHub와의 연결을 인증하는 데 사용되는 IoTHub 연결 문자열입니다.

반환

형식	Description
IoTHubRegistryManager

예외

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

from_token_credential

레지스트리 관리자 서비스 클라이언트에 대한 Classmethod 이니셜라이저입니다. 호스트 이름 URL 및 Azure 토큰 자격 증명에서 Registry Manager 클래스를 만듭니다.

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

from_token_credential(url, token_credential)

매개 변수

Name	Description
url 필수	str Azure 서비스 URL(호스트 이름)입니다.
token_credential 필수	<xref:azure.core.TokenCredential> Azure 토큰 자격 증명 개체

반환

형식	Description
IoTHubRegistryManager

예외

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

get_device

IoTHub에서 디바이스 ID를 검색합니다.

get_device(device_id)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.

반환

형식	Description
	요청된 디바이스를 포함하는 Device 개체입니다.

예외

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

get_device_registry_statistics

IoTHub 디바이스 레지스트리 통계를 검색합니다.

get_device_registry_statistics()

반환

형식	Description
	RegistryStatistics 개체입니다.

예외

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

get_devices

IoTHub ID 레지스트리에서 여러 디바이스의 ID를 가져옵니다. 권장되지 않습니다. IoTHub 쿼리 언어를 사용하여 디바이스 쌍 및 디바이스 ID 정보를 검색합니다. 자세한 내용은 https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub 및 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language를 참조하세요.

get_devices(max_number_of_devices=None)

매개 변수

Name	Description
max_number_of_devices	int 지정된 경우 이 매개 변수는 반환되는 최대 디바이스 ID 수를 정의합니다. 1-1000 범위를 벗어난 모든 값은 1000으로 간주됩니다. 기본값: None

반환

형식	Description
	디바이스 정보 목록입니다.

예외

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

get_module

IoTHub에서 디바이스에 대한 모듈 ID를 검색합니다.

get_module(device_id, module_id)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.

반환

형식	Description
	요청된 모듈을 포함하는 Module 개체입니다.

예외

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

get_module_twin

모듈 쌍을 가져옵니다.

get_module_twin(device_id, module_id)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.

반환

형식	Description
	Twin 개체입니다.

예외

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

get_modules

디바이스의 모든 모듈 ID를 검색합니다.

get_modules(device_id)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.

반환

형식	Description
	디바이스의 모든 모듈을 포함하는 목록[모듈]입니다.

예외

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

get_service_statistics

IoTHub 서비스 통계를 검색합니다.

get_service_statistics()

반환

형식	Description
	ServiceStatistics 개체입니다.

예외

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

get_twin

디바이스 쌍을 가져옵니다.

get_twin(device_id)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.

반환

형식	Description
	Twin 개체입니다.

예외

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

invoke_device_method

디바이스에서 직접 메서드를 호출합니다.

invoke_device_method(device_id, direct_method_request)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
direct_method_request 필수	CloudToDeviceMethod 메서드 요청입니다.

반환

형식	Description
	CloudToDeviceMethodResult 개체입니다.

예외

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

invoke_device_module_method

디바이스에서 직접 메서드를 호출합니다.

invoke_device_module_method(device_id, module_id, direct_method_request)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
direct_method_request 필수	CloudToDeviceMethod 메서드 요청입니다.

반환

형식	Description
	CloudToDeviceMethodResult 개체입니다.

예외

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

query_iot_hub

IoTHub를 쿼리하여 SQL과 유사한 언어를 사용하여 디바이스 쌍에 대한 정보를 검색합니다. 자세한 내용은 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 을 참조하세요. 결과의 페이지 매김이 지원됩니다. 디바이스 쌍에 대한 정보만 반환합니다.

query_iot_hub(query_specification, continuation_token=None, max_item_count=None)

매개 변수

Name	Description
query 필수	QuerySpecification 쿼리 사양입니다.
continuation_token	str 페이징을 위한 연속 토큰 기본값: None
max_item_count	str 요청된 디바이스 쌍의 최대 수 기본값: None
query_specification 필수

반환

형식	Description
	QueryResult 개체입니다.

예외

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

replace_module_twin

모듈 쌍의 태그 및 원하는 속성을 바꿉니다.

replace_module_twin(device_id, module_id, module_twin, etag=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
module_twin 필수	Twin 모듈의 쌍 정보입니다.
etag	str 바꾸기 작업에 사용할 etag(if_match) 값입니다. 기본값: None

반환

형식	Description
	Twin 개체입니다.

예외

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

replace_twin

디바이스 쌍의 태그 및 desired 속성을 바꿉니다.

replace_twin(device_id, device_twin, etag=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
device_twin 필수	Twin 디바이스의 쌍 정보입니다.
etag	str 바꾸기 작업에 사용할 etag(if_match) 값입니다. 기본값: None

반환

형식	Description
	Twin 개체입니다.

예외

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

send_c2d_message

IoTHub 디바이스에 C2D 메시지를 보냅니다.

send_c2d_message(device_id, message, properties={})

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
message 필수	str 디바이스에 배달할 메시지입니다.
properties	dict 메시지와 함께 보낼 속성입니다. 애플리케이션 속성 및 시스템 속성을 포함할 수 있습니다. 기본값: {}

예외

형식	Description
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

인증 기관을 사용하여 IoTHub에서 디바이스 ID를 업데이트.

update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
etag 필수	str 업데이트 작업에 사용할 etag(if_match) 값입니다.
status 필수	str 생성된 디바이스의 초기 상태입니다. (가능한 값: "enabled" 또는 "disabled").
iot_edge	bool 생성된 디바이스가 IoT Edge 디바이스인지 여부입니다. 기본값: False 기본값: False
status_reason	str 디바이스 ID가 상태 이유입니다. 기본값: 없음 기본값: None
device_scope	str 디바이스의 범위입니다. 기본값: 에지 디바이스에 대해 자동으로 생성되고 변경할 수 없으며 리프 디바이스에서 수정하여 자식/부모 관계를 만듭니다. 리프 디바이스의 경우 부모 에지 디바이스를 설정하는 값은 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 기본값: None
parent_scopes	Union[list[str], str] 해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 기본값: 없음 에지 디바이스의 경우 부모 에지 디바이스를 설정하는 값은 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 리프 디바이스의 경우 device_scope 동일한 값으로 설정하거나 서비스가 복사할 수 있도록 남겨둘 수 있습니다. 기본값: None

반환

형식	Description
	생성된 디바이스를 포함하는 업데이트된 Device 개체입니다.

예외

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

update_device_with_sas

SAS 인증을 사용하여 IoTHub에서 디바이스 ID를 업데이트.

update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
etag 필수	str 업데이트 작업에 사용할 etag(if_match) 값입니다.
primary_key 필수	str 기본 인증 키.
secondary_key 필수	str 보조 인증 키.
status 필수	str 생성된 디바이스의 초기 상태입니다. (가능한 값: "enabled" 또는 "disabled").
iot_edge	bool 생성된 디바이스가 IoT Edge 디바이스인지 여부입니다. 기본값: False 기본값: False
status_reason	str 디바이스 ID가 상태 이유입니다. 기본값: 없음 기본값: None
device_scope	str 디바이스의 범위입니다. 기본값: 에지 디바이스에 대해 자동으로 생성되고 변경할 수 없으며 리프 디바이스에서 수정하여 자식/부모 관계를 만듭니다. 리프 디바이스의 경우 부모 에지 디바이스를 설정하는 값은 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 기본값: None
parent_scopes	Union[list[str], str] 해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 기본값: 없음 에지 디바이스의 경우 부모 에지 디바이스를 설정하는 값을 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 리프 디바이스의 경우 이 값을 device_scope 동일한 값으로 설정하거나 서비스가 복사할 수 있도록 남겨둘 수 있습니다. 기본값: None

반환

형식	Description
	생성된 디바이스를 포함하는 업데이트된 Device 개체입니다.

예외

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

update_device_with_x509

X509 인증을 사용하여 IoTHub에서 디바이스 ID를 업데이트.

update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
etag 필수	str 업데이트 작업에 사용할 etag(if_match) 값입니다.
primary_thumbprint 필수	str 기본 X509 지문.
secondary_thumbprint 필수	str 보조 X509 지문.
status 필수	str 생성된 디바이스의 초기 상태입니다. (가능한 값: "enabled" 또는 "disabled").
iot_edge	bool 생성된 디바이스가 IoT Edge 디바이스인지 여부입니다. 기본값: False 기본값: False
status_reason	str 디바이스 ID의 이유는 상태. 기본값: 없음 기본값: None
device_scope	str 디바이스의 범위입니다. 기본값: 없음 에지 디바이스에 대해 자동 생성 및 변경할 수 없으며 리프 디바이스에서 수정하여 자식/부모 관계를 만듭니다. 리프 디바이스의 경우 부모 에지 디바이스를 설정하는 값은 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 기본값: None
parent_scopes	Union[list[str], str] 해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 기본값: 없음 에지 디바이스의 경우 부모 에지 디바이스를 설정하는 값을 부모 에지 디바이스의 device_scope 속성에서 검색할 수 있습니다. 리프 디바이스의 경우 이 값을 device_scope 동일한 값으로 설정하거나 서비스가 복사할 수 있도록 남겨둘 수 있습니다. 기본값: None

반환

형식	Description
	생성된 디바이스를 포함하는 업데이트된 Device 개체입니다.

예외

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

update_module_twin

모듈 쌍의 태그 및 원하는 속성을 업데이트.

update_module_twin(device_id, module_id, module_twin, etag=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
module_twin 필수	Twin 모듈의 쌍 정보입니다.
etag	str 업데이트 작업에 사용할 etag(if_match) 값입니다. 기본값: None

반환

형식	Description
	Twin 개체입니다.

예외

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

update_module_with_certificate_authority

인증 기관을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 업데이트.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
managed_by 필수	str 관리자 디바이스(에지)의 이름입니다.
etag 필수	str 업데이트 작업에 사용할 etag(if_match) 값입니다.

반환

형식	Description
	생성된 모듈을 포함하는 업데이트된 Module 개체입니다.

예외

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

update_module_with_sas

SAS 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 업데이트.

update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
managed_by 필수	str 관리자 디바이스(에지)의 이름입니다.
etag 필수	str 업데이트 작업에 사용할 etag(if_match) 값입니다.
primary_key 필수	str 기본 인증 키입니다.
secondary_key 필수	str 보조 인증 키입니다.

반환

형식	Description
	생성된 모듈을 포함하는 업데이트된 Module 개체입니다.

예외

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

update_module_with_x509

X509 인증을 사용하여 IoTHub의 디바이스에 대한 모듈 ID를 업데이트.

update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
module_id 필수	str 모듈의 이름(ID)입니다.
managed_by 필수	str 관리자 디바이스(에지)의 이름입니다.
etag 필수	str 업데이트 작업에 사용할 etag(if_match) 값입니다.
primary_thumbprint 필수	str 기본 X509 지문.
secondary_thumbprint 필수	str 보조 X509 지문.

반환

형식	Description
	생성된 모듈을 포함하는 업데이트된 Module 개체입니다.

예외

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

update_twin

디바이스 쌍의 태그 및 원하는 속성을 업데이트.

update_twin(device_id, device_twin, etag=None)

매개 변수

Name	Description
device_id 필수	str 디바이스의 이름(ID)입니다.
device_twin 필수	Twin 디바이스의 쌍 정보입니다.
etag	str 업데이트 작업에 사용할 etag(if_match) 값입니다. 기본값: None

반환

형식	Description
	Twin 개체입니다.

예외

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

다음을 통해 공유

IoTHubRegistryManager 클래스

생성자

매개 변수

메서드

bulk_create_or_update_devices

매개 변수

반환

예외

create_device_with_certificate_authority

매개 변수

반환

예외

create_device_with_sas

매개 변수

반환

예외

create_device_with_x509

매개 변수

반환

예외

create_module_with_certificate_authority

매개 변수

반환

예외

create_module_with_sas

매개 변수

반환

예외

create_module_with_x509

매개 변수

반환

예외

delete_device

매개 변수

반환

예외

delete_module

매개 변수

반환

예외

from_connection_string

매개 변수

반환

예외

from_token_credential

매개 변수

반환

예외

get_device

매개 변수

반환

예외

get_device_registry_statistics

반환

예외

get_devices

매개 변수

반환

예외

get_module

매개 변수

반환

예외

get_module_twin

매개 변수

반환

예외

get_modules

매개 변수

반환

예외

get_service_statistics

반환

예외

get_twin

매개 변수

반환

예외

invoke_device_method