注意
本文档中详细介绍的 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 |
字符串 | 必需。 连接类型。 | azure_ai_services |
azure_ai_services |
is_shared |
布尔 | 如果中心内其他项目共享连接,则为 true;否则,为 false。 |
true |
|
endpoint |
字符串 | 必需。 端点的 URL。 | ||
api_key |
字符串 | 用于对连接进行身份验证的 API 密钥。 如果未提供,则通过 Microsoft Entra ID(无凭据身份验证)对连接进行身份验证。 | ||
ai_services_resource_id |
字符串 | 必需。 Foundry Tools 资源的完全限定 Azure 资源 ID。 |
注解
可通过两种方法创建与 Foundry 工具的连接:
- 除 Azure AI 搜索之外的所有 Foundry 工具的一个连接。
- 每个单独的 Foundry 工具的一个连接。
本文中所述的架构适用于 除 Azure AI 搜索以外的所有 Foundry 工具的一个连接。
az ml connection虽然命令可用于管理 Azure 机器学习和 Microsoft Foundry 连接,但 Foundry Tools 连接特定于 Foundry。
示例
这些示例将以 YAML 文件的形式显示,并通过 CLI 使用。 例如 az ml connection create -f <file-name>.yaml。
YAML:API 密钥
#AzureAIServiceConnection.yml
name: myazai_ei
type: azure_ai_services
endpoint: https://contoso.cognitiveservices.azure.com/
api_key: XXXXXXXXXXXXXXX
YAML:Microsoft Entra ID
#AzureAIServiceConnection.yml
name: myazai_apk
type: azure_ai_services
endpoint: https://contoso.cognitiveservices.azure.com/
Azure CLI ml 扩展 v2(当前)