共用方式為

IoTHubRegistryManager 類別

  • 參考

提供 IoTHub 登錄管理員作業便利 API 的類別，根據自動產生的 IotHub REST API

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

使用者不應該直接呼叫此專案。 相反地，它們應該from_connection_string () 或 from_token_credential () Factory 方法。

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

繼承
builtins.object
IoTHubRegistryManager

建構函式

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

參數

名稱 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 身分識別登錄建立、更新或刪除多個裝置的身分識別。

從 IoTHub 身分識別登錄建立、更新或刪除多個裝置的身分識別。 在清單中只能指定一次裝置身分識別。 允許不同的作業 (在不同裝置上建立、更新、刪除) 。 每個調用最多可以指定 100 部裝置。 針對大規模的作業，請考慮使用使用 Blob 儲存體 () https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities 匯入功能。
create_device_with_certificate_authority

使用憑證授權單位單位在 IoTHub 上建立裝置身分識別。
create_device_with_sas

使用 SAS 驗證在 IoTHub 上建立裝置身分識別。
create_device_with_x509

使用 X509 驗證在 IoTHub 上建立裝置身分識別。
create_module_with_certificate_authority

使用憑證授權單位單位為 IoTHub 上的裝置建立模組身分識別。
create_module_with_sas

使用 SAS 驗證為 IoTHub 上的裝置建立模組身分識別。
create_module_with_x509

使用 X509 驗證為 IoTHub 上的裝置建立模組身分識別。
delete_device

從 IoTHub 刪除裝置身分識別。
delete_module

從 IoTHub 刪除裝置的模組身分識別。
from_connection_string

Registry Manager 服務用戶端的 Classmethod 初始化運算式。 從連接字串建立 Registry Manager 類別。

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

Registry Manager 服務用戶端的 Classmethod 初始化運算式。 從主機名稱 URL 和 Azure 權杖認證建立 Registry Manager 類別。

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

從 IoTHub 擷取裝置身分識別。
get_device_registry_statistics

擷取 IoTHub 裝置登錄統計資料。
get_devices

從 IoTHub 身分識別登錄取得多個裝置的身分識別。 不建議使用。 使用 IoTHub 查詢語言來擷取裝置對應項和裝置身分識別資訊。 如需詳細資訊，請參閱 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 擷取裝置的模組身分識別。
get_module_twin

取得模組對應項。
get_modules

擷取裝置上的所有模組身分識別。
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

取代裝置對應項的標記和所需屬性。
send_c2d_message

將 C2D 訊息傳送至 IoTHub 裝置。
update_device_with_certificate_authority

使用憑證授權單位單位在 IoTHub 上更新裝置身分識別。
update_device_with_sas

使用 SAS 驗證在 IoTHub 上更新裝置身分識別。
update_device_with_x509

更新使用 X509 驗證在 IoTHub 上的裝置身分識別。
update_module_twin

更新模組對應項的標記和所需屬性。
update_module_with_certificate_authority

更新使用憑證授權單位單位在 IoTHub 上裝置的模組身分識別。
update_module_with_sas

使用 SAS 驗證更新 IoTHub 上裝置的模組身分識別。
update_module_with_x509

更新使用 X509 驗證在 IoTHub 上裝置的模組身分識別。
update_twin

更新裝置對應項的標記和所需屬性。

bulk_create_or_update_devices

從 IoTHub 身分識別登錄建立、更新或刪除多個裝置的身分識別。

從 IoTHub 身分識別登錄建立、更新或刪除多個裝置的身分識別。 在清單中只能指定一次裝置身分識別。 允許不同的作業 (在不同裝置上建立、更新、刪除) 。 每個調用最多可以指定 100 部裝置。 針對大規模的作業，請考慮使用使用 Blob 儲存體 () https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities 匯入功能。

bulk_create_or_update_devices(devices)

參數

名稱 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 上建立裝置身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
status
必要
str

已建立裝置的初始狀態。 (可能的值：「enabled」 或 「disabled」) 。
iot_edge
bool

建立的裝置是否為IoT Edge裝置。 預設值：False

預設值: False
status_reason
str

裝置身分識別狀態的原因。 預設值：無

預設值: 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 上建立裝置身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
primary_key
必要
str

主要驗證金鑰。
secondary_key
必要
str

次要驗證金鑰。
status
必要
str

已建立裝置的初始狀態。 (可能的值：「enabled」 或 「disabled」)

iot_edge
bool

建立的裝置是否為IoT Edge裝置。 預設值：False

預設值: False
status_reason
str

裝置身分識別狀態的原因。 預設值：無

預設值: 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 上建立裝置身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
primary_thumbprint
必要
str

主要 X509 指紋。
secondary_thumbprint
必要
str

次要 X509 指紋。
status
必要
str

已建立裝置的初始狀態。 (可能的值：「enabled」 或 「disabled」)

iot_edge
bool

建立的裝置是否為IoT Edge裝置。 預設值：False

預設值: False
status_reason
str

裝置身分識別狀態的原因。 預設值：無

預設值: 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 上的裝置建立模組身分識別。

create_module_with_certificate_authority(device_id, module_id, managed_by)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
managed_by
必要
str

(邊緣) 管理員裝置的名稱。

傳回

類型 Description

包含已建立模組的 Module 物件。

例外狀況

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

create_module_with_sas

使用 SAS 驗證為 IoTHub 上的裝置建立模組身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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 上的裝置建立模組身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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 刪除裝置身分識別。

delete_device(device_id, etag=None)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
etag
str

要用於刪除作業的 etag (if_match) 值。

預設值: None

傳回

類型 Description

無。

例外狀況

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

delete_module

從 IoTHub 刪除裝置的模組身分識別。

delete_module(device_id, module_id, etag=None)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
etag
str

要用於刪除作業的 etag (if_match) 值。

預設值: None

傳回

類型 Description

無。

例外狀況

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

from_connection_string

Registry Manager 服務用戶端的 Classmethod 初始化運算式。 從連接字串建立 Registry Manager 類別。

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

from_connection_string(connection_string)

參數

名稱 Description
connection_string
必要
str

用來驗證與 IoTHub 連線的 IoTHub 連接字串。

傳回

類型 Description
IoTHubRegistryManager

例外狀況

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

from_token_credential

Registry Manager 服務用戶端的 Classmethod 初始化運算式。 從主機名稱 URL 和 Azure 權杖認證建立 Registry Manager 類別。

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

from_token_credential(url, token_credential)

參數

名稱 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 擷取裝置身分識別。

get_device(device_id)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。

傳回

類型 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 身分識別登錄取得多個裝置的身分識別。 不建議使用。 使用 IoTHub 查詢語言來擷取裝置對應項和裝置身分識別資訊。 如需詳細資訊，請參閱 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)

參數

名稱 Description
max_number_of_devices
int

指定此參數時，會定義傳回的裝置身分識別數目上限。 超出 1-1000 範圍的任何值都會被視為 1000

預設值: None

傳回

類型 Description

裝置資訊的清單。

例外狀況

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

get_module

從 IoTHub 擷取裝置的模組身分識別。

get_module(device_id, module_id)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。

傳回

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。

傳回

類型 Description

Twin 物件。

例外狀況

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

get_modules

擷取裝置上的所有模組身分識別。

get_modules(device_id)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。

傳回

類型 Description

list[Module] 包含裝置上所有模組。

例外狀況

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。

傳回

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
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)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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)

參數

名稱 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)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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

取代裝置對應項的標記和所需屬性。

replace_twin(device_id, device_twin, etag=None)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
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

將 C2D 訊息傳送至 IoTHub 裝置。

send_c2d_message(device_id, message, properties={})

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
message
必要
str

要傳遞至裝置的訊息。
properties
dict

要與訊息一起傳送的屬性。 可以包含應用程式屬性和系統屬性

預設值: {}

例外狀況

類型 Description
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

使用憑證授權單位單位在 IoTHub 上更新裝置身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
etag
必要
str

要用於更新作業的 etag (if_match) 值。
status
必要
str

已建立裝置的初始狀態。 (可能的值：「enabled」 或 「disabled」) 。
iot_edge
bool

建立的裝置是否為IoT Edge裝置。 預設值：False

預設值: False
status_reason
str

裝置身分識別狀態的原因。 預設值：無

預設值: 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 上更新裝置身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
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

裝置身分識別狀態的原因。 預設值：無

預設值: 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 上的裝置身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
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

裝置身分識別狀態的原因。 預設值：無

預設值: 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)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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 上裝置的模組身分識別。

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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 上裝置的模組身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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 上裝置的模組身分識別。

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

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
module_id
必要
str

模組的名稱 (識別碼) 。
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)

參數

名稱 Description
device_id
必要
str

裝置的名稱 (識別碼) 。
device_twin
必要
Twin

裝置的對應項資訊。
etag
str

要用於更新作業的 etag (if_match) 值。

預設值: None

傳回

類型 Description

Twin 物件。

例外狀況

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