次の方法で共有


az ml connection

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の ml 拡張機能の一部です。 拡張機能は、az ml connection コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure ML ワークスペース接続とそのより具体的な派生物を管理します。

Azure ML 接続を使用すると、外部リソースに接続して操作するために必要な認証と構成情報を安全に格納できます。

コマンド

名前 説明 状態
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 接続' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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>を使用して既定のワークスペースを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az ml connection delete

プレビュー

コマンド グループ 'ml 接続' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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>を使用して既定のワークスペースを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az ml connection list

プレビュー

コマンド グループ 'ml 接続' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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>を使用して既定のワークスペースを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az ml connection show

プレビュー

コマンド グループ 'ml 接続' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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>を使用して既定のワークスペースを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az ml connection update

プレビュー

コマンド グループ 'ml 接続' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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>を使用して既定のワークスペースを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False