IoTHubConfigurationManager 類別

根據自動產生的 IotHub REST API，為 IoTHub Configuration Manager作業提供便利 API 的類別

Configuration Manager服務用戶端的初始化運算式。

成功建立類別之後，已向 IoTHub 進行驗證，並已準備好呼叫成員 API 以與 IoTHub 通訊。

繼承

builtins.object

IoTHubConfigurationManager

建構函式

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

參數

名稱	Description
connection_string	str 如果使用connection_str驗證，則用來驗證與 IoTHub 連線的 IoTHub 連接字串。 預設值：無 預設值: None
host	str 如果我們使用權杖認證驗證，則為 Azure 服務 URL。 預設值：無 預設值: None
auth	str 如果使用權杖認證驗證，則為 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 裝置或模組的設定。 注意：使用者無法更新設定識別碼和內容。

apply_configuration_on_edge_device

將提供的組態內容套用至指定的邊緣裝置。 模組內容是必要的。

apply_configuration_on_edge_device(device_id, configuration_content)

參數

名稱	Description
configuration_content 必要	ConfigurationContent 邊緣裝置的名稱 (識別碼) 。
device_id 必要

傳回

類型	Description
	物件。

例外狀況

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

create_configuration

建立 IoTHub 裝置或模組的組態。

create_configuration(configuration)

參數

名稱	Description
configuration_id 必要	str 組態的識別碼。
configuration 必要	Configuration 要建立的組態。

傳回

類型	Description
	包含所建立組態的組態物件。

例外狀況

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

delete_configuration

從 IoTHub 刪除設定。

delete_configuration(configuration_id, etag=None)

參數

名稱	Description
configuration_id 必要	str 組態的識別碼。
configuration 必要	Configuration 要建立的組態。
etag	str 要用於刪除作業的 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)

參數

名稱	Description
connection_string 必要	str 用來向 IoTHub 驗證連線的 IoTHub 連接字串。

傳回

類型	Description
IoTHubConfigurationManager

例外狀況

類型	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)

參數

名稱	Description
url 必要	str Azure 服務 URL (主機名稱) 。
token_credential 必要	<xref:azure.core.TokenCredential> Azure 權杖認證物件

傳回

類型	Description
IoTHubConfigurationManager

例外狀況

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

get_configuration

擷取特定裝置的 IoTHub 組態。

get_configuration(configuration_id)

參數

名稱	Description
configuration_id 必要	str 組態的識別碼。

傳回

類型	Description
	Configuration 物件。

例外狀況

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

get_configurations

擷取 IoTHub 裝置和模組的多個設定。 傳回指定的組態數目。 不支援分頁。

get_configurations(max_count=None)

參數

名稱	Description
max_count	int 要求的組態數目上限。 預設值: 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)

參數

名稱	Description
configuration_queries_test_input 必要	ConfigurationQueriesTestInput 查詢測試輸入。

傳回

類型	Description
	ConfigurationQueriesTestResponse 物件。

例外狀況

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

update_configuration

更新 IoTHub 裝置或模組的設定。 注意：使用者無法更新設定識別碼和內容。

update_configuration(configuration, etag)

參數

名稱	Description
configuration_id 必要	str 組態的識別碼。
configuration 必要	Configuration 組態包含更新的組態。
etag 必要	str 要用於更新作業的 etag (if_match) 值。

傳回

類型	Description
	包含更新組態的組態物件。

例外狀況

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