az ml component

注意

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

管理 Azure ML 元件。

Azure ML 元件會定義管線作業的元件元件組態。 您可以設定元件的輸入/輸出埠、執行環境和命令。 建立元件之後，您可以參考管線作業中的元件，以在 Docker 容器中執行它們。

命令

名稱	Description	類型	狀態
az ml component archive	封存元件。	副檔名	GA
az ml component create	建立元件。	副檔名	GA
az ml component list	列出工作區中的元件。	副檔名	GA
az ml component restore	還原封存的元件。	副檔名	GA
az ml component show	顯示元件的詳細數據。	副檔名	GA
az ml component update	更新元件。 目前只有少數位段（描述，display_name）支援更新。	副檔名	GA

az ml component archive

封存元件。

封存元件預設會隱藏清單查詢 （az ml component list）。 您仍然可以繼續參考並使用管線中的封存元件。 您可以封存元件容器或特定元件版本。 封存元件容器將會封存該指定名稱下元件的所有版本。 您可以使用 還原封存的元件 az ml component restore。 如果封存整個元件容器，則您無法還原元件的個別版本 - 您必須還原元件容器。

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

範例

封存元件容器（封存該元件的所有版本）

az ml component archive --name my-component --resource-group my-resource-group --workspace-name my-workspace

封存特定元件版本

az ml component archive --name my-component --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

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

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

建立元件。

az ml component create --file
                       [--name]
                       [--registry-name]
                       [--resource-group]
                       [--set]
                       [--skip-validation]
                       [--version]
                       [--workspace-name]

範例

從 YAML 規格檔案建立元件

az ml component create --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace

從具有指定版本的 YAML 規格檔案建立元件

az ml component create --file my_component.yml --version 1 --resource-group my-resource-group --workspace-name my-workspace

從 YAML 規格檔案在登錄中建立元件

az ml component create --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group

從具有指定版本的 YAML 規格檔案建立登錄中的元件

az ml component create --file my_component.yml --version 1 --registry-name my-registry-name --resource-group my-resource-group

必要參數

--file -f

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

選擇性參數

--name -n

元件的名稱。

--registry-name

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

--resource-group -g

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

--set

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

--skip-validation

在建立資源時略過驗證。 請注意，相依資源不會略過其在建立中的驗證。

預設值: False

--version -v

元件的版本。

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

列出工作區中的元件。

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

範例

列出工作區中的所有元件

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

列出工作區中指定名稱的所有元件版本

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

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

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

列出登錄中的所有元件

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

列出登錄中指定名稱的所有元件版本

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

使用 --query 自變數列出登錄中的所有元件，以在命令結果上執行 JMESPath 查詢。

az ml component list --query "[].{Name:name}"  --output table --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

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

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

還原封存的元件。

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

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

範例

還原封存的元件容器（還原該元件的所有版本）

az ml component restore --name my-component --resource-group my-resource-group --workspace-name my-workspace

還原特定的封存元件版本

az ml component restore --name my-component --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

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

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

顯示元件的詳細數據。

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

範例

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

az ml component show --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

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

az ml component show --name my-component --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

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

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

更新元件。 目前只有少數位段（描述，display_name）支援更新。

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

範例

更新元件的描述

az ml component update -n my_component -v 1 --set description="new description" -g my-resource-group -w my-workspace

必要參數

--name -n

元件的名稱。

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

預設值: []

--force-string

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

預設值: False

--label -l

元件的標籤。

--registry-name

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

--remove

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

預設值: []

--set

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

預設值: []

--version -v

元件的版本。

全域參數

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