你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.MachineLearningServices 工作区/connections 2023-08-01-preview
- 最新
- 2024-07-01-preview
- 2024-04-01
- 2024-04-01-preview
- 2024-01-01-preview
- 2023-10-01
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-04-01
- 2023-04-01-preview
- 2023-02-01-preview
- 2022-12-01-preview
- 2022-10-01
- 2022-10-01-preview
- 2022-06-01-preview
- 2022-05-01
- 2022-02-01-preview
- 2022-01-01-preview
- 2021-07-01
- 2021-04-01
- 2021-03-01-preview
- 2021-01-01
- 2020-09-01-preview
- 2020-08-01
- 2020-06-01
Bicep 资源定义
可以使用目标操作部署工作区/连接资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.MachineLearningServices/workspaces/connections 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
category: 'string'
expiryTime: 'string'
isSharedToAll: bool
metadata: any()
target: 'string'
authType: 'string'
// For remaining properties, see WorkspaceConnectionPropertiesV2 objects
}
}
WorkspaceConnectionPropertiesV2 对象
设置 authType 属性以指定对象的类型。
对于 AccessKey，请使用：
authType: 'AccessKey'
credentials: {
accessKeyId: 'string'
secretAccessKey: 'string'
}
对于 ApiKey，请使用：
authType: 'ApiKey'
credentials: {
key: 'string'
}
对于 customKeys
authType: 'CustomKeys'
credentials: {
keys: {
{customized property}: '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'
}
属性值
workspaces/connections
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 了解如何在 Bicep中设置子资源的名称和类型。 |
string （必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：工作区 |
| 性能 | WorkspaceConnectionPropertiesV2（必需） |
WorkspaceConnectionPropertiesV2
| 名字 | 描述 | 价值 |
|---|---|---|
| 类别 | 连接的类别 | “ADLSGen2” “ApiKey” “AzureMySqlDb” “AzureOpenAI” “AzurePostgresDb” “AzureSqlDb” “AzureSynapseAnalytics” “CognitiveSearch” “CognitiveService” “ContainerRegistry” “CustomKeys” “Git” “PythonFeed” “Redis” 'S3' “Snowflake” |
| expiryTime | 字符串 | |
| isSharedToAll | 此连接是否将共享到中心下的所有项目工作区 | bool |
| 元数据 | 任何对象 | 对于 Bicep，可以使用 any（） 函数。 |
| 目标 | 字符串 | |
| authType | 设置对象类型 |
AccessKey ApiKey CustomKeys ManagedIdentity 无 PAT SAS ServicePrincipal UsernamePassword （必需） |
AccessKeyAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “AccessKey”（必需） |
| 凭据 | WorkspaceConnectionAccessKey |
WorkspaceConnectionAccessKey
| 名字 | 描述 | 价值 |
|---|---|---|
| accessKeyId | 字符串 | |
| secretAccessKey | 字符串 |
ApiKeyAuthWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ApiKey”（必需） |
| 凭据 | 工作区连接凭据的 API 密钥对象。 | WorkspaceConnectionApiKey |
WorkspaceConnectionApiKey
| 名字 | 描述 | 价值 |
|---|---|---|
| 钥匙 | 字符串 |
CustomKeysWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “CustomKeys”（必需） |
| 凭据 | 自定义密钥凭据对象 | CustomKeys |
CustomKeys
| 名字 | 描述 | 价值 |
|---|---|---|
| 钥匙 | {string} 字典 | CustomKeys |
| {自定义属性} | 字符串 |
ManagedIdentityAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ManagedIdentity”（必需） |
| 凭据 | WorkspaceConnectionManagedIdentity |
WorkspaceConnectionManagedIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 字符串 | |
| resourceId | 字符串 |
NoneAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “无”（必需） |
PATAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “PAT”（必需） |
| 凭据 | WorkspaceConnectionPersonalAccessToken |
WorkspaceConnectionPersonalAccessToken
| 名字 | 描述 | 价值 |
|---|---|---|
| 帕特 | 字符串 |
SASAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “SAS”（必需） |
| 凭据 | WorkspaceConnectionSharedAccessSignature |
WorkspaceConnectionSharedAccessSignature
| 名字 | 描述 | 价值 |
|---|---|---|
| sas | 字符串 |
ServicePrincipalAuthTypeWorkspaceConnectionPropertie...
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ServicePrincipal”（必需） |
| 凭据 | WorkspaceConnectionServicePrincipal |
WorkspaceConnectionServicePrincipal
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 字符串 | |
| clientSecret | 字符串 | |
| tenantId | 字符串 |
UsernamePasswordAuthTypeWorkspaceConnectionPropertie...
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “UsernamePassword”（必需） |
| 凭据 | WorkspaceConnectionUsernamePassword |
WorkspaceConnectionUsernamePassword
| 名字 | 描述 | 价值 |
|---|---|---|
| 密码 | 字符串 | |
| username | 字符串 |
ARM 模板资源定义
可以使用目标操作部署工作区/连接资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.MachineLearningServices/workspaces/connections 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.MachineLearningServices/workspaces/connections",
"apiVersion": "2023-08-01-preview",
"name": "string",
"properties": {
"category": "string",
"expiryTime": "string",
"isSharedToAll": "bool",
"metadata": {},
"target": "string",
"authType": "string"
// For remaining properties, see WorkspaceConnectionPropertiesV2 objects
}
}
WorkspaceConnectionPropertiesV2 对象
设置 authType 属性以指定对象的类型。
对于 AccessKey，请使用：
"authType": "AccessKey",
"credentials": {
"accessKeyId": "string",
"secretAccessKey": "string"
}
对于 ApiKey，请使用：
"authType": "ApiKey",
"credentials": {
"key": "string"
}
对于 customKeys
"authType": "CustomKeys",
"credentials": {
"keys": {
"{customized property}": "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"
}
属性值
workspaces/connections
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 资源类型 | “Microsoft.MachineLearningServices/workspaces/connections” |
| apiVersion | 资源 API 版本 | '2023-08-01-preview' |
| 名字 | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
string （必需） |
| 性能 | WorkspaceConnectionPropertiesV2（必需） |
WorkspaceConnectionPropertiesV2
| 名字 | 描述 | 价值 |
|---|---|---|
| 类别 | 连接的类别 | “ADLSGen2” “ApiKey” “AzureMySqlDb” “AzureOpenAI” “AzurePostgresDb” “AzureSqlDb” “AzureSynapseAnalytics” “CognitiveSearch” “CognitiveService” “ContainerRegistry” “CustomKeys” “Git” “PythonFeed” “Redis” 'S3' “Snowflake” |
| expiryTime | 字符串 | |
| isSharedToAll | 此连接是否将共享到中心下的所有项目工作区 | bool |
| 元数据 | 任何对象 | |
| 目标 | 字符串 | |
| authType | 设置对象类型 |
AccessKey ApiKey CustomKeys ManagedIdentity 无 PAT SAS ServicePrincipal UsernamePassword （必需） |
AccessKeyAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “AccessKey”（必需） |
| 凭据 | WorkspaceConnectionAccessKey |
WorkspaceConnectionAccessKey
| 名字 | 描述 | 价值 |
|---|---|---|
| accessKeyId | 字符串 | |
| secretAccessKey | 字符串 |
ApiKeyAuthWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ApiKey”（必需） |
| 凭据 | 工作区连接凭据的 API 密钥对象。 | WorkspaceConnectionApiKey |
WorkspaceConnectionApiKey
| 名字 | 描述 | 价值 |
|---|---|---|
| 钥匙 | 字符串 |
CustomKeysWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “CustomKeys”（必需） |
| 凭据 | 自定义密钥凭据对象 | CustomKeys |
CustomKeys
| 名字 | 描述 | 价值 |
|---|---|---|
| 钥匙 | {string} 字典 | CustomKeys |
| {自定义属性} | 字符串 |
ManagedIdentityAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ManagedIdentity”（必需） |
| 凭据 | WorkspaceConnectionManagedIdentity |
WorkspaceConnectionManagedIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 字符串 | |
| resourceId | 字符串 |
NoneAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “无”（必需） |
PATAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “PAT”（必需） |
| 凭据 | WorkspaceConnectionPersonalAccessToken |
WorkspaceConnectionPersonalAccessToken
| 名字 | 描述 | 价值 |
|---|---|---|
| 帕特 | 字符串 |
SASAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “SAS”（必需） |
| 凭据 | WorkspaceConnectionSharedAccessSignature |
WorkspaceConnectionSharedAccessSignature
| 名字 | 描述 | 价值 |
|---|---|---|
| sas | 字符串 |
ServicePrincipalAuthTypeWorkspaceConnectionPropertie...
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ServicePrincipal”（必需） |
| 凭据 | WorkspaceConnectionServicePrincipal |
WorkspaceConnectionServicePrincipal
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 字符串 | |
| clientSecret | 字符串 | |
| tenantId | 字符串 |
UsernamePasswordAuthTypeWorkspaceConnectionPropertie...
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “UsernamePassword”（必需） |
| 凭据 | WorkspaceConnectionUsernamePassword |
WorkspaceConnectionUsernamePassword
| 名字 | 描述 | 价值 |
|---|---|---|
| 密码 | 字符串 | |
| username | 字符串 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署工作区/连接资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.MachineLearningServices/workspaces/connections 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
category = "string"
expiryTime = "string"
isSharedToAll = bool
target = "string"
authType = "string"
// For remaining properties, see WorkspaceConnectionPropertiesV2 objects
}
})
}
WorkspaceConnectionPropertiesV2 对象
设置 authType 属性以指定对象的类型。
对于 AccessKey，请使用：
authType = "AccessKey"
credentials = {
accessKeyId = "string"
secretAccessKey = "string"
}
对于 ApiKey，请使用：
authType = "ApiKey"
credentials = {
key = "string"
}
对于 customKeys
authType = "CustomKeys"
credentials = {
keys = {
{customized property} = "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"
}
属性值
workspaces/connections
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 资源类型 | “Microsoft.MachineLearningServices/workspaces/connections@2023-08-01-preview” |
| 名字 | 资源名称 | string （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：工作区 |
| 性能 | WorkspaceConnectionPropertiesV2（必需） |
WorkspaceConnectionPropertiesV2
| 名字 | 描述 | 价值 |
|---|---|---|
| 类别 | 连接的类别 | “ADLSGen2” “ApiKey” “AzureMySqlDb” “AzureOpenAI” “AzurePostgresDb” “AzureSqlDb” “AzureSynapseAnalytics” “CognitiveSearch” “CognitiveService” “ContainerRegistry” “CustomKeys” “Git” “PythonFeed” “Redis” “S3” “雪花” |
| expiryTime | 字符串 | |
| isSharedToAll | 此连接是否将共享到中心下的所有项目工作区 | bool |
| 元数据 | 任何对象 | |
| 目标 | 字符串 | |
| authType | 设置对象类型 |
AccessKey ApiKey CustomKeys ManagedIdentity 无 PAT SAS ServicePrincipal UsernamePassword （必需） |
AccessKeyAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “AccessKey”（必需） |
| 凭据 | WorkspaceConnectionAccessKey |
WorkspaceConnectionAccessKey
| 名字 | 描述 | 价值 |
|---|---|---|
| accessKeyId | 字符串 | |
| secretAccessKey | 字符串 |
ApiKeyAuthWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ApiKey”（必需） |
| 凭据 | 工作区连接凭据的 API 密钥对象。 | WorkspaceConnectionApiKey |
WorkspaceConnectionApiKey
| 名字 | 描述 | 价值 |
|---|---|---|
| 钥匙 | 字符串 |
CustomKeysWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “CustomKeys”（必需） |
| 凭据 | 自定义密钥凭据对象 | CustomKeys |
CustomKeys
| 名字 | 描述 | 价值 |
|---|---|---|
| 钥匙 | {string} 字典 | CustomKeys |
| {自定义属性} | 字符串 |
ManagedIdentityAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ManagedIdentity”（必需） |
| 凭据 | WorkspaceConnectionManagedIdentity |
WorkspaceConnectionManagedIdentity
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 字符串 | |
| resourceId | 字符串 |
NoneAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “无”（必需） |
PATAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “PAT”（必需） |
| 凭据 | WorkspaceConnectionPersonalAccessToken |
WorkspaceConnectionPersonalAccessToken
| 名字 | 描述 | 价值 |
|---|---|---|
| 帕特 | 字符串 |
SASAuthTypeWorkspaceConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “SAS”（必需） |
| 凭据 | WorkspaceConnectionSharedAccessSignature |
WorkspaceConnectionSharedAccessSignature
| 名字 | 描述 | 价值 |
|---|---|---|
| sas | 字符串 |
ServicePrincipalAuthTypeWorkspaceConnectionPropertie...
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “ServicePrincipal” （必需） |
| 凭据 | WorkspaceConnectionServicePrincipal |
WorkspaceConnectionServicePrincipal
| 名字 | 描述 | 价值 |
|---|---|---|
| clientId | 字符串 | |
| clientSecret | 字符串 | |
| tenantId | 字符串 |
UsernamePasswordAuthTypeWorkspaceConnectionPropertie...
| 名字 | 描述 | 价值 |
|---|---|---|
| authType | 连接目标的身份验证类型 | “UsernamePassword”（必需） |
| 凭据 | WorkspaceConnectionUsernamePassword |
WorkspaceConnectionUsernamePassword
| 名字 | 描述 | 价值 |
|---|---|---|
| 密码 | 字符串 | |
| username | 字符串 |