az healthcareapis workspace iot-connector
注意
此參考是 Azure CLI 的 healthcareapis 延伸模組的一部分 (2.15.0 版或更高版本)。 擴充功能會在您第一次執行 az healthcareapis workspace iot-connector 命令時自動安裝。 深入了解擴充功能。
使用 healthcareapis 管理 iot 連接器。
命令
az healthcareapis workspace iot-connector create
使用指定的參數建立 IoT 連線or 資源。
az healthcareapis workspace iot-connector create --iot-connector-name
--resource-group
--workspace-name
[--content]
[--etag]
[--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
[--ingestion-endpoint-configuration]
[--location]
[--no-wait]
[--tags]
[--user-assigned-identities]
範例
建立 IoT 連線or
az healthcareapis workspace iot-connector create --identity-type "SystemAssigned" --location "westus" --content "{\"template\":[{\"template\":{\"deviceIdExpression\":\"$.deviceid\",\"timestampExpression\":\"$.measurementdatetime\",\"typeMatchExpression\":\"$..[?(@heartrate)]\",\"typeName\":\"heartrate\",\"values\":[{\"required\":\"true\",\"valueExpression\":\"$.heartrate\",\"valueName\":\"hr\"}]},\"templateType\":\"JsonPathContent\"}],\"templateType\":\"CollectionContent\"}" --ingestion-endpoint-configuration consumer-group="ConsumerGroupA" event-hub-name="MyEventHubName" fully-qualified-event-hub-namespace="myeventhub.servicesbus.windows.net" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --name "blue" --resource-group "testRG" --workspace-name "workspace1"
必要參數
IoT 連線or 資源的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
工作區資源的名稱。
選擇性參數
對應。 預期值:json-string/json-file/@json-file。
與資源相關聯的 etag,在編輯資源時用於開放式平行存取。
正在指定的身分識別類型,目前允許 SystemAssigned 和 None。
來源組態。
使用方式:--ingestion-endpoint-configuration event-hub-name=XX consumer-group=XX fully-qualified-event-hub-namespace=XX
event-hub-name:要連線的事件中樞名稱。consumer-group:要連線的事件中樞取用者群組。fully-qualified-event-hub-namespace:要連線之事件中樞的完整命名空間。
位置。 來自的值: az account list-locations
。 您可以使用 來設定預設位置 az configure --defaults location=<location>
。
請勿等候長時間執行的作業完成。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源識別碼:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件 ( {} )。 預期值:json-string/json-file/@json-file。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az healthcareapis workspace iot-connector delete
刪除 IoT 連線or。
az healthcareapis workspace iot-connector delete [--ids]
[--iot-connector-name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]
[--yes]
範例
刪除 IoT 連線or
az healthcareapis workspace iot-connector delete --name "blue" --resource-group "testRG" --workspace-name "workspace1"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
IoT 連線or 資源的名稱。
請勿等候長時間執行的作業完成。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
工作區資源的名稱。
不提示確認。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az healthcareapis workspace iot-connector list
列出指定工作區的所有 IoT 連線ors。
az healthcareapis workspace iot-connector list --resource-group
--workspace-name
範例
列出 iotconnectors
az healthcareapis workspace iot-connector list --resource-group "testRG" --workspace-name "workspace1"
必要參數
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
工作區資源的名稱。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az healthcareapis workspace iot-connector show
取得指定之 IoT 連線or 的屬性。
az healthcareapis workspace iot-connector show [--ids]
[--iot-connector-name]
[--resource-group]
[--subscription]
[--workspace-name]
範例
取得 IoT 連線or
az healthcareapis workspace iot-connector show --name "blue" --resource-group "testRG" --workspace-name "workspace1"
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
IoT 連線or 資源的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
工作區資源的名稱。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az healthcareapis workspace iot-connector update
修補 IoT 連線or。
az healthcareapis workspace iot-connector update [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
[--ids]
[--iot-connector-name]
[--no-wait]
[--resource-group]
[--subscription]
[--tags]
[--user-assigned-identities]
[--workspace-name]
範例
修補 IoT 連線or
az healthcareapis workspace iot-connector update --name "blue" --identity-type "SystemAssigned" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --resource-group "testRG" --workspace-name "workspace1"
選擇性參數
正在指定的身分識別類型,目前允許 SystemAssigned 和 None。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
IoT 連線or 資源的名稱。
請勿等候長時間執行的作業完成。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源識別碼:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件 ( {} )。 預期值:json-string/json-file/@json-file。
工作區資源的名稱。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az healthcareapis workspace iot-connector wait
將 CLI 置於等候狀態,直到符合 healthcareapis 工作區 iot-connector 的條件為止。
az healthcareapis workspace iot-connector wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--iot-connector-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--workspace-name]
範例
暫停執行下一行 CLI 腳本,直到成功建立 healthcareapis 工作區 iot-connector 為止。
az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --created
暫停執行下一行 CLI 腳本,直到 healthcareapis 工作區 iot-connector 成功更新為止。
az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --updated
暫停執行下一行 CLI 腳本,直到成功刪除 healthcareapis 工作區 iot-connector 為止。
az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --deleted
選擇性參數
請等候在 'Succeeded' 使用 'provisioningState' 建立。
等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到刪除為止。
等候資源存在。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
輪詢間隔以秒為單位。
IoT 連線or 資源的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
以秒為單位的等候上限。
等到 provisioningState 更新為 'Succeeded'。
工作區資源的名稱。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。