az ml workspace

注意

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

管理 Azure ML 工作區。

Azure ML 工作區是 Azure 機器學習 的最上層資源。 它提供集中位置來追蹤 ML 工作流程中使用的資產和資源，以及從定型作業產生的記錄和成品。

如果您要從 CLI v1 升級至 v2，則需要工作區管理範圍的下列兩項變更：

• 將命令升級 az ml workspace private-endpoint 為對等 az network private-endpoint 命令。
• 此外，將命令升級 az ml workspace share 為對等 az role assignment create 命令。

命令

名稱	Description	類型	狀態
az ml workspace create	建立工作區。	副檔名	GA
az ml workspace delete	刪除工作區。	副檔名	GA
az ml workspace diagnose	診斷工作區設定問題。	副檔名	GA
az ml workspace list	列出訂用帳戶中的所有工作區。	副檔名	GA
az ml workspace list-keys	列出相依資源的工作區密鑰，例如 Azure 儲存體、Azure Container Registry 和 Azure 應用程式 Insights。	副檔名	GA
az ml workspace outbound-rule	管理 Azure ML 工作區受控網路的輸出規則。	副檔名	GA
az ml workspace outbound-rule list	列出工作區的所有受控網路輸出規則。	副檔名	GA
az ml workspace outbound-rule remove	從工作區的受控網路移除輸出規則。	副檔名	GA
az ml workspace outbound-rule set	在工作區的受控網路中新增或更新輸出規則。	副檔名	GA
az ml workspace outbound-rule show	顯示工作區受控網路輸出規則的詳細數據。	副檔名	GA
az ml workspace provision-network	布建工作區受控網路。	副檔名	GA
az ml workspace show	顯示工作區的詳細數據。	副檔名	GA
az ml workspace sync-keys	同步處理相依資源的工作區密鑰，例如 Azure 儲存體、Azure Container Registry 和 Azure 應用程式 Insights。	副檔名	GA
az ml workspace update	更新工作區。	副檔名	GA

az ml workspace create

建立工作區。

建立工作區時，Azure ML 將使用的數個 Azure 資源預設也會建立：Azure 儲存體、Azure Container Registry、Azure 金鑰保存庫 和 Azure 應用程式 Insights。 您可以藉由在工作區組態 YAML 檔案中指定資源標識碼，來改為在建立工作區時，針對那些實例使用現有的 Azure 資源實例。

az ml workspace create --resource-group
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--container-registry]
                       [--default-resource-group]
                       [--description]
                       [--display-name]
                       [--enable-data-isolation]
                       [--file]
                       [--hub-id]
                       [--image-build-compute]
                       [--key-vault]
                       [--kind]
                       [--location]
                       [--managed-network]
                       [--name]
                       [--no-wait]
                       [--primary-user-assigned-identity]
                       [--public-network-access]
                       [--set]
                       [--storage-account]
                       [--system-datastores-auth-mode]
                       [--tags]
                       [--update-dependent-resources]

範例

從 YAML 規格檔案建立工作區。

az ml workspace create --file workspace.yml --resource-group my-resource-group

必要參數

--resource-group -g

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

選擇性參數

--allow-roleassignment-on-rg -r

預覽

用來判斷工作區是否可以在資源群組層級上指派角色的旗標。

預設值: True

--application-insights -a

與此工作區相關聯的 Application Insights ARM 識別碼。

--container-registry -c

與此工作區相關聯的容器登錄ARM標識碼。

--default-resource-group

預覽

僅限中樞種類。 如果設定，則此中樞的子項目預設會設定其資源群組。

--description

Azure ML 工作區的描述。

--display-name

工作區的顯示名稱。

--enable-data-isolation -e

用來判斷工作區是否已啟用數據隔離的旗標。 旗標只能在建立階段設定，無法更新。

預設值: False

--file -f

包含 Azure ML 工作區規格之 YAML 檔案的本機路徑。 如需工作區的 YAML 參考檔，請參閱： https://aka.ms/ml-cli-v2-workspace-yaml-reference。

--hub-id

預覽

僅限專案種類：定義此專案的父中樞的ARM標識碼。

--image-build-compute -i

容器登錄位於 VNet 後方時，用來建置環境 Docker 映射的計算目標名稱。

--key-vault -k

與此工作區相關聯的密鑰保存庫 ARM 識別碼。

--kind

預覽

指定工作區為特定類型，如果存在，則會覆寫 YAML 中指派的值。 預設為預設值。 有效的種類包括：預設、中樞和專案。

--location -l

要用於新工作區的位置。

--managed-network -m

預覽

工作區的受控網路隔離模式。

--name -n

Azure ML 工作區的名稱。

--no-wait

請勿等候工作區建立完成。

預設值: False

--primary-user-assigned-identity -p

指定多個受控識別時，主要使用者指派受控識別的 ARM 識別碼。 此外，適用於無叢集計算的預設受控識別。

--public-network-access

啟用工作區私人連結時，允許公用端點連線。

--set

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

--storage-account -s

與此工作區相關聯的記憶體帳戶 ARM 識別碼。

--system-datastores-auth-mode -d

預覽

指定系統資料存放區的驗證模式。 有效模式為：accesskey 和身分識別。

--tags

對象標記的空間分隔索引鍵/值組。

--update-dependent-resources -u

指定 --update_dependent_resources，表示您同意更新工作區相依資源。 更新工作區連結的 Azure Container Registry 或 Application Insights 資源可能會中斷先前作業的譜系、已部署的推斷端點，或您在此工作區中重新執行先前作業的能力。

預設值: 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 workspace delete

刪除工作區。

根據預設，不會刪除與工作區相關聯的相依資源（Azure 儲存體、Azure Container Registry、Azure 金鑰保存庫、Azure 應用程式 Insights）。 若要同時刪除這些專案，請包含 --all-resources。 若要永久刪除工作區，請包含 --permanently-delete。

az ml workspace delete --name
                       --resource-group
                       [--all-resources]
                       [--no-wait]
                       [--permanently-delete]
                       [--yes]

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

--all-resources

刪除與工作區相關聯的所有相依資源（Azure 儲存體 帳戶、Azure Container Registry、Azure 應用程式 Insights、Azure 金鑰保存庫）。

預設值: False

--no-wait

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

預設值: False

--permanently-delete -p

工作區預設為虛刪除狀態，以允許復原工作區數據。 設定此旗標以覆寫虛刪除行為，並永久刪除您的工作區。

預設值: 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 workspace diagnose

診斷工作區設定問題。

如果您的工作區未如預期般運作，您可以執行此診斷來檢查工作區是否已中斷。 針對私人端點工作區，它也有助於查看此工作區的網路設定及其相依資源是否有問題。

az ml workspace diagnose --name
                         --resource-group
                         [--no-wait]

範例

診斷工作區。

az ml workspace diagnose --name my-workspace-name --no-wait -g my-resource-group

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

--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 workspace list

列出訂用帳戶中的所有工作區。

工作區清單可以依資源群組進行篩選。

az ml workspace list [--filtered-kinds]
                     [--max-results]
                     [--resource-group]

範例

列出資源群組中的所有工作區

az ml workspace list --resource-group my-resource-group

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

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

選擇性參數

--filtered-kinds

預覽

僅列出指定的工作區類型，做為逗號分隔清單。 有效的種類包括：預設、中樞和專案。

--max-results -r

要傳回的結果數目上限。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<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 workspace list-keys

列出相依資源的工作區密鑰，例如 Azure 儲存體、Azure Container Registry 和 Azure 應用程式 Insights。

az ml workspace list-keys --name
                          --resource-group

必要參數

--name -n

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

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<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 workspace provision-network

布建工作區受控網路。

觸發工作區來布建受控網路。 指定已啟用Spark的旗標，會準備工作區受控網路以支援Spark。 如果未指定，預設值為 false，但稍後可以使用這個旗標再次執行此命令來啟用。 一旦啟用，就無法停用。

az ml workspace provision-network --name
                                  --resource-group
                                  [--include-spark]
                                  [--no-wait]

範例

布建受控網路。

az ml workspace provision-network --include-spark --name my-workspace-name --no-wait -g my-resource-group

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

--include-spark

布爾值 [true/false] 適用於是否應該布建受控網路以考慮Spark作業。 如果未設定旗標，則預設值為 false。 稍後可以使用這個旗標再次執行此命令來啟用它。

預設值: False

--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 workspace show

顯示工作區的詳細數據。

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

必要參數

--name -n

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

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<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 workspace sync-keys

同步處理相依資源的工作區密鑰，例如 Azure 儲存體、Azure Container Registry 和 Azure 應用程式 Insights。

如果工作區中任何資源的密鑰已變更，可能需要大約一小時的時間才能自動更新這些資源。 此命令會觸發工作區立即同步處理金鑰。 在重新產生記憶體金鑰之後，可能的情況需要立即存取記憶體。

az ml workspace sync-keys --name
                          --resource-group
                          [--no-wait]

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

--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 workspace update

更新工作區。

可以更新 'description'、'tags' 和 'friendly_name' 屬性。

az ml workspace update --name
                       --resource-group
                       [--add]
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--container-registry]
                       [--description]
                       [--display-name]
                       [--file]
                       [--force-string]
                       [--image-build-compute]
                       [--managed-network]
                       [--no-wait]
                       [--primary-user-assigned-identity]
                       [--public-network-access]
                       [--remove]
                       [--set]
                       [--system-datastores-auth-mode]
                       [--update-dependent-resources]

範例

從 YAML 規格檔案更新工作區。

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

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

--add

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

預設值: []

--allow-roleassignment-on-rg -r

預覽

用來判斷工作區是否可以在資源群組層級上指派角色的旗標。

--application-insights -a

與此工作區相關聯的 Application Insights ARM 識別碼。

--container-registry -c

與此工作區相關聯的容器登錄ARM標識碼。

--description

Azure ML 工作區的描述。

--display-name

工作區的顯示名稱。

--file -f

包含 Azure ML 工作區規格之 YAML 檔案的本機路徑。 如需工作區的 YAML 參考檔，請參閱： https://aka.ms/ml-cli-v2-workspace-yaml-reference。

--force-string

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

預設值: False

--image-build-compute -i

容器登錄位於 VNet 後方時，用來建置環境 Docker 映射的計算目標名稱。

--managed-network -m

預覽

工作區的受控網路隔離模式。

--no-wait

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

預設值: False

--primary-user-assigned-identity -p

與此工作區相關聯的主要使用者指派身分識別的 ARM 識別碼。

--public-network-access

啟用工作區私人連結時，允許公用端點連線。

--remove

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

預設值: []

--set

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

預設值: []

--system-datastores-auth-mode -d

預覽

指定系統資料存放區的驗證模式。 有效模式為：accesskey 和身分識別。

--update-dependent-resources -u

指定 --update_dependent_resources，表示您同意更新工作區相依資源。 更新工作區連結的 Azure Container Registry 或 Application Insights 資源可能會中斷先前作業的譜系、已部署的推斷端點，或您在此工作區中重新執行先前作業的能力。

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