az ml workspace

Note

此參考資料是Azure CLIml擴充功能(版本 2.15.0 或更高版本)的一部分。 擴充功能會在您第一次執行 az ml workspace 命令時自動安裝。 深入了解擴充功能。

Manage Azure ML workspaces.

Azure ML workspace 是 Azure Machine Learning 的頂層資源。 它提供集中位置來追蹤 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

建立工作區。

Extension GA
az ml workspace delete

刪除工作區。

Extension GA
az ml workspace diagnose

診斷工作區設定問題。

Extension GA
az ml workspace list

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

Extension GA
az ml workspace list-keys

List workspace keys for dependent resources for dependent resources,例如 Azure 儲存體、Azure Container Registry 同 Azure 應用程式 Insights.

Extension GA
az ml workspace outbound-rule

管理 Azure ML 工作區受管理網路的出站規則。

Extension GA
az ml workspace outbound-rule list

列出工作區的所有受控網路輸出規則。

Extension GA
az ml workspace outbound-rule remove

從工作區的受控網路移除輸出規則。

Extension GA
az ml workspace outbound-rule set

在工作區的受控網路中新增或更新輸出規則。

Extension GA
az ml workspace outbound-rule show

顯示工作區受控網路輸出規則的詳細數據。

Extension GA
az ml workspace provision-network

布建工作區受控網路。

Extension GA
az ml workspace show

顯示工作區的詳細數據。

Extension GA
az ml workspace sync-keys

Sync workspace keys for dependent resources for dependent resources such such Azure 儲存體, Azure Container Registry, and Azure 應用程式 Insights.

Extension GA
az ml workspace update

更新工作區。

Extension GA

az ml workspace create

建立工作區。

當建立工作空間時,Azure ML 會使用的幾個 Azure 資源預設也會被建立:Azure 儲存體、Azure Container Registry、Azure Key Vault 和 Azure 應用程式 Insights。 你可以在建立工作區時,透過工作區設定的 YAML 檔案中指定資源 ID,使用現有的 Azure 資源實例來建立這些實例。

az ml workspace create --resource-group
                       [--acquire-policy-token]
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--change-reference]
                       [--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]
                       [--provision-network-now]
                       [--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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--allow-roleassignment-on-rg -r
預覽

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

屬性
預設值: True
--application-insights -a

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

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--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

僅限 Project 類型:定義本 project 父集結區的 ARM ID。

--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 識別碼。 此外,適用於無叢集計算的預設受控識別。

--provision-network-now
預覽

設定為在建立已啟用受控網路的工作apce 時觸發受控網路的布建,否則不會執行任何動作。

屬性
預設值: False
--public-network-access

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

--set

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

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az ml workspace delete

刪除工作區。

預設情況下,與工作區相關的依賴資源(Azure 儲存體、Azure Container Registry、Azure Key Vault、Azure 應用程式 Insights)不會被刪除。 若要同時刪除這些專案,請包含 --all-resources。 若要永久刪除工作區,請包含 --permanently-delete。

az ml workspace delete --name
                       --resource-group
                       [--acquire-policy-token]
                       [--all-resources]
                       [--change-reference]
                       [--no-wait]
                       [--permanently-delete]
                       [--yes]

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--all-resources

刪除所有與工作空間相關聯的資源(Azure 儲存體 account、Azure Container Registry、Azure 應用程式 Insights、Azure Key Vault)。

屬性
預設值: False
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--no-wait

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

屬性
預設值: False
--permanently-delete -p

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

屬性
預設值: False
--yes -y

請勿提示確認。

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az ml workspace diagnose

診斷工作區設定問題。

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

az ml workspace diagnose --name
                         --resource-group
                         [--acquire-policy-token]
                         [--change-reference]
                         [--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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--no-wait

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

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az ml workspace list-keys

List workspace keys for dependent resources for dependent resources,例如 Azure 儲存體、Azure Container Registry 同 Azure 應用程式 Insights.

az ml workspace list-keys --name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az ml workspace provision-network

布建工作區受控網路。

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

az ml workspace provision-network --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--include-spark

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

屬性
預設值: False
--no-wait

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

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az ml workspace sync-keys

Sync workspace keys for dependent resources for dependent resources such such Azure 儲存體, Azure Container Registry, and Azure 應用程式 Insights.

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

az ml workspace sync-keys --name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]
                          [--no-wait]

必要參數

--name -n

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

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--no-wait

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

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az ml workspace update

更新工作區。

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

az ml workspace update --name
                       --resource-group
                       [--acquire-policy-token]
                       [--add]
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--change-reference]
                       [--container-registry]
                       [--description]
                       [--display-name]
                       [--file]
                       [--force-string]
                       [--image-build-compute]
                       [--managed-network]
                       [--network-acls]
                       [--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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--add

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

屬性
參數群組: Generic Update Arguments
預設值: []
--allow-roleassignment-on-rg -r
預覽

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

--application-insights -a

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

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--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。

屬性
參數群組: Generic Update Arguments
預設值: False
--image-build-compute -i

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

--managed-network -m

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

--network-acls

CIDR 表示法中允許存取工作區的IP位址或IP範圍逗號分隔清單。 範例:'XX.XX.XX.XX,XX.XX.XX.XX.XX/32'。 若要將公用網路存取設定為 『Enabled』,請將 networkAcls 傳遞為 『none』(也就是這會重設 network-acls),並將 PNA 旗標設定為 『Enabled』。 若要停用,請將 PNA 旗標設定為 『Disabled』。 若要將公用網路存取設定為 「從選取的IP位址啟用」,請將 PNA 旗標設定為 'Enabled',並在 'network-acls. 中傳遞 CIDR 表示法中的逗號分隔IP清單。

--no-wait

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

屬性
預設值: False
--primary-user-assigned-identity -p

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

--public-network-access

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

--remove

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

屬性
參數群組: Generic Update Arguments
預設值: []
--set

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

屬性
參數群組: Generic Update Arguments
預設值: []
--system-datastores-auth-mode -d
預覽

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

--update-dependent-resources -u

指定 --update_dependent_resources,表示您同意更新工作區相依資源。 更新附加於工作空間的 Azure Container Registry 或 Application Insights 資源,可能會破壞先前工作脈絡、部署推論端點,或是你在此工作空間中重跑先前工作的能力。

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

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False