az iot ops
注意
此參考是 Azure CLI 的 azure-iot-ops 擴充功能的一部分(2.53.0 版或更高版本)。 擴充功能會在您第一次執行 az iot ops 命令時自動安裝。 深入了解擴充功能。
管理 Azure IoT 作業。
Azure IoT 作業是一組高度對齊但鬆散結合的第一方 Kubernetes 服務,可讓您將數據從內部部署資產匯總成產業級 MQTT 訊息代理程式、新增邊緣計算,以及設定雲端中各種服務的雙向數據流。
根據預設,IoT Operations CLI 命令會定期檢查是否有新的擴充功能版本可用。
您可以使用 停用 az config set iotops.check_latest=false
此行為。
命令
az iot ops check
此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus
評估已部署IoT Operations服務的叢集端整備程度和運行時間健康情況。
命令預設會顯示所有服務的高階人類易記 摘要 檢視。
使用 『--svc' 選項來指定單一服務的檢查,並透過 --detail-level
自變數設定詳細資訊。
注意:資源種類 (--resources) 和名稱 (--resource-name) 篩選只能與 '--svc' 自變數搭配使用。
{支持的服務 API}
- deviceregistry.microsoft.com/[v1]
- mqttbroker.iotoperations.azure.com/[v1]
- opcuabroker.iotoperations.azure.com/[v1beta1]
- connectivity.iotoperations.azure.com/[v1]
如需叢集需求的詳細資訊,請參閱 https://aka.ms/iot-ops-cluster-requirements。
az iot ops check [--as-object {false, true}]
[--context]
[--detail-level {0, 1, 2}]
[--ops-service {akri, broker, dataflow, deviceregistry, opcua}]
[--post {false, true}]
[--pre {false, true}]
[--resource-name]
[--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, dataflow, dataflowendpoint, dataflowprofile}]
範例
基本用法。 使用摘要輸出檢查整體IoT作業健康情況。
az iot ops check
檢查具有詳細輸出的 『broker』 服務健康情況和組態。
az iot ops check --svc broker --detail-level 1
僅評估已針對 CI 優化的輸出的「數據流」服務。
az iot ops check --svc dataflow --as-object
使用詳細資訊輸出檢查 『deviceregistry』 健康情況,但會將結果限製為「資產」資源。
az iot ops check --svc deviceregistry --detail-level 2 --resources asset
使用資源名稱將結果限製為具有 'my-asset-' 名稱前置詞的 'asset' 資源
az iot ops check --svc deviceregistry --resources asset --resource-name 'my-asset-*'
選擇性參數
輸出會檢查 CI 易記數據結構中的內容和驗證。
用於 k8s 叢集通訊的 Kubeconfig 內容名稱。 如果未提供任何內容,則會使用current_context。
控制檢查輸出中顯示的詳細數據層級。 選擇 0 作為摘要檢視(最小輸出)、1 以取得詳細檢視(更完整的資訊),或 2 作為詳細資訊檢視(所有可用資訊)。
將會評估的IoT Operations服務部署。
執行部署后檢查。
執行必要條件檢查,以判斷是否已滿足服務部署的最低需求。
只執行特定資源名稱的檢查。 名稱不區分大小寫。 支援 Glob 模式 '' 和 '?'。注意:只允許英數位元、連字元、'?' 和 '' 。
只對特定資源類型執行檢查。 使用空格分隔值。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot ops create
建立IoT作業實例。
執行此命令之前,必須先執行 init。
命令的結果會將IoT作業實例與一組設定為一致函式的預設資源進行 net。
az iot ops create --cluster
--name
--resource-group
--sr-resource-id
[--add-insecure-listener {false, true}]
[--bp]
[--br]
[--broker-backend-workers]
[--broker-config-file]
[--broker-frontend-replicas]
[--broker-frontend-workers]
[--broker-listener-type {ClusterIp, LoadBalancer, NodePort}]
[--broker-mem-profile {High, Low, Medium, Tiny}]
[--cluster-namespace]
[--custom-location]
[--description]
[--df-profile-instances]
[--enable-rsync {false, true}]
[--kubernetes-distro {K3s, K8s, MicroK8s}]
[--location]
[--no-progress {false, true}]
[--ops-config]
[--ops-train]
[--ops-version]
[--runtime-socket]
[--tags]
[--trust-settings]
範例
使用最小輸入建立目標實例。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID
下列範例會將自定義新增至預設 Broker 實例資源,以及實例描述和標記。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --broker-mem-profile High --broker-backend-workers 4 --description 'Contoso Factory' --tags tier=testX1
此範例示範部署針對服務類型負載平衡器埠 1883 設定的額外不安全(無驗證或 authz) 訊息代理程式接聽程式。 適用於測試和/或示範。 請勿在生產環境中使用不安全的選項。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --add-insecure-listener
此窗體示範如何啟用實例部署的資源同步處理。 若要在目標資源群組上啟用資源同步角色指派寫入,
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --enable-rsync
此範例會醒目提示使用者提供的 cert-manager 組態信任設定。請注意,叢集必須已使用 『--user-trust』 初始化,而且必須有用戶憑證管理員部署。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --trust-settings configMapName=example-bundle configMapKey=trust-bundle.pem issuerKind=ClusterIssuer issuerName=trust-manager-selfsigned-issuer
必要參數
IoT 作業部署的目標叢集名稱。
IoT 作業實例名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
要與IoT作業搭配使用的架構登錄資源標識碼。
選擇性參數
啟用時,mqtt 訊息代理程式部署將會包含服務類型 LoadBalancer 的接聽程式,此接聽程式系結至埠 1883 且沒有 authN 或 authZ。 僅適用於非生產工作負載。
Mqtt 訊息代理程式後端分割區。 最小值:1,最大值:16。
Mqtt 訊息代理程式後端備援因素。 最小值:1,最大值:5。
Mqtt 訊息代理程式後端背景工作角色。 最小值:1,最大值:16。
具有自訂訊息代理程式組態屬性的 json 檔案路徑。 檔案組態內容會用於個別的訊息代理程式組態參數。 適用於進階案例。 預期的格式描述於 https://aka.ms/aziotops-broker-config。
Mqtt 訊息代理程式前端復本。 最小值:1,最大值:16。
Mqtt 訊息代理程式前端背景工作角色。 最小值:1,最大值:16。
與預設 mqtt Broker 接聽程式相關聯的服務類型。
Mqtt Broker 記憶體配置檔。
叢集命名空間 IoT 作業基礎結構將會部署至 。 必須是小寫。
對應至IoT作業部署的自訂位置名稱。 默認值的格式為 'location-{hash(5)}'。
IoT 作業實例的描述。
與預設數據流配置檔相關聯的實例計數。
資源同步規則將會包含在IoT作業部署中。
用於 Akri 設定的 Kubernetes 散發版本。 選取的散發版本表示未提供 --runtime-socket 值時的預設容器運行時間套接字路徑。
將用於布建資源抵押品的區域。 如果未提供,則會使用聯機的叢集位置。
停用工作的視覺表示。
IoT 作業 arc 延伸模組自定義組態。 格式是空格分隔的索引鍵=值組。 --ops-config 可以使用一或多次。 針對進階使用案例。
自變數 'ops_train' 已被取代,並將在未來版本中移除。
使用 來覆寫內建的IoT作業弧線延伸模組發行定型。
自變數 'ops_version' 已被取代,並將在未來版本中移除。
使用 來覆寫內建的IoT作業arc延伸模組版本。
容器運行時間套接字的預設節點路徑。 如果未提供 (預設值),套接字路徑是由 --kubernetes-distro 所決定。
實例標籤。 索引鍵/值組中的屬性包,格式如下:a=b c=d。 使用 --tags “” 移除所有標籤。
使用者提供信任套件組合的設定。 用於元件 TLS。 格式是空格分隔的索引鍵=值組。 需要下列索引鍵:issuerName
、、issuerKind
configMapName
、 configMapKey
。 如果未使用,則會設定系統提供的自我簽署信任套件組合。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot ops delete
從叢集刪除IoT作業。
必須提供實例或叢集的名稱。
此作業會使用 Azure Resource Graph 來判斷相互關聯的資源。 資源圖形最終一致並不保證執行時同步處理的狀態。
az iot ops delete --resource-group
[--cluster]
[--force {false, true}]
[--include-deps {false, true}]
[--name]
[--no-progress {false, true}]
[--yes {false, true}]
範例
完整刪除的最低輸入。
az iot ops delete -n myinstance -g myresourcegroup
略過確認提示並繼續刪除程式。 適用於 CI 案例。
az iot ops delete -n myinstance -g myresourcegroup -y
不論警告為何,強制刪除。 可能會導致錯誤。
az iot ops delete -n myinstance -g myresourcegroup --force
使用叢集名稱而非 實例進行查閱。
az iot ops delete --cluster mycluster -g myresourcegroup
init 的反向應用。
az iot ops delete -n myinstance -g myresourcegroup --include-deps
必要參數
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
IoT 作業刪除的目標叢集名稱。
強制執行作業。
指出命令應該移除IoT作業相依性。 此選項的目的是要反轉 init 的應用程式。
IoT 作業實例名稱。
停用工作的視覺表示。
在沒有提示的情況下確認 [y]es。 適用於 CI 和自動化案例。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot ops init
啟動已啟用 Arc 的叢集以進行 IoT 作業部署。
需要啟用 Arc 的叢集才能部署 IoT 作業。 如需詳細資訊 https://aka.ms/aziotops-arcconnect,請參閱下列資源。
init 作業會在安裝及設定IoT作業部署所需的邊緣服務基礎層時執行工作。
安裝基礎層之後, az iot ops create
應該使用 命令來部署實例。
az iot ops init --cluster
--resource-group
[--enable-fault-tolerance {false, true}]
[--ensure-latest {false, true}]
[--no-progress {false, true}]
[--user-trust {false, true}]
範例
最低輸入的使用方式。 此窗體會部署IoT作業基礎層。
az iot ops init --cluster mycluster -g myresourcegroup
類似於先前的範例,但已啟用Arc容器記憶體容錯功能(至少需要3個節點)。
az iot ops init --cluster mycluster -g myresourcegroup --enable-fault-tolerance
此範例會醒目提示啟用自定義憑證管理員組態的使用者信任設定。這會略過系統 cert-manager 和 trust-manager 的部署。
az iot ops init --cluster mycluster -g myresourcegroup --user-trust
必要參數
IoT 作業部署的目標叢集名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
啟用 Azure Arc 容器記憶體的容錯功能。 至少需要3個叢集節點。
請確定正在使用最新的 IoT Ops CLI,並在有可用的升級時引發錯誤。
停用工作的視覺表示。
略過系統 cert-manager 和 trust-manager 的部署,以利於使用者提供的設定。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot ops list
列出IoT作業實例。
使用 --query 搭配所需的 JMESPath 語法來查詢結果。
az iot ops list [--resource-group]
範例
列出訂用帳戶中的所有實例。
az iot ops list
列出特定資源群組的所有實例。
az iot ops list -g myresourcegroup
列出訂用帳戶中具有特定標籤的實例。
az iot ops list -g myresourcegroup --query "[?tags.env == 'prod']"
選擇性參數
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot ops show
顯示IoT作業實例。
選擇性地,命令可以輸出關聯資源的樹狀結構,代表對備份叢集的IoT作業部署。
az iot ops show --name
--resource-group
[--tree {false, true}]
範例
顯示實例的基本用法。
az iot ops show --name myinstance -g myresourcegroup
輸出代表IoT作業部署之相關聯資源的樹狀結構。
az iot ops show --name myinstance -g myresourcegroup --tree
必要參數
IoT 作業實例名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
使用 將IoT作業部署可視化,以針對備份叢集。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot ops update
更新IoT作業實例。
目前可以更新實例標記和描述。
az iot ops update --name
--resource-group
[--description]
[--tags]
範例
更新實例標記。 這相當於取代。
az iot ops update --name myinstance -g myresourcegroup --tags a=b c=d
拿掉實例標籤。
az iot ops update --name myinstance -g myresourcegroup --tags ""
更新實例描述。
az iot ops update --name myinstance -g myresourcegroup --desc "Fabrikam Widget Factory B42"
必要參數
IoT 作業實例名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
IoT 作業實例的描述。
實例標籤。 索引鍵/值組中的屬性包,格式如下:a=b c=d。 使用 --tags “” 移除所有標籤。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot ops upgrade
此命令已被取代,並將在未來版本中移除。
將 IoT 作業實例升級至最新版本。
警告:此命令可能會失敗,並要求您刪除並重新建立叢集和實例。
升級IoT作業實例,包括將擴充功能更新至最新版本。
如果 az iot ops show
或類似的命令失敗,請使用此命令。
架構登錄資源標識碼是選擇性參數,在特定案例中可能需要。
az iot ops upgrade --name
--resource-group
[--no-progress {false, true}]
[--sr-resource-id]
[--yes {false, true}]
範例
使用最少的輸入來升級實例。
az iot ops upgrade --name myinstance -g myresourcegroup
在實例升級期間略過一致性提示。
az iot ops upgrade --name myinstance -g myresourcegroup -y
升級 實例並指定架構登錄資源標識碼。
az iot ops upgrade --name myinstance -g myresourcegroup --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID
必要參數
IoT 作業實例名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
停用工作的視覺表示。
要與IoT作業搭配使用的架構登錄資源標識碼。 如果 IoT 作業中找不到架構登錄資源標識碼,則為必要專案。
在沒有提示的情況下確認 [y]es。 適用於 CI 和自動化案例。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。