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

Microsoft.MachineLearningServices 工作区/connections 2023-04-01-preview

Bicep 资源定义

可以使用目标操作部署工作区/连接资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.MachineLearningServices/workspaces/connections 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections@2023-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    category: 'string'
    expiryTime: 'string'
    target: 'string'
    value: 'string'
    valueFormat: 'string'
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 对象

设置 authType 属性以指定对象的类型。

对于 AccessKey,请使用:

{
  authType: 'AccessKey'
  credentials: {
    accessKeyId: 'string'
    secretAccessKey: 'string'
  }
}

对于 ManagedIdentity,请使用:

{
  authType: 'ManagedIdentity'
  credentials: {
    clientId: 'string'
    resourceId: 'string'
  }
}

对于 ,请使用:

{
  authType: 'None'
}

对于 PAT,请使用:

{
  authType: 'PAT'
  credentials: {
    pat: 'string'
  }
}

对于 SAS,请使用:

{
  authType: 'SAS'
  credentials: {
    sas: 'string'
  }
}

对于 ServicePrincipal,请使用:

{
  authType: 'ServicePrincipal'
  credentials: {
    clientId: 'string'
    clientSecret: 'string'
    tenantId: 'string'
  }
}

对于 UsernamePassword,请使用:

{
  authType: 'UsernamePassword'
  credentials: {
    password: 'string'
    username: 'string'
  }
}

属性值

Microsoft.MachineLearningServices/workspaces/connections

名字 描述 价值
名字 资源名称 string (必需)
父级 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:工作区
性能 WorkspaceConnectionPropertiesV2(必需)

AccessKeyAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AccessKey”(必需)
凭据 WorkspaceConnectionAccessKey

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ManagedIdentity”(必需)
凭据 工作区连接托管身份

NoneAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “无”(必需)

PATAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “PAT”(必需)
凭据 WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “SAS”(必需)
凭据 WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ServicePrincipal”(必需)
凭据 WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “UsernamePassword”(必需)
凭据 WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

名字 描述 价值
accessKeyId 字符串
秘密访问密钥 字符串

约束:
敏感值。 以安全参数的形式传入。

工作区连接托管身份

名字 描述 价值
客户端 ID 字符串
资源ID 字符串

WorkspaceConnectionPersonalAccessToken

名字 描述 价值
帕特 字符串

WorkspaceConnectionPropertiesV2

名字 描述 价值
authType 设置为 AccessKeyAuthTypeWorkspaceConnectionProperties类型的“AccessKey”。 对于 type ManagedIdentityAuthTypeWorkspaceConnectionProperties,设置为“ManagedIdentity”。 对于 NoneAuthTypeWorkspaceConnectionProperties,请设置为“None”。 对于 PATAuthTypeWorkspaceConnectionProperties,请设置为“PAT”。 对于 SASAuthTypeWorkspaceConnectionProperties,请设置为“SAS”。 对于 type ServicePrincipalAuthTypeWorkspaceConnectionProperties,设置为“ServicePrincipal”。 对于 type UsernamePasswordAuthTypeWorkspaceConnectionProperties,设置为“UsernamePassword”。 “AccessKey”
“ManagedIdentity”
“None”
“PAT”
“SAS”
“ServicePrincipal”
“UsernamePassword”(必需)
分类 连接的类别 “AzureDataLakeGen2”
“AzureMySqlDb”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSynapseAnalytics”
“ContainerRegistry”
“FeatureStore”
“Git”
“PythonFeed”
“Redis”
“S3”
“Snowflake”
过期时间 字符串
目标 字符串
价值 工作区连接的值详细信息。 字符串
valueFormat 工作区连接值的格式 “JSON”

WorkspaceConnectionServicePrincipal

名字 描述 价值
客户端 ID 字符串
客户密钥 字符串

约束:
敏感值。 以安全参数的形式传入。
租户ID 字符串

WorkspaceConnectionSharedAccessSignature

名字 描述 价值
SAS 公司 字符串

WorkspaceConnectionUsernamePassword

名字 描述 价值
密码 字符串
用户名 字符串

用法示例

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

Bicep 文件 描述
Azure AI Foundry 基本设置 这组模板演示了如何使用基本设置设置 Azure AI Foundry,这意味着启用公共 Internet 访问、用于加密的 Microsoft 托管密钥以及 AI 资源的 Microsoft 托管身份配置。
Azure AI Foundry 基本设置 这组模板演示了如何使用基本设置设置 Azure AI Foundry,这意味着启用公共 Internet 访问、用于加密的 Microsoft 托管密钥以及 AI 资源的 Microsoft 托管身份配置。
Azure AI Foundry 网络受限 这组模板演示了如何在禁用专用链接和出口的情况下设置 Azure AI Foundry,使用 Microsoft 管理的密钥进行加密,并使用 Microsoft 管理的标识配置为 AI 资源。
具有 Microsoft Entra ID 身份验证的 Azure AI Foundry 这组模板演示了如何为依赖资源(如 Azure AI 服务和 Azure 存储)设置 Azure AI Foundry 和 Microsoft Entra ID 身份验证。
Azure AI Studio 基本设置 此模板集演示如何使用基本设置设置设置 Azure AI Studio,这意味着启用了公共 Internet 访问、Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
Azure AI Studio 网络受限 此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
基本代理设置 API 密钥 此模板集演示如何使用 API 密钥身份验证为 AI 服务/AOAI 连接设置基本设置 Azure AI 代理服务。 代理使用完全由Microsoft管理的多租户搜索和存储资源。 无法查看或控制这些基础 Azure 资源。
基本代理设置标识 此模板集演示如何使用 AI 服务/AOAI 连接的托管标识身份验证设置基本设置 Azure AI 代理服务。 代理使用完全由Microsoft管理的多租户搜索和存储资源。 无法查看或控制这些基础 Azure 资源。
使用托管虚拟网络部署 Secure AI Foundry 此模板创建具有强大网络和标识安全限制的安全 Azure AI Foundry 环境。
使用用户托管标识 网络安全代理 此模板集演示如何使用用户托管标识身份验证为 AI 服务/AOAI 连接设置虚拟网络隔离的 Azure AI 代理服务,以及专用网络链接,以将代理连接到安全数据。
标准代理设置 此模板集演示如何使用标准设置设置设置 Azure AI 代理服务,这意味着已启用项目/中心连接的托管标识身份验证和公共 Internet 访问。 代理使用客户拥有的单租户搜索和存储资源。 通过此设置,可以完全控制这些资源并查看这些资源,但会根据使用情况产生成本。

ARM 模板资源定义

可以使用目标操作部署工作区/连接资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.MachineLearningServices/workspaces/connections 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "apiVersion": "2023-04-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "expiryTime": "string",
    "target": "string",
    "value": "string",
    "valueFormat": "string",
    "authType": "string"
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 对象

设置 authType 属性以指定对象的类型。

对于 AccessKey,请使用:

{
  "authType": "AccessKey",
  "credentials": {
    "accessKeyId": "string",
    "secretAccessKey": "string"
  }
}

对于 ManagedIdentity,请使用:

{
  "authType": "ManagedIdentity",
  "credentials": {
    "clientId": "string",
    "resourceId": "string"
  }
}

对于 ,请使用:

{
  "authType": "None"
}

对于 PAT,请使用:

{
  "authType": "PAT",
  "credentials": {
    "pat": "string"
  }
}

对于 SAS,请使用:

{
  "authType": "SAS",
  "credentials": {
    "sas": "string"
  }
}

对于 ServicePrincipal,请使用:

{
  "authType": "ServicePrincipal",
  "credentials": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
  }
}

对于 UsernamePassword,请使用:

{
  "authType": "UsernamePassword",
  "credentials": {
    "password": "string",
    "username": "string"
  }
}

属性值

Microsoft.MachineLearningServices/workspaces/connections

名字 描述 价值
apiVersion API 版本 '2023-04-01-预览'
名字 资源名称 string (必需)
性能 WorkspaceConnectionPropertiesV2(必需)
类型 资源类型 “Microsoft.MachineLearningServices/workspaces/connections”

AccessKeyAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AccessKey”(必需)
凭据 WorkspaceConnectionAccessKey

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ManagedIdentity”(必需)
凭据 工作区连接托管身份

NoneAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “无”(必需)

PATAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “PAT”(必需)
凭据 WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “SAS”(必需)
凭据 WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ServicePrincipal”(必需)
凭据 WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “UsernamePassword”(必需)
凭据 WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

名字 描述 价值
accessKeyId 字符串
秘密访问密钥 字符串

约束:
敏感值。 以安全参数的形式传入。

工作区连接托管身份

名字 描述 价值
客户端 ID 字符串
资源ID 字符串

WorkspaceConnectionPersonalAccessToken

名字 描述 价值
帕特 字符串

WorkspaceConnectionPropertiesV2

名字 描述 价值
authType 设置为 AccessKeyAuthTypeWorkspaceConnectionProperties类型的“AccessKey”。 对于 type ManagedIdentityAuthTypeWorkspaceConnectionProperties,设置为“ManagedIdentity”。 对于 NoneAuthTypeWorkspaceConnectionProperties,请设置为“None”。 对于 PATAuthTypeWorkspaceConnectionProperties,请设置为“PAT”。 对于 SASAuthTypeWorkspaceConnectionProperties,请设置为“SAS”。 对于 type ServicePrincipalAuthTypeWorkspaceConnectionProperties,设置为“ServicePrincipal”。 对于 type UsernamePasswordAuthTypeWorkspaceConnectionProperties,设置为“UsernamePassword”。 “AccessKey”
“ManagedIdentity”
“None”
“PAT”
“SAS”
“ServicePrincipal”
“UsernamePassword”(必需)
分类 连接的类别 “AzureDataLakeGen2”
“AzureMySqlDb”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSynapseAnalytics”
“ContainerRegistry”
“FeatureStore”
“Git”
“PythonFeed”
“Redis”
“S3”
“Snowflake”
过期时间 字符串
目标 字符串
价值 工作区连接的值详细信息。 字符串
valueFormat 工作区连接值的格式 “JSON”

WorkspaceConnectionServicePrincipal

名字 描述 价值
客户端 ID 字符串
客户密钥 字符串

约束:
敏感值。 以安全参数的形式传入。
租户ID 字符串

WorkspaceConnectionSharedAccessSignature

名字 描述 价值
SAS 公司 字符串

WorkspaceConnectionUsernamePassword

名字 描述 价值
密码 字符串
用户名 字符串

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

模板 描述
Azure AI Foundry 基本设置

部署到 Azure
这组模板演示了如何使用基本设置设置 Azure AI Foundry,这意味着启用公共 Internet 访问、用于加密的 Microsoft 托管密钥以及 AI 资源的 Microsoft 托管身份配置。
Azure AI Foundry 基本设置

部署到 Azure
这组模板演示了如何使用基本设置设置 Azure AI Foundry,这意味着启用公共 Internet 访问、用于加密的 Microsoft 托管密钥以及 AI 资源的 Microsoft 托管身份配置。
Azure AI Foundry 网络受限

部署到 Azure
这组模板演示了如何在禁用专用链接和出口的情况下设置 Azure AI Foundry,使用 Microsoft 管理的密钥进行加密,并使用 Microsoft 管理的标识配置为 AI 资源。
具有 Microsoft Entra ID 身份验证的 Azure AI Foundry

部署到 Azure
这组模板演示了如何为依赖资源(如 Azure AI 服务和 Azure 存储)设置 Azure AI Foundry 和 Microsoft Entra ID 身份验证。
Azure AI Studio 基本设置

部署到 Azure
此模板集演示如何使用基本设置设置设置 Azure AI Studio,这意味着启用了公共 Internet 访问、Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
Azure AI Studio 网络受限

部署到 Azure
此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。
基本代理设置 API 密钥

部署到 Azure
此模板集演示如何使用 API 密钥身份验证为 AI 服务/AOAI 连接设置基本设置 Azure AI 代理服务。 代理使用完全由Microsoft管理的多租户搜索和存储资源。 无法查看或控制这些基础 Azure 资源。
基本代理设置标识

部署到 Azure
此模板集演示如何使用 AI 服务/AOAI 连接的托管标识身份验证设置基本设置 Azure AI 代理服务。 代理使用完全由Microsoft管理的多租户搜索和存储资源。 无法查看或控制这些基础 Azure 资源。
使用托管虚拟网络部署 Secure AI Foundry

部署到 Azure
此模板创建具有强大网络和标识安全限制的安全 Azure AI Foundry 环境。
使用用户托管标识 网络安全代理

部署到 Azure
此模板集演示如何使用用户托管标识身份验证为 AI 服务/AOAI 连接设置虚拟网络隔离的 Azure AI 代理服务,以及专用网络链接,以将代理连接到安全数据。
标准代理设置

部署到 Azure
此模板集演示如何使用标准设置设置设置 Azure AI 代理服务,这意味着已启用项目/中心连接的托管标识身份验证和公共 Internet 访问。 代理使用客户拥有的单租户搜索和存储资源。 通过此设置,可以完全控制这些资源并查看这些资源,但会根据使用情况产生成本。

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署工作区/连接资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.MachineLearningServices/workspaces/connections 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/connections@2023-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      category = "string"
      expiryTime = "string"
      target = "string"
      value = "string"
      valueFormat = "string"
      authType = "string"
      // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
    }
  }
}

WorkspaceConnectionPropertiesV2 对象

设置 authType 属性以指定对象的类型。

对于 AccessKey,请使用:

{
  authType = "AccessKey"
  credentials = {
    accessKeyId = "string"
    secretAccessKey = "string"
  }
}

对于 ManagedIdentity,请使用:

{
  authType = "ManagedIdentity"
  credentials = {
    clientId = "string"
    resourceId = "string"
  }
}

对于 ,请使用:

{
  authType = "None"
}

对于 PAT,请使用:

{
  authType = "PAT"
  credentials = {
    pat = "string"
  }
}

对于 SAS,请使用:

{
  authType = "SAS"
  credentials = {
    sas = "string"
  }
}

对于 ServicePrincipal,请使用:

{
  authType = "ServicePrincipal"
  credentials = {
    clientId = "string"
    clientSecret = "string"
    tenantId = "string"
  }
}

对于 UsernamePassword,请使用:

{
  authType = "UsernamePassword"
  credentials = {
    password = "string"
    username = "string"
  }
}

属性值

Microsoft.MachineLearningServices/workspaces/connections

名字 描述 价值
名字 资源名称 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:工作区
性能 WorkspaceConnectionPropertiesV2(必需)
类型 资源类型 “Microsoft.MachineLearningServices/workspaces/connections@2023-04-01-preview”

AccessKeyAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AccessKey”(必需)
凭据 WorkspaceConnectionAccessKey

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ManagedIdentity”(必需)
凭据 工作区连接托管身份

NoneAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “无”(必需)

PATAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “PAT”(必需)
凭据 WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “SAS”(必需)
凭据 WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ServicePrincipal”(必需)
凭据 WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “UsernamePassword”(必需)
凭据 WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

名字 描述 价值
accessKeyId 字符串
秘密访问密钥 字符串

约束:
敏感值。 以安全参数的形式传入。

工作区连接托管身份

名字 描述 价值
客户端 ID 字符串
资源ID 字符串

WorkspaceConnectionPersonalAccessToken

名字 描述 价值
帕特 字符串

WorkspaceConnectionPropertiesV2

名字 描述 价值
authType 设置为 AccessKeyAuthTypeWorkspaceConnectionProperties类型的“AccessKey”。 对于 type ManagedIdentityAuthTypeWorkspaceConnectionProperties,设置为“ManagedIdentity”。 对于 NoneAuthTypeWorkspaceConnectionProperties,请设置为“None”。 对于 PATAuthTypeWorkspaceConnectionProperties,请设置为“PAT”。 对于 SASAuthTypeWorkspaceConnectionProperties,请设置为“SAS”。 对于 type ServicePrincipalAuthTypeWorkspaceConnectionProperties,设置为“ServicePrincipal”。 对于 type UsernamePasswordAuthTypeWorkspaceConnectionProperties,设置为“UsernamePassword”。 “AccessKey”
“ManagedIdentity”
“None”
“PAT”
“SAS”
“ServicePrincipal”
“UsernamePassword”(必需)
分类 连接的类别 “AzureDataLakeGen2”
“AzureMySqlDb”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSynapseAnalytics”
“ContainerRegistry”
“FeatureStore”
“Git”
“PythonFeed”
“Redis”
“S3”
“Snowflake”
过期时间 字符串
目标 字符串
价值 工作区连接的值详细信息。 字符串
valueFormat 工作区连接值的格式 “JSON”

WorkspaceConnectionServicePrincipal

名字 描述 价值
客户端 ID 字符串
客户密钥 字符串

约束:
敏感值。 以安全参数的形式传入。
租户ID 字符串

WorkspaceConnectionSharedAccessSignature

名字 描述 价值
SAS 公司 字符串

WorkspaceConnectionUsernamePassword

名字 描述 价值
密码 字符串
用户名 字符串