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

CLI (v2) OpenAI 连接 YAML 架构

适用于：Azure CLI ml 扩展 v2（当前）

注意

本文档中详细介绍的 YAML 语法基于最新版本的 ML CLI v2 扩展的 JSON 架构。此语法必定仅适用于最新版本的 ML CLI v2 扩展。可以在 https://azuremlschemasprod.azureedge.net/ 上查找早期扩展版本的架构。

YAML 语法

密钥	类型	说明	允许的值	默认值
`$schema`	字符串	YAML 架构。如果使用 Azure 机器学习 Visual Studio Code 扩展来创作 YAML 文件，请在该文件的顶部添加 `$schema` 以调用架构和资源完成。
`name`	字符串	必需。连接名称。
`description`	字符串	连接描述。
`tags`	物体	连接标记字典。
`type`	字符串	必需。连接类型。	`open_ai`	`open_ai`
`is_shared`	布尔	如果中心内其他项目共享连接，则为 `true`；否则，为 `false`。		`true`
`api_key`	字符串	必需。用于对连接进行身份验证的 API 密钥。

此架构用于创建与非 Microsoft OpenAI 服务的连接。有关用于连接到 Azure OpenAI 的架构的信息，请参阅 Azure OpenAI 连接架构。

az ml connection虽然命令可用于管理Azure 机器学习和 Azure AI Foundry 连接，但 OpenAI 连接特定于 Azure AI Foundry。

这些示例将以 YAML 文件的形式显示，并通过 CLI 使用。例如 az ml connection create -f <file-name>.yaml。

name: open_ai_conn
type: open_ai
api_key: "1234467"