WorkspaceConnection クラス

Note

これは試験段階のクラスであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。

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

継承

azure.ai.ml.entities._resource.Resource

WorkspaceConnection

コンストラクター

WorkspaceConnection(*, target: str, type: str, credentials: PatTokenConfiguration | SasTokenConfiguration | UsernamePasswordConfiguration | ManagedIdentityConfiguration | ServicePrincipalConfiguration | AccessKeyConfiguration, metadata: Dict[str, Any] | None = None, **kwargs)

パラメーター

name

str

必須

ワークスペース接続の名前。

target

str

必須

外部リソースの URL または ARM リソース ID。

credentials

Union[ PatTokenConfiguration, SasTokenConfiguration, UsernamePasswordConfiguration, <xref:azure.ai.ml.entities.ManagedIdentityConfiguration ~azure.ai.ml.entities.ServicePrincipalConfiguration>, AccessKeyConfiguration, ApiKeyConfiguration ]

必須

外部リソースに対して認証するための資格情報。

type

<xref:<xref:The type> of <xref:workspace connection>, <xref:possible values are: "git">, <xref:"python_feed">, <xref:"container_registry">, <xref:"feature_store">, <xref:"s3">, <xref:"snowflake">, <xref:"azure_sql_db">, <xref:"azure_synapse_analytics">, <xref:"azure_my_sql_db">, <xref:"azure_postgres_db">, <xref:"azure_open_ai">, <xref:"cognitive_search">, <xref:"cognitive_service">>

必須

この接続の外部リソースのカテゴリ。

メソッド

dump	ワークスペース接続仕様を yaml 形式のファイルにダンプします。

dump

ワークスペース接続仕様を yaml 形式のファイルにダンプします。

dump(dest: str | PathLike | IO, **kwargs) -> None

パラメーター

dest

Union[<xref:PathLike>, str, IO[AnyStr]]

必須

このワークスペース接続の仕様を受信する宛先。ローカル ファイルへのパス、または既に開いているファイル ストリームである必要があります。 dest がファイル パスの場合は、新しいファイルが作成され、ファイルが存在する場合は例外が発生します。 dest が開いているファイルの場合、ファイルは直接 に書き込まれ、ファイルが書き込み可能でない場合は例外が発生します。

属性

base_path

リソースのベース パス。

戻り値

リソースのベース パス。

の戻り値の型 :

str

creation_context

リソースの作成コンテキスト。

戻り値

リソースの作成メタデータ。

の戻り値の型 :

Optional[SystemData]

credentials

ワークスペース接続の資格情報。

]

戻り値

ワークスペース接続の資格情報。

の戻り値の型 :

Union[ <xref:PatTokenCredentialsConfiguration>, <xref:SasTokenCredentialsConfiguration>, <xref:UsernamePasswordCredentialsConfiguration>, ManagedIdentityConfiguration, <xref:ServicePrincipalCredentialsConfiguration>, <xref:AccessKeyCredentialsConfiguration>,

id

リソース ID。

戻り値

リソースのグローバル ID、Azure Resource Manager (ARM) ID。

の戻り値の型 :

Optional[str]

metadata

ワークスペース接続のメタデータ。

戻り値

ワークスペース接続のメタデータ。

の戻り値の型 :

Dict[str, Any]

target

ワークスペース接続のターゲット URL。

戻り値

ワークスペース接続のターゲット。

の戻り値の型 :

str

type

サポートされているワークスペース接続の種類は、'git'、'python_feed'、'container_registry' です。

戻り値

ジョブの種類。

の戻り値の型 :

str