az ml environment

Note

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

管理 Azure ML 環境。

Azure ML 環境會定義作業和端點部署的執行環境，封裝定型和推斷的相依性。 這些環境定義內建於 Docker 映像中。

命令

名稱	Description	類型	狀態
az ml environment archive	封存環境。	Extension	GA
az ml environment create	建立環境。	Extension	GA
az ml environment list	列出工作區中的環境。	Extension	GA
az ml environment restore	還原封存的環境。	Extension	GA
az ml environment share	從工作區共用特定環境到登錄。	Extension	GA
az ml environment show	顯示環境的詳細數據。	Extension	GA
az ml environment update	更新環境。	Extension	GA

az ml environment archive

封存環境。

封存環境預設會將其從清單查詢 (az ml environment list) 隱藏。 您仍然可以繼續在工作流程中參考並使用封存的環境。 您可以封存環境容器或特定環境版本。 封存環境容器會將該指定名稱下的所有環境版本封存。 您可以使用 還原封存環境 az ml environment restore。 如果整個環境容器已封存，則您無法還原環境的個別版本 - 您必須還原環境容器。

az ml environment archive --name
                          [--label]
                          [--registry-name]
                          [--resource-group]
                          [--version]
                          [--workspace-name]

範例

封存環境容器（封存該環境的所有版本）

az ml environment archive --name my-env --resource-group my-resource-group --workspace-name my-workspace

封存特定環境版本

az ml environment archive --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

環境的名稱。

選擇性參數

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

--label -l

環境的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--version -v

環境的版本。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<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 environment create

建立環境。

您可以從 Docker 映射、Dockerfile 或 Conda 檔案定義環境。 Azure ML 會維護一組 CPU 和 GPU Docker 映射，可用來作為基底映射。 如需這些映像的資訊，請參閱 https://github.com/Azure/AzureML-Containers。

建立的環境將會在工作區的指定名稱和版本下追蹤。

az ml environment create [--build-context]
                         [--conda-file]
                         [--datastore]
                         [--description]
                         [--dockerfile-path]
                         [--file]
                         [--image]
                         [--name]
                         [--no-wait]
                         [--os-type]
                         [--registry-name]
                         [--resource-group]
                         [--set]
                         [--tags]
                         [--version]
                         [--workspace-name]

範例

從 YAML 規格檔案建立環境

az ml environment create --file my_env.yml --resource-group my-resource-group --workspace-name my-workspace

從 Docker 映像建立環境

az ml environment create --name my-env --version 1 --file my_env.yml  --image pytorch/pytorch --resource-group my-resource-group --workspace-name my-workspace

從組建內容建立環境

az ml environment create --name my-env --version 1 --file my_env.yml  --build-context envs/context/ --dockerfile-path Dockerfile --resource-group my-resource-group --workspace-name my-workspace

從 conda 規格建立環境

az ml environment create --name my-env --version 1 --file my_env.yml  --conda-file conda_dep.yml --image mcr.microsoft.com/azureml/openmpi3.1.2-ubuntu18.04 --resource-group my-resource-group --workspace-name my-workspace

從 YAML 規格檔案在登錄中建立環境

az ml environment create --file my_env.yml --registry-name my-registry-name --resource-group my-resource-group

選擇性參數

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

--build-context -b

要作為 Docker 建置內容的目錄本機路徑。 --build-context/-b 和 --image/-i 是互斥自變數。

--conda-file -c

conda 規格檔案的本機路徑。 如果使用這個自變數，也必須指定 --image/-i。

--datastore

要上傳本機成品的數據存放區。

--description

環境的描述。

--dockerfile-path -d

--build-context/-b 所指定目錄中 Dockerfile 的相對路徑。 如果省略，則會使用 『./Dockerfile』。

屬性	值
預設值:	/Dockerfile

--file -f

包含 Azure ML 環境規格之 YAML 檔案的本機路徑。 環境的 YAML 參考檔位於：https://aka.ms/ml-cli-v2-environment-yaml-reference。

--image -i

Docker 映像。 --image/-i 和 --build-context/-b 是互斥的自變數。

--name -n

環境的名稱。

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--os-type

作業系統的類型。 允許的值：linux、windows。 默認值：linux。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--set

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

--tags

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

--version -v

環境的版本。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<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 environment list

列出工作區中的環境。

az ml environment list [--archived-only]
                       [--include-archived]
                       [--max-results]
                       [--name]
                       [--registry-name]
                       [--resource-group]
                       [--workspace-name]

範例

列出工作區中的所有環境

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

列出工作區中指定名稱的所有環境版本

az ml environment list --name my-env --resource-group my-resource-group --workspace-name my-workspace

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

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

列出登錄中的所有環境

az ml environment list --registry-name my-registry-name --resource-group my-resource-group

列出登錄中指定名稱的所有環境版本

az ml environment list --name my-env --registry-name my-registry-name --resource-group my-resource-group

選擇性參數

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

--archived-only

僅列出封存的環境。

屬性	值
預設值:	False

--include-archived

列出封存的環境和作用中環境。

屬性	值
預設值:	False

--max-results -r

要傳回的結果數目上限。

--name -n

環境的名稱。 如果提供，則會傳回此名稱下的所有環境版本。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<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 environment restore

還原封存的環境。

當已封存的環境還原時，它將不再隱藏於清單查詢中（az ml environment list）。 如果整個環境容器已封存，您可以還原該封存的容器。 這會還原該指定名稱下環境的所有版本。 如果整個環境容器已封存，您就不能只還原特定環境版本，您必須還原整個容器。 如果只封存個別的環境版本，您可以還原該特定版本。

az ml environment restore --name
                          [--label]
                          [--registry-name]
                          [--resource-group]
                          [--version]
                          [--workspace-name]

範例

還原封存的環境容器（還原該環境的所有版本）

az ml environment restore --name my-env --resource-group my-resource-group --workspace-name my-workspace

還原特定的封存環境版本

az ml environment restore --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

環境的名稱。

選擇性參數

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

--label -l

環境的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--version -v

環境的版本。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<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 environment share

從工作區共用特定環境到登錄。

將現有的環境從工作區複製到登錄，以便重複使用跨工作區。

az ml environment share --name
                        --registry-name
                        --share-with-name
                        --share-with-version
                        --version
                        [--resource-group]
                        [--workspace-name]

範例

將現有的環境從工作區共用至登錄

az ml environment share --name my-environment --version my-version --resource-group my-resource-group --workspace-name my-workspace --share-with-name new-name-in-registry --share-with-version new-version-in-registry --registry-name my-registry

必要參數

--name -n

環境的名稱。

--registry-name

目的地登錄。

--share-with-name

要用來建立的環境名稱。

--share-with-version

要用來建立的環境版本。

--version -v

環境的版本。

選擇性參數

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

--resource-group -g

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

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<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 environment show

顯示環境的詳細數據。

az ml environment show --name
                       [--label]
                       [--registry-name]
                       [--resource-group]
                       [--version]
                       [--workspace-name]

範例

顯示具有指定名稱和版本之環境的詳細數據

az ml environment show --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

在登錄中顯示具有指定名稱和版本的環境詳細數據

az ml environment show --name my-env --version 1 --registry-name my-registry-name --resource-group my-resource-group

必要參數

--name -n

環境的名稱。

選擇性參數

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

--label -l

環境的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--version -v

環境的版本。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<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 environment update

更新環境。

只能更新 'description' 和 'tags' 屬性。

az ml environment update --name
                         [--add]
                         [--force-string]
                         [--label]
                         [--registry-name]
                         [--remove]
                         [--resource-group]
                         [--set]
                         [--version]
                         [--workspace-name]

必要參數

--name -n

環境的名稱。

選擇性參數

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

--add

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

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

--force-string

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--label -l

環境的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--remove

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

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

--resource-group -g

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

--set

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

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

--version -v

環境的版本。

--workspace-name -w

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