通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AzureOpenAIConnection Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

A Connection that is specifically designed for handling connections to Azure Open AI.

Constructor

AzureOpenAIConnection(*, azure_endpoint: str, api_key: str | None = None, api_version: str | None = None, api_type: str = 'Azure', open_ai_resource_id: str | None = None, metadata: Dict[Any, Any] | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the connection.
azure_endpoint
Required
str

The URL or ARM resource ID of the Azure Open AI Resource.
api_key
Required
Optional[str]

The api key to connect to the azure endpoint. If unset, tries to use the user's Entra ID as credentials instead.
open_ai_resource_id
Required
Optional[str]

The fully qualified ID of the Azure Open AI resource to connect to.
api_version
Required
Optional[str]

The api version that this connection was created for.
metadata
Required
Optional[dict[str,str]]

Metadata dictionary.

Keyword-Only Parameters

Name Description
azure_endpoint
Required
api_key
Default value: None
api_version
Default value: None
api_type
Default value: Azure
open_ai_resource_id
Default value: None
metadata
Default value: None

Methods

dump

Dump the connection spec into a file in yaml format.

dump

Dump the connection spec into a file in yaml format.

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

Parameters

Name Description
dest
Required
Union[<xref:PathLike>, str, IO[AnyStr]]

The destination to receive this connection's spec. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.

Attributes

api_base

Alternate name for the target of the connection, which is used by some connection subclasses.

Returns

Type Description
str

The target of the connection.

api_key

The API key of the connection.

Returns

Type Description
Optional[str]

The API key of the connection.

api_version

The API version of the connection.

Returns

Type Description
Optional[str]

The API version of the connection.

azure_endpoint

Alternate name for the target of the connection, which is used by some connection subclasses.

Returns

Type Description
str

The target of the connection.

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

credentials

Credentials for connection.

Returns

Type Description
Union[ PatTokenConfiguration, SasTokenConfiguration, UsernamePasswordConfiguration, ServicePrincipalConfiguration, AccessKeyConfiguration, NoneCredentialConfiguration, AccountKeyConfiguration, AadCredentialConfiguration, ]

Credentials for connection.

endpoint

Alternate name for the target of the connection, which is used by some connection subclasses.

Returns

Type Description
str

The target of the connection.

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

is_shared

Get the Boolean describing if this connection is shared amongst its cohort within a hub. Only applicable for connections created within a project.

Returns

Type Description
bool

metadata

The connection's metadata dictionary. :return: This connection's metadata. :rtype: Optional[Dict[str, Any]]

open_ai_resource_id

The fully qualified ID of the Azure Open AI resource this connects to.

Returns

Type Description
Optional[str]

The fully qualified ID of the Azure Open AI resource this connects to.

tags

Deprecated. Use metadata instead. :return: This connection's metadata. :rtype: Optional[Dict[str, Any]]

target

Target url for the connection.

Returns

Type Description
Optional[str]

Target of the connection.

type

Type of the connection, supported are 'git', 'python_feed' and 'container_registry'.

Returns

Type Description
str

Type of the job.

url

Alternate name for the target of the connection, which is used by some connection subclasses.

Returns

Type Description
str

The target of the connection.