az ml batch-endpoint

注意

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

管理 Azure ML 批次端點。

Azure ML 端點提供簡單的介面來建立和管理模型部署。 每個端點可以有一或多個部署。 批次端點用於離線批次評分。

命令

名稱	Description	類型	狀態
az ml batch-endpoint create	建立端點。	副檔名	GA
az ml batch-endpoint delete	刪除端點。	副檔名	GA
az ml batch-endpoint invoke	叫用端點。	副檔名	GA
az ml batch-endpoint list	列出工作區中的端點。	副檔名	GA
az ml batch-endpoint list-jobs	列出批次端點的批次評分作業。	副檔名	GA
az ml batch-endpoint show	顯示端點的詳細數據。	副檔名	GA
az ml batch-endpoint update	更新端點。	副檔名	GA

az ml batch-endpoint create

建立端點。

若要建立端點，請提供 YAML 檔案與批次端點組態。 如果端點已經存在，則會使用新的設定過度寫入端點。

az ml batch-endpoint create --resource-group
                            --workspace-name
                            [--file]
                            [--name]
                            [--no-wait]
                            [--set]

範例

從 YAML 規格檔案建立端點

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

建立名稱為的端點

az ml batch-endpoint create --name endpointname --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>。

選擇性參數

--file -f

YAML 檔案的本機路徑，其中包含 Azure ML 批次端點規格。 如需批次端點的 YAML 參考檔，請參閱： https://aka.ms/ml-cli-v2-endpoint-batch-yaml-reference。

--name -n

批次端點的名稱。

--no-wait

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

預設值: False

--set

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

全域參數

--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 batch-endpoint delete

刪除端點。

az ml batch-endpoint delete --name
                            --resource-group
                            --workspace-name
                            [--no-wait]
                            [--yes]

範例

刪除批次端點，包括其所有部署

az ml batch-endpoint delete --name my-batch-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>。

選擇性參數

--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 batch-endpoint invoke

叫用端點。

您可以使用某些資料叫用端點來啟動批次推斷執行。 針對批次端點，叫用會觸發異步批次評分作業。

az ml batch-endpoint invoke --name
                            --resource-group
                            --workspace-name
                            [--deployment-name]
                            [--experiment-name]
                            [--file]
                            [--input]
                            [--input-type]
                            [--inputs]
                            [--instance-count]
                            [--job-name]
                            [--mini-batch-size]
                            [--output-path]
                            [--outputs]
                            [--set]

範例

從已註冊的 Azure ML 數據資產叫用具有輸入數據的批次端點，並覆寫mini_batch_size的預設部署設定

az ml batch-endpoint invoke --name my-batch-endpoint --input azureml:my-dataset:1 --mini-batch-size 64 --resource-group my-resource-group --workspace-name my-workspace

從公用 URI 叫用具有輸入檔的批次端點

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_file --input https://pipelinedata.blob.core.windows.net/sampledata/mnist/0.png --resource-group my-resource-group --workspace-name my-workspace

從已註冊的數據存放區叫用具有輸入檔的批次端點

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_file --input azureml://datastores/workspaceblobstore/paths/{path_to_data}/mnist/0.png --resource-group my-resource-group --workspace-name my-workspace

從公用 URI 叫用具有輸入資料夾的批次端點

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_folder --input https://pipelinedata.blob.core.windows.net/sampledata/mnist --resource-group my-resource-group --workspace-name my-workspace

從已註冊的數據存放區叫用具有輸入資料夾的批次端點

az ml batch-endpoint invoke --name my-batch-endpoint --input-type uri_folder --input azureml://datastores/workspaceblobstore/paths/{path_to_data}/mnist --resource-group my-resource-group --workspace-name my-workspace

使用本機資料夾中的檔案叫用批次端點

az ml batch-endpoint invoke --name my-batch-endpoint --input ./mnist_folder --resource-group my-resource-group --workspace-name my-workspace

使用本機資料夾作為輸入和輸出路徑叫用批次端點，並在端點叫用期間覆寫某些批次部署設定

az ml batch-endpoint invoke --name my-batch-endpoint --input ./mnist_folder --instance-count 2 --mini-batch-size 5 --output-path azureml://datastores/workspaceblobstore/paths/tests/output --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

要設為目標的部署名稱。

--experiment-name

管線元件部署實驗的名稱。

--file -f

用於批次叫用的檔名。

--input

要用於批次推斷的輸入數據參考。 它可以是數據存放區、公用 URI、已註冊的數據資產或本機資料夾路徑的路徑。

--input-type

輸入的類型，指定其為檔案或資料夾。 當您在資料存放區或公用 URI 上使用路徑時，請使用此選項。 支援的值：uri_folder、uri_file。

--inputs

叫用作業輸入的字典。

--instance-count -c

預測將執行的實例數目。

--job-name

批次叫用作業的名稱。

--mini-batch-size -m

輸入數據要分割成以進行預測的每個迷你批次大小。

--output-path

將上傳輸出檔案的數據存放區路徑。

--outputs

用來指定要儲存結果位置的字典。

--set

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

全域參數

--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 batch-endpoint list

列出工作區中的端點。

az ml batch-endpoint list --resource-group
                          --workspace-name

範例

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

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

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

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

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

az ml batch-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>。

全域參數

--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 batch-endpoint list-jobs

列出批次端點的批次評分作業。

az ml batch-endpoint list-jobs --name
                               --resource-group
                               --workspace-name

範例

列出端點的所有批次評分作業

az ml batch-endpoint list-jobs --name my-batch-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 batch-endpoint show

顯示端點的詳細數據。

az ml batch-endpoint show --name
                          --resource-group
                          --workspace-name

範例

顯示批次端點的詳細數據

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

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

az ml batch-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>。

全域參數

--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 batch-endpoint update

更新端點。

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

az ml batch-endpoint update --resource-group
                            --workspace-name
                            [--add]
                            [--defaults]
                            [--file]
                            [--force-string]
                            [--name]
                            [--no-wait]
                            [--remove]
                            [--set]

範例

從 YAML 規格檔案更新端點

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

將新的部署新增至現有的端點

az ml batch-endpoint update --name my-batch-endpoint  --set defaults.deployment_name=depname  --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>。

預設值: []

--defaults

在端點叫用的預設設定內更新deployment_name。

--file -f

YAML 檔案的本機路徑，其中包含 Azure ML 批次端點規格。 如需批次端點的 YAML 參考檔，請參閱： https://aka.ms/ml-cli-v2-endpoint-batch-yaml-reference。

--force-string

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

預設值: False

--name -n

批次端點的名稱。

--no-wait

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

預設值: False

--remove

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

預設值: []

--set

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

預設值: []

全域參數

--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 來取得完整偵錯記錄。