IoTHubConfigurationManager 클래스
자동 생성된 IotHub REST API를 기반으로 IoTHub Configuration Manager 작업에 편리한 API를 제공하는 클래스
Configuration Manager Service 클라이언트에 대한 이니셜라이저입니다.
성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다.
- 상속
-
builtins.objectIoTHubConfigurationManager
생성자
IoTHubConfigurationManager(connection_string=None, host=None, auth=None)
매개 변수
Name | Description |
---|---|
connection_string
|
connection_str 인증을 사용하는 경우 IoTHub와의 연결을 인증하는 데 사용되는 IoTHub 연결 문자열입니다. 기본값: 없음 기본값: None
|
host
|
토큰 자격 증명 인증을 사용하는 경우 Azure 서비스 URL입니다. 기본값: 없음 기본값: None
|
auth
|
토큰 자격 증명 인증을 사용하는 경우 Azure 인증 개체입니다. 기본값: 없음 기본값: None
|
메서드
apply_configuration_on_edge_device |
제공된 구성 콘텐츠를 지정된 에지 디바이스에 적용합니다. 모듈 콘텐츠는 필수입니다. |
create_configuration |
IoTHub의 디바이스 또는 모듈에 대한 구성을 만듭니다. |
delete_configuration |
IoTHub에서 구성을 삭제합니다. |
from_connection_string |
IoTHubConfigurationManager Service 클라이언트에 대한 Classmethod 이니셜라이저입니다. 연결 문자열에서 IoTHubConfigurationManager 클래스를 만듭니다. 성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다. |
from_token_credential |
IoTHubConfigurationManager Service 클라이언트에 대한 Classmethod 이니셜라이저입니다. 호스트 이름 URL 및 Azure 토큰 자격 증명에서 IoTHubConfigurationManager 클래스를 만듭니다. 성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다. |
get_configuration |
특정 디바이스에 대한 IoTHub 구성을 검색합니다. |
get_configurations |
IoTHub의 디바이스 및 모듈에 대한 여러 구성을 검색합니다. 지정된 수의 구성을 반환합니다. 페이지 매김은 지원되지 않습니다. |
test_configuration_queries |
구성에 대한 대상 조건 쿼리 및 사용자 지정 메트릭 쿼리의 유효성을 검사합니다. |
update_configuration |
IoTHub의 디바이스 또는 모듈에 대한 구성을 업데이트. 참고: 사용자가 구성 ID 및 콘텐츠를 업데이트할 수 없습니다. |
apply_configuration_on_edge_device
제공된 구성 콘텐츠를 지정된 에지 디바이스에 적용합니다. 모듈 콘텐츠는 필수입니다.
apply_configuration_on_edge_device(device_id, configuration_content)
매개 변수
Name | Description |
---|---|
configuration_content
필수
|
에지 디바이스의 이름(ID)입니다. |
device_id
필수
|
|
반환
형식 | Description |
---|---|
개체입니다. |
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_configuration
IoTHub의 디바이스 또는 모듈에 대한 구성을 만듭니다.
create_configuration(configuration)
매개 변수
Name | Description |
---|---|
configuration_id
필수
|
구성의 ID입니다. |
configuration
필수
|
만들 구성입니다. |
반환
형식 | Description |
---|---|
만든 구성을 포함하는 구성 개체입니다. |
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_configuration
IoTHub에서 구성을 삭제합니다.
delete_configuration(configuration_id, etag=None)
매개 변수
Name | Description |
---|---|
configuration_id
필수
|
구성의 ID입니다. |
configuration
필수
|
만들 구성입니다. |
etag
|
삭제 작업에 사용할 etag(if_match) 값입니다. 기본값: None
|
반환
형식 | Description |
---|---|
업데이트된 구성을 포함하는 구성 개체입니다. |
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_connection_string
IoTHubConfigurationManager Service 클라이언트에 대한 Classmethod 이니셜라이저입니다. 연결 문자열에서 IoTHubConfigurationManager 클래스를 만듭니다.
성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다.
from_connection_string(connection_string)
매개 변수
Name | Description |
---|---|
connection_string
필수
|
IoTHub와의 연결을 인증하는 데 사용되는 IoTHub 연결 문자열입니다. |
반환
형식 | Description |
---|---|
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_token_credential
IoTHubConfigurationManager Service 클라이언트에 대한 Classmethod 이니셜라이저입니다. 호스트 이름 URL 및 Azure 토큰 자격 증명에서 IoTHubConfigurationManager 클래스를 만듭니다.
성공적으로 만든 후 클래스는 IoTHub로 인증되었으며 멤버 API를 호출하여 IoTHub와 통신할 준비가 되었습니다.
from_token_credential(url, token_credential)
매개 변수
Name | Description |
---|---|
url
필수
|
Azure 서비스 URL(호스트 이름)입니다. |
token_credential
필수
|
<xref:azure.core.TokenCredential>
Azure 토큰 자격 증명 개체 |
반환
형식 | Description |
---|---|
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_configuration
특정 디바이스에 대한 IoTHub 구성을 검색합니다.
get_configuration(configuration_id)
매개 변수
Name | Description |
---|---|
configuration_id
필수
|
구성의 ID입니다. |
반환
형식 | Description |
---|---|
Configuration 개체입니다. |
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_configurations
IoTHub의 디바이스 및 모듈에 대한 여러 구성을 검색합니다. 지정된 수의 구성을 반환합니다. 페이지 매김은 지원되지 않습니다.
get_configurations(max_count=None)
매개 변수
Name | Description |
---|---|
max_count
|
요청된 최대 구성 수입니다. 기본값: None
|
반환
형식 | Description |
---|---|
list[Configuration] 개체입니다. |
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
test_configuration_queries
구성에 대한 대상 조건 쿼리 및 사용자 지정 메트릭 쿼리의 유효성을 검사합니다.
test_configuration_queries(configuration_queries_test_input)
매개 변수
Name | Description |
---|---|
configuration_queries_test_input
필수
|
쿼리는 입력을 테스트합니다. |
반환
형식 | Description |
---|---|
ConfigurationQueriesTestResponse 개체입니다. |
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_configuration
IoTHub의 디바이스 또는 모듈에 대한 구성을 업데이트. 참고: 사용자가 구성 ID 및 콘텐츠를 업데이트할 수 없습니다.
update_configuration(configuration, etag)
매개 변수
Name | Description |
---|---|
configuration_id
필수
|
구성의 ID입니다. |
configuration
필수
|
구성에는 업데이트된 구성이 포함됩니다. |
etag
필수
|
업데이트 작업에 사용할 etag(if_match) 값입니다. |
반환
형식 | Description |
---|---|
업데이트된 구성을 포함하는 구성 개체입니다. |
예외
형식 | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python