az ml online-endpoint

  • 參考

注意

此參考是 Azure CLI 的 ml 延伸模組的一部分（2.15.0 版或更高版本）。 擴充功能會在您第一次執行 az ml online-endpoint 命令時自動安裝。 深入了解擴充功能。

管理 Azure ML 在線端點。

Azure ML 端點提供簡單的介面來建立和管理模型部署。 每個端點都可以有一或多個部署，以便視需要將來自單一評分端點的流量提供給多個部署。 這適用於受控制推出等案例。

Azure ML 支援兩種類型的端點：在線和批次。 在線端點支援即時推斷，而批次端點則用於離線批次評分。

命令

名稱 Description 類型 狀態
az ml online-endpoint create

建立端點。

 副檔名 GA
az ml online-endpoint delete

刪除端點。

 副檔名 GA
az ml online-endpoint get-credentials

列出在線端點的令牌/金鑰。

 副檔名 GA
az ml online-endpoint invoke

叫用端點。

 副檔名 GA
az ml online-endpoint list

列出工作區中的端點。

 副檔名 GA
az ml online-endpoint regenerate-keys

重新產生在線端點的金鑰。

 副檔名 GA
az ml online-endpoint show

顯示端點的詳細數據。

 副檔名 GA
az ml online-endpoint update

更新端點。

 副檔名 GA

az ml online-endpoint create

建立端點。

若要建立端點，請提供具有在線端點組態的 YAML 檔案。 如果端點已經存在，它將會失敗。 如果您想要更新現有的端點，請使用 az ml online-endpoint update。

az ml online-endpoint create --resource-group
                             --workspace-name
                             [--auth-mode]
                             [--file]
                             [--local {false, true}]
                             [--name]
                             [--no-wait]
                             [--set]
                             [--web]

範例

從 YAML 規格檔案建立端點

az ml online-endpoint create --file endpoint.yml --resource-group my-resource-group --workspace-name my-workspace

必要參數

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--auth-mode

端點的驗證方法。 允許的值：索引鍵、aml_token。 預設值：索引鍵。

--file -f

包含 Azure ML 在線端點規格之 YAML 檔案的本機路徑。 在線端點的 YAML 參考檔位於： https://aka.ms/ml-cli-v2-endpoint-online-yaml-reference。

--local

在本機建立端點。 注意：本機不支援流量和驗證。 您可以直接使用 'az ml online-deployment create --local'。 如果端點不存在，則會建立端點。

接受的值: false, true
預設值: False
--name -n

在線端點的名稱。

--no-wait

請勿等候長時間執行的作業完成。 預設值是 False。

預設值: False
--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--web -e

在網頁瀏覽器中的 Azure ML Studio 中顯示端點的詳細數據。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml online-endpoint delete

刪除端點。

az ml online-endpoint delete --name
                             --resource-group
                             --workspace-name
                             [--local {false, true}]
                             [--no-wait]
                             [--yes]

範例

刪除在線端點，包括其所有部署

az ml online-endpoint delete --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

在線端點的名稱。

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--local

刪除本機端點。

接受的值: false, true
預設值: False
--no-wait

請勿等候長時間執行的作業完成。 預設值是 False。

預設值: False
--yes -y

不提示確認。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml online-endpoint get-credentials

列出在線端點的令牌/金鑰。

az ml online-endpoint get-credentials --name
                                      --resource-group
                                      --workspace-name

範例

列出在線端點的金鑰

az ml online-endpoint get-credentials --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

在線端點的名稱。

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml online-endpoint invoke

叫用端點。

您可以使用某些要求數據叫用在線端點。 這會是即時推斷，而且會立即傳回評分結果。

az ml online-endpoint invoke --name
                             --resource-group
                             --workspace-name
                             [--deployment-name]
                             [--local {false, true}]
                             [--request-file]

範例

使用某些要求數據叫用在線端點

az ml online-endpoint invoke --name my-online-endpoint --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

叫用在線端點，以特定部署為目標

az ml online-endpoint invoke --name my-online-endpoint --deployment my-deployment --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

在線端點的名稱。

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--deployment-name -d

要設為目標的部署名稱。

--local

叫用本機端點。 只有在已為此端點建立本機部署時，才能運作。

接受的值: false, true
預設值: False
--request-file -r

包含要求數據的 JSON 檔案本機路徑。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml online-endpoint list

列出工作區中的端點。

az ml online-endpoint list --resource-group
                           --workspace-name
                           [--local {false, true}]

範例

列出工作區中的所有在線端點

az ml online-endpoint list --resource-group my-resource-group --workspace-name my-workspace

列出工作區中的所有批次端點

az ml online-endpoint list  --resource-group my-resource-group --workspace-name my-workspace

使用 --query 自變數在工作區中列出所有在線端點，以在命令結果上執行 JMESPath 查詢。

az ml online-endpoint list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必要參數

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--local

列出所有本機端點。

接受的值: false, true
預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml online-endpoint regenerate-keys

重新產生在線端點的金鑰。

az ml online-endpoint regenerate-keys --name
                                      --resource-group
                                      --workspace-name
                                      [--key-type]
                                      [--no-wait]

範例

重新產生在線端點的金鑰

az ml online-endpoint regenerate-keys --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

在線端點的名稱。

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--key-type

要重新產生之金鑰的類型。 允許的值：主要、次要。

預設值: primary
--no-wait

請勿等候長時間執行的作業完成。 預設值是 False。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml online-endpoint show

顯示端點的詳細數據。

az ml online-endpoint show --name
                           --resource-group
                           --workspace-name
                           [--local {false, true}]
                           [--web]

範例

顯示批次端點的詳細數據

az ml online-endpoint show --name my-online-endpoint  --resource-group my-resource-group --workspace-name my-workspace

使用 --query 自變數在命令結果上執行 JMESPath 查詢，顯示端點的布建狀態。

az ml online-endpoint show -n my-endpoint --query "{Name:name,State:provisioning_state}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

在線端點的名稱。

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--local

顯示本機端點。

接受的值: false, true
預設值: False
--web -e

在網頁瀏覽器中的 Azure ML Studio 中顯示端點的詳細數據。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml online-endpoint update

更新端點。

您可以更新端點的 'description'、'tags' 和 'traffic' 屬性。 此外，可以將新的部署新增至端點，而且可以更新現有的部署。

az ml online-endpoint update --resource-group
                             --workspace-name
                             [--add]
                             [--file]
                             [--force-string]
                             [--local {false, true}]
                             [--mirror-traffic]
                             [--name]
                             [--no-wait]
                             [--remove]
                             [--set]
                             [--traffic]
                             [--web]

範例

從 YAML 規格檔案更新端點

az ml online-endpoint update --file updated_endpoint.yml --resource-group my-resource-group --workspace-name my-workspace

更新端點的流量設定

az ml online-endpoint update --name my-online-endpoint  --traffic "my-new-deployment=100" --resource-group my-resource-group --workspace-name my-workspace

必要參數

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。

預設值: []
--file -f

包含 Azure ML 在線端點規格之 YAML 檔案的本機路徑。 在線端點的 YAML 參考檔位於： https://aka.ms/ml-cli-v2-endpoint-online-yaml-reference。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

預設值: False
--local

更新本機端點。

接受的值: false, true
預設值: False
--mirror-traffic

將重複的即時流量百分比導向定型部署。

--name -n

在線端點的名稱。

--no-wait

請勿等候長時間執行的作業完成。 預設值是 False。

預設值: False
--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

預設值: []
--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。

預設值: []
--traffic -r

以引號括住端點流量設定的空間分隔索引鍵/值組。

--web -e

在網頁瀏覽器中的 Azure ML Studio 中顯示端點的詳細數據。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。