az iot hub message-endpoint update
注意
此參考是 Azure CLI 的 azure-iot 延伸模組的一部分(2.46.0 版或更高版本)。 擴充功能會在您第一次執行 az iot hub message-endpoint update 命令時自動安裝。 深入了解擴充功能。
命令群組 'iot 中樞訊息端點' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
更新 IoT 中樞 之現有端點的屬性。
命令
名稱 | Description | 類型 | 狀態 |
---|---|---|---|
az iot hub message-endpoint update cosmosdb-container |
更新現有 Cosmos DB 容器端點的屬性,以取得 IoT 中樞。 |
副檔名 | 預覽 |
az iot hub message-endpoint update eventhub |
更新 IoT 中樞 之現有事件中樞端點的屬性。 |
副檔名 | 預覽 |
az iot hub message-endpoint update servicebus-queue |
更新 IoT 中樞 現有 服務匯流排 佇列端點的屬性。 |
副檔名 | 預覽 |
az iot hub message-endpoint update servicebus-topic |
更新 IoT 中樞 現有 服務匯流排 主題端點的屬性。 |
副檔名 | 預覽 |
az iot hub message-endpoint update storage-container |
更新 IoT 中樞 之現有記憶體容器端點的屬性。 |
副檔名 | 預覽 |
az iot hub message-endpoint update cosmosdb-container
命令群組 'iot 中樞訊息端點' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
更新現有 Cosmos DB 容器端點的屬性,以取得 IoT 中樞。
如果將驗證類型從金鑰型更新為以身分識別為基礎的 Cosmos DB 容器端點,您必須提供身分識別(透過 --identity) 和端點 URI (透過 --endpoint-uri)。 舊的主鍵和次要金鑰將會淘汰。
如果從以身分識別為基礎的 Cosmos DB 容器端點更新驗證類型,您必須提供 連接字串(透過 --connection-string)、主鍵(透過 --primary-key)或次要密鑰(透過 --secondary-key)。
無法變更端點的容器名稱。 只有在兩個帳戶中都有相同名稱的容器時,才能變更帳戶名稱。
az iot hub message-endpoint update cosmosdb-container --en
--hub-name
[--connection-string]
[--database-name]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--identity]
[--partition-key-name]
[--partition-key-template]
[--pk]
[--resource-group]
[--secondary-key]
範例
更新金鑰型或身分識別型 Cosmos DB 容器端點,讓 IoT 中樞 使用新的指定 連接字串。
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --connection-string {connection_string}
更新 IoT 中樞 的 Cosmos DB 容器端點,以使用指定的主鍵和次要密鑰。
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --sk {secondary_key}
更新 IoT 中樞 的 Cosmos DB 容器端點,以使用系統指派的身分識別和數據分割索引鍵名稱。 分割區索引鍵範本將是預設值。
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pkn {partition_key_name} --identity [system]
更新金鑰型 Cosmos DB 容器端點,讓 IoT 中樞 使用使用者指派的身分識別(如果端點已經以身分識別為基礎,您可以省略 --endpoint-uri)。
az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}
必要參數
路由端點的名稱。
IoT 中樞 名稱。
選擇性參數
路由端點的連接字串。
cosmos DB 帳戶中 cosmos DB 資料庫的名稱。
端點的資源群組重新調整。 如果未提供,則會使用 IoT 中樞 的資源群組。
端點資源的訂用帳戶標識碼。 如果未提供,則會使用 IoT 中樞 的訂用帳戶。
端點資源的 URI。
使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼,以參考使用者指派的身分識別。
如果存在,則為與此 Cosmos DB SQL 容器相關聯的分割區索引鍵名稱。 若要清除此屬性,請將此屬性設定為 “ ”
用來產生綜合分割區索引鍵值的範本,以便與這個 Cosmos DB SQL 容器搭配使用。 範本至少必須包含下列其中一個佔位元:{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一個佔位元最多可以指定一次,但順序和非佔位元元元件都是任意的。 如果提供分割區索引鍵名稱,分割區索引鍵範本預設為 {deviceid}-{YYYY}-{MM}。 若要清除此屬性,請將此屬性設定為 “ ”
cosmos DB 帳戶的主鍵。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
cosmos DB 帳戶的次要密鑰。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub message-endpoint update eventhub
命令群組 'iot 中樞訊息端點' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
更新 IoT 中樞 之現有事件中樞端點的屬性。
如果從金鑰型更新驗證類型到以身分識別為基礎的事件中樞端點,您必須提供身分識別(透過 --identity)、端點 URI(透過 --endpoint-uri)和實體路徑(透過 --entity-path)。 舊的 連接字串 將會淘汰。
如果從身分識別型更新驗證類型到密鑰型事件中樞端點,您必須提供 連接字串(透過 --connection-string)。 舊的端點 URI 和實體路徑將會遭到 Null。
az iot hub message-endpoint update eventhub --en
--hub-name
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--entity-path]
[--identity]
[--resource-group]
範例
更新 IoT 中樞 的金鑰型或身分識別型事件中樞端點,以使用新的指定 連接字串。
az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} -c {connection_string}
更新 IoT 中樞 的事件中樞端點,以使用系統指派的身分識別和不同的實體路徑。
az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]
更新以密鑰為基礎的事件中樞端點,讓 IoT 中樞 使用使用者指派的身分識別(如果端點已經以身分識別為基礎,您可以省略 --endpoint-uri)。
az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}
必要參數
路由端點的名稱。
IoT 中樞 名稱。
選擇性參數
路由端點的連接字串。
端點的資源群組重新調整。 如果未提供,則會使用 IoT 中樞 的資源群組。
端點資源的訂用帳戶標識碼。 如果未提供,則會使用 IoT 中樞 的訂用帳戶。
端點資源的 URI。
端點資源的實體路徑。
使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼,以參考使用者指派的身分識別。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub message-endpoint update servicebus-queue
命令群組 'iot 中樞訊息端點' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
更新 IoT 中樞 之現有 服務匯流排 佇列端點的屬性。
如果將驗證類型從密鑰型更新為以身分識別為基礎的 服務匯流排 佇列端點,您必須提供身分識別(透過 --identity)、端點 URI(透過 --endpoint-uri)和實體路徑(透過 --entity-path)。 舊的 連接字串 將會淘汰。
如果從以身分識別為基礎的驗證類型更新為密鑰型 服務匯流排 佇列端點,您必須提供 連接字串(透過 --connection-string)。 舊的端點 URI 和實體路徑將會遭到 Null。
az iot hub message-endpoint update servicebus-queue --en
--hub-name
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--entity-path]
[--identity]
[--resource-group]
範例
更新金鑰型或身分識別型 服務匯流排 仱列端點,讓 IoT 中樞 使用新的指定 連接字串。
az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} -c {connection_string}
更新 服務匯流排 佇列端點,讓 IoT 中樞 使用系統指派的身分識別和不同的實體路徑。
az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]
更新以密鑰為基礎的 服務匯流排 佇列端點,讓 IoT 中樞 使用使用者指派的身分識別(如果端點已經以身分識別為基礎,您可以省略 --endpoint-uri)。
az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}
必要參數
路由端點的名稱。
IoT 中樞 名稱。
選擇性參數
路由端點的連接字串。
端點的資源群組重新調整。 如果未提供,則會使用 IoT 中樞 的資源群組。
端點資源的訂用帳戶標識碼。 如果未提供,則會使用 IoT 中樞 的訂用帳戶。
端點資源的 URI。
端點資源的實體路徑。
使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼,以參考使用者指派的身分識別。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub message-endpoint update servicebus-topic
命令群組 'iot 中樞訊息端點' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
更新 IoT 中樞 之現有 服務匯流排 主題端點的屬性。
如果將驗證類型從密鑰型更新為以身分識別為基礎的 服務匯流排 主題端點,您必須提供身分識別(透過 --identity)、端點 uri(透過 --endpoint-uri)和實體路徑(透過 --entity-path)。 舊的 連接字串 將會淘汰。
如果將驗證類型從身分識別型更新為密鑰型 服務匯流排 主題端點,您必須提供 連接字串(透過 --connection-string)。 舊的端點 URI 和實體路徑將會遭到 Null。
az iot hub message-endpoint update servicebus-topic --en
--hub-name
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--entity-path]
[--identity]
[--resource-group]
範例
更新 IoT 中樞 的金鑰型或身分識別型 服務匯流排 主題端點,以使用新的指定 連接字串。
az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} -c {connection_string}
更新 服務匯流排 主題端點,讓 IoT 中樞 使用系統指派的身分識別和不同的實體路徑。
az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]
更新以密鑰為基礎的 服務匯流排 主題端點,讓 IoT 中樞 使用使用者指派的身分識別(如果端點已經以身分識別為基礎,您可以省略 --endpoint-uri)。
az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}
必要參數
路由端點的名稱。
IoT 中樞 名稱。
選擇性參數
路由端點的連接字串。
端點的資源群組重新調整。 如果未提供,則會使用 IoT 中樞 的資源群組。
端點資源的訂用帳戶標識碼。 如果未提供,則會使用 IoT 中樞 的訂用帳戶。
端點資源的 URI。
端點資源的實體路徑。
使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼,以參考使用者指派的身分識別。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub message-endpoint update storage-container
命令群組 'iot 中樞訊息端點' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
更新 IoT 中樞 之現有記憶體容器端點的屬性。
如果從金鑰型更新驗證類型到以身分識別為基礎的記憶體容器端點,您必須提供身分識別(透過 --identity)和端點 URI(透過 --endpoint-uri)。 舊的 連接字串 將會淘汰。
如果將驗證類型從身分識別型更新為密鑰型記憶體容器端點,您必須提供 連接字串(透過 --connection-string)。
無法變更端點的容器名稱和編碼方式。 只有在兩個帳戶中都有相同名稱的容器時,才能變更帳戶名稱。
az iot hub message-endpoint update storage-container --en
--hub-name
[--batch-frequency]
[--chunk-size]
[--connection-string]
[--endpoint-resource-group]
[--endpoint-subscription-id]
[--endpoint-uri]
[--ff]
[--identity]
[--resource-group]
範例
更新 IoT 中樞 的金鑰型或身分識別型記憶體容器端點,以使用新的指定 連接字串。
az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -c {connection_string}
更新 IoT 中樞 的記憶體容器端點,以使用具有指定批次頻率、區塊大小和檔名格式的系統指派身分識別。
az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -b {batch_frequency} -w {chunk_size} --ff {file_format} --identity [system]
更新金鑰型記憶體容器端點,讓 IoT 中樞 使用使用者指派的身分識別(如果端點已經以身分識別為基礎,您可以省略 --endpoint-uri)。
az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}
必要參數
路由端點的名稱。
IoT 中樞 名稱。
選擇性參數
以秒為單位要求批次頻率。 數據寫入 Blob 之前可以經過的時間上限,介於 60 到 720 秒之間。
要求以 MB 為單位的區塊大小(MB)。 Blob 的大小上限,介於 10 到 500 MB 之間。
路由端點的連接字串。
端點的資源群組重新調整。 如果未提供,則會使用 IoT 中樞 的資源群組。
端點資源的訂用帳戶標識碼。 如果未提供,則會使用 IoT 中樞 的訂用帳戶。
端點資源的 URI。
Blob 的檔名格式。 文件名格式必須包含 {iothub}、{partition}、{YYYY}、{MM}、{DD}、{HH} 和 {mm} 字段。 所有參數都是必要參數,但可以使用或不使用分隔符重新排序。
使用系統指派或使用者指派的受控識別進行端點驗證。 使用 「[system]」 來參考系統指派的身分識別或資源識別碼,以參考使用者指派的身分識別。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。