Microsoft.MachineLearningServices workspaces/connections 2024-01-01-preview

  • Article

Bicep resource definition

The workspaces/connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/connections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections@2024-01-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    category: 'string'
    expiryTime: 'string'
    isSharedToAll: bool
    metadata: any()
    sharedUserList: [
      'string'
    ]
    target: 'string'
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 objects

Set the authType property to specify the type of object.

For AAD, use:

  authType: 'AAD'

For AccessKey, use:

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

For AccountKey, use:

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

For ApiKey, use:

  authType: 'ApiKey'
  credentials: {
    key: 'string'
  }

For CustomKeys, use:

  authType: 'CustomKeys'
  credentials: {
    keys: {
    {customized property}: 'string'
  }

For ManagedIdentity, use:

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

For None, use:

  authType: 'None'

For OAuth2, use:

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

For PAT, use:

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

For SAS, use:

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

For ServicePrincipal, use:

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

For UsernamePassword, use:

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

Property values

workspaces/connections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: workspaces
properties WorkspaceConnectionPropertiesV2 (required)

WorkspaceConnectionPropertiesV2

Name Description Value
category Category of the connection 'ADLSGen2'
'AmazonMws'
'AmazonRdsForOracle'
'AmazonRdsForSqlServer'
'AmazonRedshift'
'AmazonS3Compatible'
'ApiKey'
'AzureBlob'
'AzureDataExplorer'
'AzureDatabricksDeltaLake'
'AzureMariaDb'
'AzureMySqlDb'
'AzureOneLake'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSqlMi'
'AzureSynapseAnalytics'
'AzureTableStorage'
'Cassandra'
'CognitiveSearch'
'CognitiveService'
'Concur'
'ContainerRegistry'
'CosmosDb'
'CosmosDbMongoDbApi'
'Couchbase'
'CustomKeys'
'Db2'
'Drill'
'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'
'Oracle'
'OracleCloudStorage'
'OracleServiceCloud'
'PayPal'
'Phoenix'
'PostgreSql'
'Presto'
'PythonFeed'
'QuickBooks'
'Redis'
'Responsys'
'S3'
'Salesforce'
'SalesforceMarketingCloud'
'SalesforceServiceCloud'
'SapBw'
'SapCloudForCustomer'
'SapEcc'
'SapHana'
'SapOpenHub'
'SapTable'
'ServiceNow'
'Sftp'
'SharePointOnlineList'
'Shopify'
'Snowflake'
'Spark'
'SqlServer'
'Square'
'Sybase'
'Teradata'
'Vertica'
'WebTable'
'Xero'
'Zoho'
expiryTime string
isSharedToAll bool
metadata Any object For Bicep, you can use the any() function.
sharedUserList string[]
target string
authType Set the object type AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
None
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword (required)

AADAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'AAD' (required)

AccessKeyAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'AccessKey' (required)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Name Description Value
accessKeyId string
secretAccessKey string

AccountKeyAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'AccountKey' (required)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Name Description Value
sas string

ApiKeyAuthWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'ApiKey' (required)
credentials Api key object for workspace connection credential. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Name Description Value
key string

CustomKeysWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'CustomKeys' (required)
credentials Custom Keys credential object CustomKeys

CustomKeys

Name Description Value
keys Dictionary of {string} CustomKeys
{customized property} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'ManagedIdentity' (required)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Name Description Value
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'None' (required)

OAuth2AuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'OAuth2' (required)
credentials ClientId and ClientSecret are required. Other properties are optional
depending on each OAuth2 provider's implementation.
 WorkspaceConnectionOAuth2

WorkspaceConnectionOAuth2

Name Description Value
authUrl Required by Concur connection category string
clientId Client id in the format of UUID string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
developerToken Required by GoogleAdWords connection category string

Constraints:
Sensitive value. Pass in as a secure parameter.
password string

Constraints:
Sensitive value. Pass in as a secure parameter.
refreshToken Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho
where user needs to get RefreshToken offline		 string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId Required by QuickBooks and Xero connection categories string
username Concur, ServiceNow auth server AccessToken grant type is 'Password'
which requires UsernamePassword
 string

PATAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'PAT' (required)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Name Description Value
pat string

SASAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'SAS' (required)
credentials WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Name Description Value
authType Authentication type of the connection target 'ServicePrincipal' (required)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Name Description Value
clientId string
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Name Description Value
authType Authentication type of the connection target 'UsernamePassword' (required)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Name Description Value
password string
securityToken Optional, required by connections like SalesForce for extra security in addition to UsernamePassword string

Constraints:
Sensitive value. Pass in as a secure parameter.
username string

ARM template resource definition

The workspaces/connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/connections resource, add the following JSON to your template.

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

WorkspaceConnectionPropertiesV2 objects

Set the authType property to specify the type of object.

For AAD, use:

  "authType": "AAD"

For AccessKey, use:

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

For AccountKey, use:

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

For ApiKey, use:

  "authType": "ApiKey",
  "credentials": {
    "key": "string"
  }

For CustomKeys, use:

  "authType": "CustomKeys",
  "credentials": {
    "keys": {
    "{customized property}": "string"
  }

For ManagedIdentity, use:

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

For None, use:

  "authType": "None"

For OAuth2, use:

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

For PAT, use:

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

For SAS, use:

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

For ServicePrincipal, use:

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

For UsernamePassword, use:

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

Property values

workspaces/connections

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/workspaces/connections'
apiVersion The resource api version '2024-01-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties WorkspaceConnectionPropertiesV2 (required)

WorkspaceConnectionPropertiesV2

Name Description Value
category Category of the connection 'ADLSGen2'
'AmazonMws'
'AmazonRdsForOracle'
'AmazonRdsForSqlServer'
'AmazonRedshift'
'AmazonS3Compatible'
'ApiKey'
'AzureBlob'
'AzureDataExplorer'
'AzureDatabricksDeltaLake'
'AzureMariaDb'
'AzureMySqlDb'
'AzureOneLake'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSqlMi'
'AzureSynapseAnalytics'
'AzureTableStorage'
'Cassandra'
'CognitiveSearch'
'CognitiveService'
'Concur'
'ContainerRegistry'
'CosmosDb'
'CosmosDbMongoDbApi'
'Couchbase'
'CustomKeys'
'Db2'
'Drill'
'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'
'Oracle'
'OracleCloudStorage'
'OracleServiceCloud'
'PayPal'
'Phoenix'
'PostgreSql'
'Presto'
'PythonFeed'
'QuickBooks'
'Redis'
'Responsys'
'S3'
'Salesforce'
'SalesforceMarketingCloud'
'SalesforceServiceCloud'
'SapBw'
'SapCloudForCustomer'
'SapEcc'
'SapHana'
'SapOpenHub'
'SapTable'
'ServiceNow'
'Sftp'
'SharePointOnlineList'
'Shopify'
'Snowflake'
'Spark'
'SqlServer'
'Square'
'Sybase'
'Teradata'
'Vertica'
'WebTable'
'Xero'
'Zoho'
expiryTime string
isSharedToAll bool
metadata Any object
sharedUserList string[]
target string
authType Set the object type AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
None
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword (required)

AADAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'AAD' (required)

AccessKeyAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'AccessKey' (required)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Name Description Value
accessKeyId string
secretAccessKey string

AccountKeyAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'AccountKey' (required)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Name Description Value
sas string

ApiKeyAuthWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'ApiKey' (required)
credentials Api key object for workspace connection credential. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Name Description Value
key string

CustomKeysWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'CustomKeys' (required)
credentials Custom Keys credential object CustomKeys

CustomKeys

Name Description Value
keys Dictionary of {string} CustomKeys
{customized property} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'ManagedIdentity' (required)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Name Description Value
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'None' (required)

OAuth2AuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'OAuth2' (required)
credentials ClientId and ClientSecret are required. Other properties are optional
depending on each OAuth2 provider's implementation.
 WorkspaceConnectionOAuth2

WorkspaceConnectionOAuth2

Name Description Value
authUrl Required by Concur connection category string
clientId Client id in the format of UUID string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
developerToken Required by GoogleAdWords connection category string

Constraints:
Sensitive value. Pass in as a secure parameter.
password string

Constraints:
Sensitive value. Pass in as a secure parameter.
refreshToken Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho
where user needs to get RefreshToken offline		 string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId Required by QuickBooks and Xero connection categories string
username Concur, ServiceNow auth server AccessToken grant type is 'Password'
which requires UsernamePassword
 string

PATAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'PAT' (required)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Name Description Value
pat string

SASAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target 'SAS' (required)
credentials WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Name Description Value
authType Authentication type of the connection target 'ServicePrincipal' (required)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Name Description Value
clientId string
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Name Description Value
authType Authentication type of the connection target 'UsernamePassword' (required)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Name Description Value
password string
securityToken Optional, required by connections like SalesForce for extra security in addition to UsernamePassword string

Constraints:
Sensitive value. Pass in as a secure parameter.
username string

Terraform (AzAPI provider) resource definition

The workspaces/connections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/connections resource, add the following Terraform to your template.

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

WorkspaceConnectionPropertiesV2 objects

Set the authType property to specify the type of object.

For AAD, use:

  authType = "AAD"

For AccessKey, use:

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

For AccountKey, use:

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

For ApiKey, use:

  authType = "ApiKey"
  credentials = {
    key = "string"
  }

For CustomKeys, use:

  authType = "CustomKeys"
  credentials = {
    keys = {
    {customized property} = "string"
  }

For ManagedIdentity, use:

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

For None, use:

  authType = "None"

For OAuth2, use:

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

For PAT, use:

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

For SAS, use:

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

For ServicePrincipal, use:

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

For UsernamePassword, use:

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

Property values

workspaces/connections

Name Description Value
type The resource type "Microsoft.MachineLearningServices/workspaces/connections@2024-01-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties WorkspaceConnectionPropertiesV2 (required)

WorkspaceConnectionPropertiesV2

Name Description Value
category Category of the connection "ADLSGen2"
"AmazonMws"
"AmazonRdsForOracle"
"AmazonRdsForSqlServer"
"AmazonRedshift"
"AmazonS3Compatible"
"ApiKey"
"AzureBlob"
"AzureDataExplorer"
"AzureDatabricksDeltaLake"
"AzureMariaDb"
"AzureMySqlDb"
"AzureOneLake"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSqlMi"
"AzureSynapseAnalytics"
"AzureTableStorage"
"Cassandra"
"CognitiveSearch"
"CognitiveService"
"Concur"
"ContainerRegistry"
"CosmosDb"
"CosmosDbMongoDbApi"
"Couchbase"
"CustomKeys"
"Db2"
"Drill"
"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"
"Oracle"
"OracleCloudStorage"
"OracleServiceCloud"
"PayPal"
"Phoenix"
"PostgreSql"
"Presto"
"PythonFeed"
"QuickBooks"
"Redis"
"Responsys"
"S3"
"Salesforce"
"SalesforceMarketingCloud"
"SalesforceServiceCloud"
"SapBw"
"SapCloudForCustomer"
"SapEcc"
"SapHana"
"SapOpenHub"
"SapTable"
"ServiceNow"
"Sftp"
"SharePointOnlineList"
"Shopify"
"Snowflake"
"Spark"
"SqlServer"
"Square"
"Sybase"
"Teradata"
"Vertica"
"WebTable"
"Xero"
"Zoho"
expiryTime string
isSharedToAll bool
metadata Any object
sharedUserList string[]
target string
authType Set the object type AAD
AccessKey
AccountKey
ApiKey
CustomKeys
ManagedIdentity
None
OAuth2
PAT
SAS
ServicePrincipal
UsernamePassword (required)

AADAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "AAD" (required)

AccessKeyAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "AccessKey" (required)
credentials WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Name Description Value
accessKeyId string
secretAccessKey string

AccountKeyAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "AccountKey" (required)
credentials WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Name Description Value
sas string

ApiKeyAuthWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "ApiKey" (required)
credentials Api key object for workspace connection credential. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Name Description Value
key string

CustomKeysWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "CustomKeys" (required)
credentials Custom Keys credential object CustomKeys

CustomKeys

Name Description Value
keys Dictionary of {string} CustomKeys
{customized property} string

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "ManagedIdentity" (required)
credentials WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Name Description Value
clientId string
resourceId string

NoneAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "None" (required)

OAuth2AuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "OAuth2" (required)
credentials ClientId and ClientSecret are required. Other properties are optional
depending on each OAuth2 provider's implementation.
 WorkspaceConnectionOAuth2

WorkspaceConnectionOAuth2

Name Description Value
authUrl Required by Concur connection category string
clientId Client id in the format of UUID string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
developerToken Required by GoogleAdWords connection category string

Constraints:
Sensitive value. Pass in as a secure parameter.
password string

Constraints:
Sensitive value. Pass in as a secure parameter.
refreshToken Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho
where user needs to get RefreshToken offline		 string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId Required by QuickBooks and Xero connection categories string
username Concur, ServiceNow auth server AccessToken grant type is 'Password'
which requires UsernamePassword
 string

PATAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "PAT" (required)
credentials WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Name Description Value
pat string

SASAuthTypeWorkspaceConnectionProperties

Name Description Value
authType Authentication type of the connection target "SAS" (required)
credentials WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Name Description Value
authType Authentication type of the connection target "ServicePrincipal" (required)
credentials WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Name Description Value
clientId string
clientSecret string

Constraints:
Sensitive value. Pass in as a secure parameter.
tenantId string

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Name Description Value
authType Authentication type of the connection target "UsernamePassword" (required)
credentials WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Name Description Value
password string
securityToken Optional, required by connections like SalesForce for extra security in addition to UsernamePassword string

Constraints:
Sensitive value. Pass in as a secure parameter.
username string