CLI (v2) 線上端點 YAML 結構描述
受控線上端點的來源 JSON 結構描述可在 https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json 找到，而 Kubernetes 線上端點的來源 JSON 結構描述可在 https://azuremlschemas.azureedge.net/latest/kubernetesOnlineEndpoint.schema.json 找到。 受控線上端點和 Kubernetes 線上端點之間的差異在本文的屬性資料表中說明。 本文中的範例著重於受控線上端點。
注意
本文件中詳述的 YAML 語法是以最新版 ML CLI v2 延伸模組的 JSON 結構描述為基礎。 此語法僅保證能與最新版的 ML CLI v2 延伸模組搭配運作。 您可以在 https://azuremlschemasprod.azureedge.net/ 找到舊版延伸模組的結構描述。
注意
受控線上端點的完整指定範例 YAML 可供參考
YAML 語法
| 機碼 | 類型 | 描述 | 允許的值 | 預設值 |
|---|---|---|---|---|
$schema |
string | YAML 結構描述。 如果您使用 Azure Machine Learning VS Code 擴充功能來撰寫 YAML 檔案，在檔案頂端包含 $schema 可讓您叫用結構描述和資源完成。 |
||
name |
string | 必要。 端點的名稱。 在 Azure 區域層級必須是唯一的。 命名規則定義於端點限制下。 |
||
description |
string | 端點的描述。 | ||
tags |
object | 端點的標記字典。 | ||
auth_mode |
字串 | 叫用端點的驗證方法 (資料平面作業)。 使用 key 進行金鑰式驗證。 使用 aml_token 進行 Azure Machine Learning 權杖型驗證。 使用 aad_token 進行Microsoft Entra 權杖型驗證。 |
key、aml_token、aad_token |
key |
compute |
字串 | 端點部署執行所在的計算目標名稱。 此欄位僅適用於已啟用 Azure Arc 的 Kubernetes 叢集的端點部署 (此欄位中指定的計算目標必須具有 type: kubernetes)。 如果您要進行受控線上推斷，請不要指定此欄位。 |
||
identity |
object | 用來存取 Azure 資源以進行端點佈建和推斷的受控識別設定。 | ||
identity.type |
string | 受控識別的類型。 如果類型為 user_assigned，則也必須指定 identity.user_assigned_identities 屬性。 |
system_assigned, user_assigned |
|
identity.user_assigned_identities |
陣列 | 使用者指派身分識別的完整資源識別碼清單。 | ||
traffic |
object | 流量代表由不同部署提供服務的要求百分比。 其以機碼值組的字典表示，其中機碼代表部署名稱，而值代表該部署的流量百分比。 例如，blue: 90 green: 10 表示 90% 的要求會傳送至名為 blue 的部署，而 10% 會傳送至部署 green。 總流量必須為 0，或總和不得超過 100。 請參閱線上端點的安全推出，以查看運作中的流量設定。 注意：您無法在線上端點建立期間設定此欄位，因為必須在該端點下建立部署，然後才能設定流量。 您可以在已建立部署之後使用 az ml online-endpoint update 來更新線上端點的流量；例如 az ml online-endpoint update --name <endpoint_name> --traffic "blue=90 green=10"。 |
||
public_network_access |
string | 此旗標會控制受控端點的可見性。 當 disabled 時，會使用 Azure Machine Learning 工作區的私人端點接收輸入評分要求，而且無法從公用網路連線端點。 此旗標僅適用於受控端點 |
enabled, disabled |
enabled |
mirror_traffic |
string | 要鏡像至部署的即時流量百分比。 鏡像流量不會變更傳回給用戶端的結果。 流量的鏡像百分比會加以複製並提交至指定的部署，因此您可以收集計量和記錄，而不會影響用戶端。 例如，若要檢查延遲是否在可接受的界限內，以及是否沒有任何 HTTP 錯誤。 其以具有單一機碼值組的字典表示，其中機碼代表部署名稱，而值代表要鏡像至部署的流量百分比。 如需詳細資訊，請參閱使用鏡像流量測試部署。 |
備註
您可以使用 az ml online-endpoint 命令來管理 Azure Machine Learning 線上端點。
範例
範例 GitHub 存放庫中有範例可用。 以下顯示其中幾個。
YAML：基本
$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-endpoint
auth_mode: key
YAML：系統指派的身分識別
$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-sai-endpoint
auth_mode: key
YAML：使用者指派的身分識別
$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-uai-endpoint
auth_mode: key
identity:
type: user_assigned
user_assigned_identities:
- resource_id: user_identity_ARM_id_place_holder