az iot hub identity

備註

這個指令群組的指令在 Azure CLI 和至少一個擴充功能中都有定義。 安裝每個擴充功能以受益於其擴充功能。 深入了解擴充功能。

Manage identitys of a Azure IoT hub.

命令

名稱	Description	類型	狀態
az iot hub identity assign	將管理身份指派給 IoT 中樞。	Core	GA
az iot hub identity assign (azure-iot 擴充功能)	將管理身份指派給 IoT 中樞。	Extension	GA
az iot hub identity remove	移除 IoT 中樞 中的受管理身份。	Core	GA
az iot hub identity remove (azure-iot 擴充功能)	移除 IoT 中樞 中的受管理身份。	Extension	GA
az iot hub identity show	展示 IoT 中樞 的身份屬性。	Core	GA
az iot hub identity show (azure-iot 擴充功能)	展示 IoT 中樞 的身份屬性。	Extension	GA

az iot hub identity assign

將管理身份指派給 IoT 中樞。

az iot hub identity assign [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--role]
                           [--scopes]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

範例

將使用者指派的管理身份分配給 IoT 中樞

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId1} {resourceId2}

將系統指派的管理身份分配給 IoT 中樞，並為該身份指派角色。

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--role

要指派給中樞系統指派受控識別的角色。

--scopes

空間分隔的範圍清單，以指派系統指派受控識別的角色（--role）。

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--system --system-assigned

將系統指派的受控識別指派給此中樞。

屬性	值
接受的值:	false, true

--user --user-assigned

將使用者指派的受控識別指派給此中樞。 接受以空格分隔的身分識別資源標識符清單。

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False

az iot hub identity assign (azure-iot 擴充功能)

將管理身份指派給 IoT 中樞。

az iot hub identity assign [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--role]
                           [--scopes]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

範例

將使用者指派的管理身份分配給 IoT 中樞

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId1} {resourceId2}

將系統指派的管理身份分配給 IoT 中樞，並為該身份指派角色。

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--role

要指派給中樞系統指派受控識別的角色。

--scopes

空間分隔的範圍清單，以指派系統指派受控識別的角色（--role）。

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--system --system-assigned

將系統指派的受控識別指派給此中樞。

屬性	值
接受的值:	false, true

--user --user-assigned

將使用者指派的受控識別指派給此中樞。 接受以空格分隔的身分識別資源標識符清單。

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False

az iot hub identity remove

移除 IoT 中樞 中的受管理身份。

az iot hub identity remove [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

範例

從 IoT 中樞 移除使用者指派的受管理身份

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId}

移除系統指派的管理身份，從 IoT 中樞 中移除。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned

移除 IoT 中樞 上的所有身份。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned --user-assigned

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--system --system-assigned

從這個中樞移除系統指派的受控識別。

屬性	值
接受的值:	false, true

--user --user-assigned

從這個中樞移除使用者指派的受控識別。 接受以空格分隔的身分識別資源標識符清單。

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False

az iot hub identity remove (azure-iot 擴充功能)

移除 IoT 中樞 中的受管理身份。

az iot hub identity remove [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

範例

從 IoT 中樞 移除使用者指派的受管理身份

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId}

移除系統指派的管理身份，從 IoT 中樞 中移除。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned

移除 IoT 中樞 上的所有身份。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned --user-assigned

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--system --system-assigned

從這個中樞移除系統指派的受控識別。

屬性	值
接受的值:	false, true

--user --user-assigned

從這個中樞移除使用者指派的受控識別。 接受以空格分隔的身分識別資源標識符清單。

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False

az iot hub identity show

展示 IoT 中樞 的身份屬性。

az iot hub identity show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

範例

顯示 IoT 中樞 的身份屬性

az iot hub identity show --name MyIoTHub --resource-group MyResourceGroup

選擇性參數

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

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False

az iot hub identity show (azure-iot 擴充功能)

展示 IoT 中樞 的身份屬性。

az iot hub identity show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

範例

顯示 IoT 中樞 的身份屬性

az iot hub identity show --name MyIoTHub --resource-group MyResourceGroup

選擇性參數

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

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞 名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--verbose

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

屬性	值
預設值:	False