az iot hub module-identity

注意

此參考是 Azure CLI (2.30.0 版或更高版本) 的 azure-iot 擴充功能的一部分。 當您第一次執行 az iot hub module-identity 命令時,擴充功能會自動安裝。 深入了解延伸模組。

管理 IoT 裝置模組。

命令

az iot hub module-identity connection-string

管理 IoT 裝置模組的連接字串。

az iot hub module-identity connection-string show

顯示目標 IoT 裝置模組連接字串。

az iot hub module-identity create

在IoT 中樞中,在目標 IoT 裝置上建立模組。

az iot hub module-identity delete

刪除IoT 中樞中的裝置。

az iot hub module-identity list

列出位於IoT 中樞 IoT 裝置上的模組。

az iot hub module-identity renew-key

使用 sas 驗證更新IoT 中樞裝置模組的目標金鑰。

az iot hub module-identity show

取得IoT 中樞中 IoT 裝置模組的詳細資料。

az iot hub module-identity update

更新IoT 中樞裝置模組。

az iot hub module-identity create

在IoT 中樞中,在目標 IoT 裝置上建立模組。

使用shared_private_key (也稱為對稱金鑰) 的驗證方法時,如果沒有提供任何自訂金鑰,服務就會為模組產生它們。

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

必要參數

--device-id -d

目標裝置識別碼。

--module-id -m

目的模組識別碼。

選擇性參數

--am --auth-method

要用來建立實體的授權方法。

接受的值: shared_private_key, x509_ca, x509_thumbprint
預設值: shared_private_key
--auth-type

指出作業是否應該自動衍生原則金鑰,或使用目前的 Azure AD 會話。 您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
預設值: key
--hub-name -n

IoT 中樞名稱。 如果未提供 --login,則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 用來避免透過 「az login」 的會話登入。 如果同時提供實體連接字串和名稱,則連接字串會優先使用。 如果未提供 --hub-name,則為必要專案。

--od --output-dir

產生自我簽署憑證,並使用其指紋。 輸出至指定的目標目錄。

--pk --primary-key

以 base64 格式儲存的主要對稱共用存取金鑰。

--primary-thumbprint --ptp

用於主要指紋的自我簽署憑證指紋。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--secondary-key --sk

以 base64 格式儲存的次要對稱共用存取金鑰。

--secondary-thumbprint --stp

用於次要指紋的自我簽署憑證指紋。

--valid-days --vd

產生自我簽署憑證,並使用其指紋。 有效期限為指定的天數。 預設值:365。

az iot hub module-identity delete

刪除IoT 中樞中的裝置。

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

必要參數

--device-id -d

目標裝置識別碼。

--module-id -m

目的模組識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰,或使用目前的 Azure AD 會話。 您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
預設值: key
--etag -e

對應至資源最後狀態的 Etag 或實體標記。 如果未提供 etag,則會使用值 '*'。

--hub-name -n

IoT 中樞名稱。 如果未提供 --login,則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 用來避免透過 「az login」 的會話登入。 如果同時提供實體連接字串和名稱,則連接字串會優先使用。 如果未提供 --hub-name,則為必要專案。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

az iot hub module-identity list

列出位於IoT 中樞 IoT 裝置上的模組。

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

必要參數

--device-id -d

目標裝置識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰,或使用目前的 Azure AD 會話。 您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
預設值: key
--hub-name -n

IoT 中樞名稱。 如果未提供 --login,則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 用來避免透過 「az login」 的會話登入。 如果同時提供實體連接字串和名稱,則連接字串會優先使用。 如果未提供 --hub-name,則為必要專案。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--top

要傳回的專案數目上限。 將 -1 用於無限制。

預設值: 1000

az iot hub module-identity renew-key

使用 sas 驗證更新IoT 中樞裝置模組的目標金鑰。

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

範例

更新主鍵。

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

交換主要和次要金鑰。

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

必要參數

--device-id -d

目標裝置識別碼。

--hub-name -n

IoT 中樞名稱。 如果未提供 --login,則為必要項。

--key-type --kt

要重新產生的目標金鑰類型。

接受的值: primary, secondary, swap
--module-id -m

目的模組識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰,或使用目前的 Azure AD 會話。 您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
預設值: key
--etag -e

對應至資源最後狀態的 Etag 或實體標記。 如果未提供 etag,則會使用值 '*'。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 用來避免透過 「az login」 的會話登入。 如果同時提供實體連接字串和名稱,則連接字串會優先使用。 如果未提供 --hub-name,則為必要專案。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

az iot hub module-identity show

取得IoT 中樞中 IoT 裝置模組的詳細資料。

az iot hub module-identity show --device-id
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

必要參數

--device-id -d

目標裝置識別碼。

--module-id -m

目的模組識別碼。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰,或使用目前的 Azure AD 會話。 您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
預設值: key
--hub-name -n

IoT 中樞名稱。 如果未提供 --login,則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 用來避免透過 「az login」 的會話登入。 如果同時提供實體連接字串和名稱,則連接字串會優先使用。 如果未提供 --hub-name,則為必要專案。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

az iot hub module-identity update

更新IoT 中樞裝置模組。

使用 --set 後面接著屬性指派來更新模組。 利用從「iot 中樞模組身分識別顯示」傳回的屬性。

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

範例

重新產生模組對稱驗證金鑰

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

必要參數

--device-id -d

目標裝置識別碼。

--module-id -m

目的模組識別碼。

選擇性參數

--add

藉由指定路徑和索引鍵值組,將 物件新增至物件清單。 範例:--add property.listProperty < key=value、string 或 JSON 字串 > 。

--auth-type

指出作業是否應該自動衍生原則金鑰,或使用目前的 Azure AD 會話。 您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
預設值: key
--etag -e

對應至資源最後狀態的 Etag 或實體標記。 如果未提供 etag,則會使用值 '*'。

--force-string

使用 'set' 或 'add' 時,請保留字元串常值,而不是嘗試轉換成 JSON。

--hub-name -n

IoT 中樞名稱。 如果未提供 --login,則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 用來避免透過 「az login」 的會話登入。 如果同時提供實體連接字串和名稱,則連接字串會優先使用。 如果未提供 --hub-name,則為必要專案。

--remove

從清單中移除屬性或專案。 範例:--remove property.list OR --remove propertyToRemove。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--set

指定要設定的屬性路徑和值來更新物件。 範例:--set property1.property2=。