共用方式為


az ml connection

Note

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

此命令群組處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

管理 Azure ML 工作區連線及其更特定的衍生專案。

Azure ML 連線提供安全的方法來儲存連線與外部資源互動所需的驗證和組態資訊。

命令

名稱 Description 類型 狀態
az ml connection create

建立連線。

Extension Preview
az ml connection delete

刪除連線。

Extension Preview
az ml connection list

列出所有連線。

Extension Preview
az ml connection show

顯示連線的詳細數據。

Extension Preview
az ml connection update

更新連線。

Extension Preview

az ml connection create

預覽

命令群組 『ml connection』 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

建立連線。

線上允許儲存連線和與外部資源互動所需的驗證和組態資訊。

az ml connection create --file
                        --resource-group
                        --workspace-name
                        [--name]
                        [--populate-secrets]
                        [--set]

範例

從 YAML 規格檔案建立連線。

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

從 YAML 規格檔案建立連線,並在傳回的連線中顯示 API 金鑰以進行驗證。

az ml connection create --file connection.yml --resource-group my-resource-group --workspace-name my-workspace --populate-secrets

必要參數

--file -f

包含 Azure ML 連線規格之 YAML 檔案的本機路徑。

--resource-group -g

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

--workspace-name -w

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

選擇性參數

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

--name -n

環境的名稱。

--populate-secrets -p

針對 API 金鑰型連線,請嘗試使用實際的秘密值填入傳回的認證。 對非 API 金鑰型連線不執行任何動作。

屬性
預設值: False
--set

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

全域參數
--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 connection delete

預覽

命令群組 『ml connection』 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

刪除連線。

az ml connection delete --name
                        --resource-group
                        --workspace-name
                        [--yes]

必要參數

--name -n

環境的名稱。

--resource-group -g

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

--workspace-name -w

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

選擇性參數

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

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

預覽

命令群組 『ml connection』 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

列出所有連線。

工作區中的連線清單。

az ml connection list --resource-group
                      --workspace-name
                      [--max-results]
                      [--populate-secrets]
                      [--type]

範例

列出工作區中的所有連線

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

列出工作區中的所有連線,並顯示適用連線的 API 金鑰

az ml connection list --resource-group my-resource-group --workspace-name my-workspace --populate-secrets

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

az ml connection 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>

選擇性參數

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

--max-results -r

要傳回的結果數目上限。

--populate-secrets -p

針對 API 金鑰型連線,請嘗試使用實際的秘密值填入傳回的認證。 對非 API 金鑰型連線不執行任何動作。

屬性
預設值: False
--type -t

要列出之 Azure ML 連線的類型。

全域參數
--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 connection show

預覽

命令群組 『ml connection』 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

顯示連線的詳細數據。

az ml connection show --name
                      --resource-group
                      --workspace-name
                      [--populate-secrets]

範例

顯示連線的詳細數據,包括其 API 金鑰。

az ml connection show --resource-group my-resource-group --name my-connection-name --workspace-name my-workspace --populate-secrets

必要參數

--name -n

環境的名稱。

--resource-group -g

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

--workspace-name -w

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

選擇性參數

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

--populate-secrets -p

針對 API 金鑰型連線,請嘗試使用實際的秘密值填入傳回的認證。 對非 API 金鑰型連線不執行任何動作。

屬性
預設值: 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 connection update

預覽

命令群組 『ml connection』 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

更新連線。

az ml connection update --name
                        --resource-group
                        --workspace-name
                        [--add]
                        [--force-string]
                        [--populate-secrets]
                        [--remove]
                        [--set]

範例

從 YAML 規格檔案更新連線。

az ml connection update --resource-group my-resource-group --name my-connection-name --workspace-name 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>.

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

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

屬性
參數群組: Generic Update Arguments
預設值: False
--populate-secrets -p

針對 API 金鑰型連線,請嘗試使用實際的秘密值填入傳回的認證。 對非 API 金鑰型連線不執行任何動作。

屬性
預設值: False
--remove

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

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

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

屬性
參數群組: Generic Update 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