通过

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

Microsoft.MachineLearningServices 工作区/连接

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections@2024-07-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    category: 'string'
    error: 'string'
    expiryTime: 'string'
    isSharedToAll: bool
    metadata: {
      {customized property}: 'string'
    }
    peRequirement: 'string'
    peStatus: 'string'
    sharedUserList: [
      'string'
    ]
    target: 'string'
    useWorkspaceManagedIdentity: bool
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 对象

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

对于 AAD，请使用：

  authType: 'AAD'

对于 AccessKey，请使用：

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

对于 AccountKey，请使用：

  authType: 'AccountKey'
  credentials: {
    key: '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'

对于 OAuth2，请使用：

  authType: 'OAuth2'
  credentials: {
    authUrl: 'string'
    clientId: 'string'
    clientSecret: 'string'
    developerToken: 'string'
    password: 'string'
    refreshToken: 'string'
    tenantId: 'string'
    username: 'string'
  }

对于 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'
    securityToken: 'string'
    username: 'string'
  }

属性值

workspaces/connections

名字 描述 价值
名字 资源名称

了解如何在 Bicep中设置子资源的名称和类型。		 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：工作区
性能 WorkspaceConnectionPropertiesV2（必需）

WorkspaceConnectionPropertiesV2

名字 描述 价值
类别 连接的类别 “ADLSGen2”
“AIServices”
“AmazonMws”
“AmazonRdsForOracle”
“AmazonRdsForSqlServer”
“AmazonRedshift”
“AmazonS3Compatible”
“ApiKey”
“AzureBlob”
“AzureDataExplorer”
“AzureDatabricksDeltaLake”
“AzureMariaDb”
“AzureMySqlDb”
“AzureOneLake”
“AzureOpenAI”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSqlMi”
“AzureSynapseAnalytics”
“AzureTableStorage”
“BingLLMSearch”
“Cassandra”
“CognitiveSearch”
“CognitiveService”
“Concur”
“ContainerRegistry”
“CosmosDb”
“CosmosDbMongoDbApi”
“Couchbase”
“CustomKeys”
“Db2”
“钻取”
“Dynamics”
“DynamicsAx”
“DynamicsCrm”
“Eloqua”
“FileServer”
“FtpServer”
“GenericContainerRegistry”
“GenericHttp”
“GenericRest”
“Git”
“GoogleAdWords”
“GoogleBigQuery”
“GoogleCloudStorage”
“Greenplum”
“Hbase”
“Hdfs”
“Hive”
“Hubspot”
“Impala”
“Informix”
“Jira”
“Magento”
“MariaDb”
“Marketo”
“MicrosoftAccess”
“MongoDbAtlas”
“MongoDbV2”
“MySql”
“Netezza”
“ODataRest”
“Odbc”
“Office365”
“OpenAI”
“Oracle”
“OracleCloudStorage”
“OracleServiceCloud”
“PayPal”
“Phoenix”
“PostgreSql”
“Presto”
“PythonFeed”
“QuickBooks”
“Redis”
“Responsys”
'S3'
“Salesforce”
“SalesforceMarketingCloud”
“SalesforceServiceCloud”
“SapBw”
“SapCloudForCustomer”
“SapEcc”
“SapHana”
“SapOpenHub”
“SapTable”
“Serp”
“无服务器”
“ServiceNow”
'Sftp'
“SharePointOnlineList”
“Shopify”
“Snowflake”
“Spark”
“SqlServer”
“Square”
“Sybase”
'Teradata'
“Vertica”
“WebTable”
“Xero”
“Zoho”
错误 字符串
expiryTime 字符串
isSharedToAll bool
元数据 存储此连接的用户元数据 WorkspaceConnectionPropertiesV2Metadata
peRequirement “NotApplicable”
“NotRequired”
“必需”
peStatus “Active”
“非活动”
“NotApplicable”
sharedUserList string[]
目标 字符串
useWorkspaceManagedIdentity bool
authType 设置对象类型 AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
无
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword （必需）

WorkspaceConnectionPropertiesV2Metadata

名字 描述 价值
{自定义属性} 字符串

AADAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AAD”（必需）

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

名字 描述 价值
accessKeyId 字符串
secretAccessKey 字符串

AccountKeyAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AccountKey”（必需）
凭据 工作区连接凭据的帐户密钥对象。 WorkspaceConnectionAccountKey

WorkspaceConnectionAccountKey

名字 描述 价值
钥匙 字符串

ApiKeyAuthWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ApiKey”（必需）
凭据 工作区连接凭据的 API 密钥对象。 WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

名字 描述 价值
钥匙 字符串

CustomKeysWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “CustomKeys”（必需）
凭据 自定义密钥凭据对象 CustomKeys

CustomKeys

名字 描述 价值
钥匙 {string} 字典 CustomKeys
{自定义属性} 字符串

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ManagedIdentity”（必需）
凭据 WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

名字 描述 价值
clientId 字符串
resourceId 字符串

NoneAuthTypeWorkspaceConnectionProperties

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

OAuth2AuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “OAuth2”（必需）
凭据 需要 ClientId 和 ClientSecret。 其他属性是可选的
取决于每个 OAuth2 提供程序的实现。
 WorkspaceConnectionOAuth2

WorkspaceConnectionOAuth2

名字 描述 价值
authUrl Concur 连接类别必需 字符串
clientId UUID 格式的客户端 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret 字符串

约束：
敏感值。 以安全参数的形式传入。
developerToken GoogleAdWords 连接类别要求 字符串

约束：
敏感值。 以安全参数的形式传入。
密码 字符串

约束：
敏感值。 以安全参数的形式传入。
refreshToken GoogleBigQuery、GoogleAdWords、Hubspot、QuickBooks、Square、Xero、Zoho 必需
用户需要脱机获取 RefreshToken 的位置		 字符串

约束：
敏感值。 以安全参数的形式传入。
tenantId QuickBooks 和 Xero 连接类别必需 字符串
username Concur，ServiceNow 身份验证服务器 AccessToken 授权类型为“密码”
这需要 UsernamePassword
 字符串

PATAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionPersonalAccessToken

名字 描述 价值
帕特 字符串

SASAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionSharedAccessSignature

名字 描述 价值
sas 字符串

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

名字 描述 价值
clientId 字符串
clientSecret 字符串

约束：
敏感值。 以安全参数的形式传入。
tenantId 字符串

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

名字 描述 价值
密码 字符串
securityToken 可选，除了 UsernamePassword 之外，SalesForce 等连接还需要额外的安全性 字符串

约束：
敏感值。 以安全参数的形式传入。
username 字符串

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "apiVersion": "2024-07-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "error": "string",
    "expiryTime": "string",
    "isSharedToAll": "bool",
    "metadata": {
      "{customized property}": "string"
    },
    "peRequirement": "string",
    "peStatus": "string",
    "sharedUserList": [ "string" ],
    "target": "string",
    "useWorkspaceManagedIdentity": "bool",
    "authType": "string"
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 对象

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

对于 AAD，请使用：

  "authType": "AAD"

对于 AccessKey，请使用：

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

对于 AccountKey，请使用：

  "authType": "AccountKey",
  "credentials": {
    "key": "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"

对于 OAuth2，请使用：

  "authType": "OAuth2",
  "credentials": {
    "authUrl": "string",
    "clientId": "string",
    "clientSecret": "string",
    "developerToken": "string",
    "password": "string",
    "refreshToken": "string",
    "tenantId": "string",
    "username": "string"
  }

对于 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",
    "securityToken": "string",
    "username": "string"
  }

属性值

workspaces/connections

名字 描述 价值
类型 资源类型 “Microsoft.MachineLearningServices/workspaces/connections”
apiVersion 资源 API 版本 '2024-07-01-preview'
名字 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。		 string （必需）
性能 WorkspaceConnectionPropertiesV2（必需）

WorkspaceConnectionPropertiesV2

名字 描述 价值
类别 连接的类别 “ADLSGen2”
“AIServices”
“AmazonMws”
“AmazonRdsForOracle”
“AmazonRdsForSqlServer”
“AmazonRedshift”
“AmazonS3Compatible”
“ApiKey”
“AzureBlob”
“AzureDataExplorer”
“AzureDatabricksDeltaLake”
“AzureMariaDb”
“AzureMySqlDb”
“AzureOneLake”
“AzureOpenAI”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSqlMi”
“AzureSynapseAnalytics”
“AzureTableStorage”
“BingLLMSearch”
“Cassandra”
“CognitiveSearch”
“CognitiveService”
“Concur”
“ContainerRegistry”
“CosmosDb”
“CosmosDbMongoDbApi”
“Couchbase”
“CustomKeys”
“Db2”
“钻取”
“Dynamics”
“DynamicsAx”
“DynamicsCrm”
“Eloqua”
“FileServer”
“FtpServer”
“GenericContainerRegistry”
“GenericHttp”
“GenericRest”
“Git”
“GoogleAdWords”
“GoogleBigQuery”
“GoogleCloudStorage”
“Greenplum”
“Hbase”
“Hdfs”
“Hive”
“Hubspot”
“Impala”
“Informix”
“Jira”
“Magento”
“MariaDb”
“Marketo”
“MicrosoftAccess”
“MongoDbAtlas”
“MongoDbV2”
“MySql”
“Netezza”
“ODataRest”
“Odbc”
“Office365”
“OpenAI”
“Oracle”
“OracleCloudStorage”
“OracleServiceCloud”
“PayPal”
“Phoenix”
“PostgreSql”
“Presto”
“PythonFeed”
“QuickBooks”
“Redis”
“Responsys”
'S3'
“Salesforce”
“SalesforceMarketingCloud”
“SalesforceServiceCloud”
“SapBw”
“SapCloudForCustomer”
“SapEcc”
“SapHana”
“SapOpenHub”
“SapTable”
“Serp”
“无服务器”
“ServiceNow”
'Sftp'
“SharePointOnlineList”
“Shopify”
“Snowflake”
“Spark”
“SqlServer”
“Square”
“Sybase”
'Teradata'
“Vertica”
“WebTable”
“Xero”
“Zoho”
错误 字符串
expiryTime 字符串
isSharedToAll bool
元数据 存储此连接的用户元数据 WorkspaceConnectionPropertiesV2Metadata
peRequirement “NotApplicable”
“NotRequired”
“必需”
peStatus “Active”
“非活动”
“NotApplicable”
sharedUserList string[]
目标 字符串
useWorkspaceManagedIdentity bool
authType 设置对象类型 AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
无
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword （必需）

WorkspaceConnectionPropertiesV2Metadata

名字 描述 价值
{自定义属性} 字符串

AADAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AAD”（必需）

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

名字 描述 价值
accessKeyId 字符串
secretAccessKey 字符串

AccountKeyAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AccountKey”（必需）
凭据 工作区连接凭据的帐户密钥对象。 WorkspaceConnectionAccountKey

WorkspaceConnectionAccountKey

名字 描述 价值
钥匙 字符串

ApiKeyAuthWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ApiKey”（必需）
凭据 工作区连接凭据的 API 密钥对象。 WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

名字 描述 价值
钥匙 字符串

CustomKeysWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “CustomKeys”（必需）
凭据 自定义密钥凭据对象 CustomKeys

CustomKeys

名字 描述 价值
钥匙 {string} 字典 CustomKeys
{自定义属性} 字符串

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ManagedIdentity”（必需）
凭据 WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

名字 描述 价值
clientId 字符串
resourceId 字符串

NoneAuthTypeWorkspaceConnectionProperties

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

OAuth2AuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “OAuth2”（必需）
凭据 需要 ClientId 和 ClientSecret。 其他属性是可选的
取决于每个 OAuth2 提供程序的实现。
 WorkspaceConnectionOAuth2

WorkspaceConnectionOAuth2

名字 描述 价值
authUrl Concur 连接类别必需 字符串
clientId UUID 格式的客户端 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret 字符串

约束：
敏感值。 以安全参数的形式传入。
developerToken GoogleAdWords 连接类别要求 字符串

约束：
敏感值。 以安全参数的形式传入。
密码 字符串

约束：
敏感值。 以安全参数的形式传入。
refreshToken GoogleBigQuery、GoogleAdWords、Hubspot、QuickBooks、Square、Xero、Zoho 必需
用户需要脱机获取 RefreshToken 的位置		 字符串

约束：
敏感值。 以安全参数的形式传入。
tenantId QuickBooks 和 Xero 连接类别必需 字符串
username Concur，ServiceNow 身份验证服务器 AccessToken 授权类型为“密码”
这需要 UsernamePassword
 字符串

PATAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionPersonalAccessToken

名字 描述 价值
帕特 字符串

SASAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionSharedAccessSignature

名字 描述 价值
sas 字符串

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

名字 描述 价值
clientId 字符串
clientSecret 字符串

约束：
敏感值。 以安全参数的形式传入。
tenantId 字符串

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

名字 描述 价值
密码 字符串
securityToken 可选，除了 UsernamePassword 之外，SalesForce 等连接还需要额外的安全性 字符串

约束：
敏感值。 以安全参数的形式传入。
username 字符串

Terraform （AzAPI 提供程序）资源定义

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/connections@2024-07-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      category = "string"
      error = "string"
      expiryTime = "string"
      isSharedToAll = bool
      metadata = {
        {customized property} = "string"
      }
      peRequirement = "string"
      peStatus = "string"
      sharedUserList = [
        "string"
      ]
      target = "string"
      useWorkspaceManagedIdentity = bool
      authType = "string"
      // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
    }
  })
}

WorkspaceConnectionPropertiesV2 对象

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

对于 AAD，请使用：

  authType = "AAD"

对于 AccessKey，请使用：

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

对于 AccountKey，请使用：

  authType = "AccountKey"
  credentials = {
    key = "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"

对于 OAuth2，请使用：

  authType = "OAuth2"
  credentials = {
    authUrl = "string"
    clientId = "string"
    clientSecret = "string"
    developerToken = "string"
    password = "string"
    refreshToken = "string"
    tenantId = "string"
    username = "string"
  }

对于 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"
    securityToken = "string"
    username = "string"
  }

属性值

workspaces/connections

名字 描述 价值
类型 资源类型 “Microsoft.MachineLearningServices/workspaces/connections@2024-07-01-preview”
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：工作区
性能 WorkspaceConnectionPropertiesV2（必需）

WorkspaceConnectionPropertiesV2

名字 描述 价值
类别 连接的类别 “ADLSGen2”
“AIServices”
“AmazonMws”
“AmazonRdsForOracle”
“AmazonRdsForSqlServer”
“AmazonRedshift”
“AmazonS3Compatible”
“ApiKey”
“AzureBlob”
“AzureDataExplorer”
“AzureDatabricksDeltaLake”
“AzureMariaDb”
“AzureMySqlDb”
“AzureOneLake”
“AzureOpenAI”
“AzurePostgresDb”
“AzureSqlDb”
“AzureSqlMi”
“AzureSynapseAnalytics”
“AzureTableStorage”
“BingLLMSearch”
“Cassandra”
“CognitiveSearch”
“CognitiveService”
“Concur”
“ContainerRegistry”
“CosmosDb”
“CosmosDbMongoDbApi”
“Couchbase”
“CustomKeys”
“Db2”
“钻取”
“Dynamics”
“DynamicsAx”
“DynamicsCrm”
“Eloqua”
“FileServer”
“FtpServer”
“GenericContainerRegistry”
“GenericHttp”
“GenericRest”
“Git”
“GoogleAdWords”
“GoogleBigQuery”
“GoogleCloudStorage”
“Greenplum”
“Hbase”
“Hdfs”
“Hive”
“Hubspot”
“Impala”
“Informix”
“Jira”
“Magento”
“MariaDb”
“Marketo”
“MicrosoftAccess”
“MongoDbAtlas”
“MongoDbV2”
“MySql”
“Netezza”
“ODataRest”
“Odbc”
“Office365”
“OpenAI”
“Oracle”
“OracleCloudStorage”
“OracleServiceCloud”
“PayPal”
“Phoenix”
“PostgreSql”
“Presto”
“PythonFeed”
“QuickBooks”
“Redis”
“Responsys”
“S3”
“Salesforce”
“SalesforceMarketingCloud”
“SalesforceServiceCloud”
“SapBw”
“SapCloudForCustomer”
“SapEcc”
“SapHana”
“SapOpenHub”
“SapTable”
“Serp”
“无服务器”
“ServiceNow”
“Sftp”
“SharePointOnlineList”
“Shopify”
“雪花”
“Spark”
“SqlServer”
“Square”
“Sybase”
“Teradata”
“Vertica”
“WebTable”
“Xero”
“Zoho”
错误 字符串
expiryTime 字符串
isSharedToAll bool
元数据 存储此连接的用户元数据 WorkspaceConnectionPropertiesV2Metadata
peRequirement “NotApplicable”
“NotRequired”
“必需”
peStatus “活动”
“非活动”
“NotApplicable”
sharedUserList string[]
目标 字符串
useWorkspaceManagedIdentity bool
authType 设置对象类型 AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
无
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword （必需）

WorkspaceConnectionPropertiesV2Metadata

名字 描述 价值
{自定义属性} 字符串

AADAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AAD”（必需）

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

名字 描述 价值
accessKeyId 字符串
secretAccessKey 字符串

AccountKeyAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “AccountKey”（必需）
凭据 工作区连接凭据的帐户密钥对象。 WorkspaceConnectionAccountKey

WorkspaceConnectionAccountKey

名字 描述 价值
钥匙 字符串

ApiKeyAuthWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ApiKey”（必需）
凭据 工作区连接凭据的 API 密钥对象。 WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

名字 描述 价值
钥匙 字符串

CustomKeysWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “CustomKeys”（必需）
凭据 自定义密钥凭据对象 CustomKeys

CustomKeys

名字 描述 价值
钥匙 {string} 字典 CustomKeys
{自定义属性} 字符串

ManagedIdentityAuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “ManagedIdentity”（必需）
凭据 WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

名字 描述 价值
clientId 字符串
resourceId 字符串

NoneAuthTypeWorkspaceConnectionProperties

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

OAuth2AuthTypeWorkspaceConnectionProperties

名字 描述 价值
authType 连接目标的身份验证类型 “OAuth2”（必需）
凭据 需要 ClientId 和 ClientSecret。 其他属性是可选的
取决于每个 OAuth2 提供程序的实现。
 WorkspaceConnectionOAuth2

WorkspaceConnectionOAuth2

名字 描述 价值
authUrl Concur 连接类别必需 字符串
clientId UUID 格式的客户端 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret 字符串

约束：
敏感值。 以安全参数的形式传入。
developerToken GoogleAdWords 连接类别要求 字符串

约束：
敏感值。 以安全参数的形式传入。
密码 字符串

约束：
敏感值。 以安全参数的形式传入。
refreshToken GoogleBigQuery、GoogleAdWords、Hubspot、QuickBooks、Square、Xero、Zoho 必需
用户需要脱机获取 RefreshToken 的位置		 字符串

约束：
敏感值。 以安全参数的形式传入。
tenantId QuickBooks 和 Xero 连接类别必需 字符串
username Concur，ServiceNow 身份验证服务器 AccessToken 授权类型为“密码”
这需要 UsernamePassword
 字符串

PATAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionPersonalAccessToken

名字 描述 价值
帕特 字符串

SASAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionSharedAccessSignature

名字 描述 价值
sas 字符串

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

名字 描述 价值
clientId 字符串
clientSecret 字符串

约束：
敏感值。 以安全参数的形式传入。
tenantId 字符串

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

名字 描述 价值
密码 字符串
securityToken 可选，除了 UsernamePassword 之外，SalesForce 等连接还需要额外的安全性 字符串

约束：
敏感值。 以安全参数的形式传入。
username 字符串