az iot hub module-identity

注意

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

管理 IoT 裝置模組。

命令

名稱	Description	類型	狀態
az iot hub module-identity connection-string	管理 IoT 裝置模組的 連接字串。	副檔名	GA
az iot hub module-identity connection-string show	連接字串 顯示目標IoT裝置模組。	副檔名	GA
az iot hub module-identity create	在 IoT 中樞 的目標IoT裝置上建立模組。	副檔名	GA
az iot hub module-identity delete	刪除 IoT 中樞 中的裝置。	副檔名	GA
az iot hub module-identity list	列出位於 IoT 中樞 中IoT裝置上的模組。	副檔名	GA
az iot hub module-identity renew-key	使用 sas 驗證更新 IoT 中樞 裝置模組的目標金鑰。	副檔名	GA
az iot hub module-identity show	在 IoT 中樞 中取得IoT裝置模組的詳細數據。	副檔名	GA
az iot hub module-identity update	更新 IoT 中樞 裝置模組。	副檔名	GA

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。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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>。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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>。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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>。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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 or JSON string>。

預設值: []

--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。

預設值: False

--hub-name -n

IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。

--login -l

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

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

預設值: []

--resource-group -g

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

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。

預設值: []

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。