az iot hub module-identity

Note

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

管理 IoT 裝置模組。

命令

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

az iot hub module-identity create

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

使用 shared_private_key 驗證方法時（也稱為對稱密鑰），如果沒有提供任何自定義金鑰，服務就會為模組產生它們。

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

必要參數

--device-id -d

目標裝置標識碼。

--module-id -m

目標模組識別碼。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--am --auth-method

要建立實體的授權方法。

屬性	值
預設值:	shared_private_key
接受的值:	shared_private_key, x509_ca, x509_thumbprint

--auth-type

指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type={auth-type-value}。

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--hub-name -n

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--od --output-dir

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

屬性	值
參數群組:	X.509 Arguments

--pk --primary-key

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

屬性	值
參數群組:	Symmetric Key Arguments

--primary-thumbprint --ptp

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

屬性	值
參數群組:	X.509 Arguments

--resource-group -g

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

--secondary-key --sk

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

屬性	值
參數群組:	Symmetric Key Arguments

--secondary-thumbprint --stp

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

屬性	值
參數群組:	X.509 Arguments

--valid-days --vd

產生自我簽署憑證，並使用其指紋。 有效期限為指定的天數。 默認值：365。

屬性	值
參數群組:	X.509 Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

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

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--etag -e

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

--hub-name -n

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

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

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--hub-name -n

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--resource-group -g

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

--top

要傳回的項目數目上限。 使用 -1 無限制。

屬性	值
預設值:	1000

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub module-identity renew-key

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

大量金鑰重新產生目前不支援 etag 和金鑰類型 swap 。 大量金鑰重新產生將會從單一模組金鑰重新產生而產生不同的輸出格式。

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--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

更新兩個模組的次要金鑰。

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

更新裝置中所有模組的兩個金鑰。

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

必要參數

--device-id -d

目標裝置標識碼。

--hub-name -n

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--key-type --kt

要重新產生的目標索引鍵類型。

屬性	值
接受的值:	both, primary, secondary, swap

--module-id -m

目標模組識別碼的空間分隔清單。 對所有模組使用 *。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--auth-type

指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type={auth-type-value}。

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--etag -e

對應至資源最後狀態的 Etag 或實體標記。 如果未提供任何 etag，則會使用 『*』 值。 此自變數僅適用於 swap。

--login -l

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--no-progress

隱藏大量金鑰重新產生進度列。

屬性	值
接受的值:	false, true

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

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

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--hub-name -n

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--auth-type

指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type={auth-type-value}。

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--etag -e

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

--force-string

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--hub-name -n

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

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

屬性	值
參數群組:	IoT Hub Identifier Arguments

--remove

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--resource-group -g

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

--set

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False