API version change log for deployment of Microsoft.MachineLearningServices/workspaces/connections

This article describes the properties that changed in each API version for Microsoft.MachineLearningServices/workspaces/connections. It only covers properties that are available during deployments.

2024-07-01-preview

Added:

• properties.error
• properties.peRequirement
• properties.peStatus
• properties.useWorkspaceManagedIdentity

Removed:

• properties.value
• properties.valueFormat

2024-04-01

Added:

• properties.value
• properties.valueFormat

Updated:

• properties.category - Added values: 'AIServices'

2024-04-01-preview

Added:

• properties.metadata.{customized property}

Removed:

• properties.credentials.sas

Updated:

• properties.category - Added values: 'BingLLMSearch' 'OpenAI' 'Serp' 'Serverless'
• properties.authType - Removed values: 'AAD' (required) 'AccessKey' (required)

2024-01-01-preview

Added:

• properties.expiryTime
• properties.isSharedToAll
• properties.metadata
• properties.sharedUserList
• properties.credentials.accessKeyId
• properties.credentials.secretAccessKey
• properties.credentials.key
• properties.credentials.keys
• properties.credentials.keys.{customized property}
• properties.credentials.authType
• properties.credentials.credentials
• properties.credentials.credentials.clientId
• properties.credentials.credentials.resourceId
• properties.credentials.credentials.authUrl
• properties.credentials.credentials.clientSecret
• properties.credentials.credentials.developerToken
• properties.credentials.credentials.password
• properties.credentials.credentials.refreshToken
• properties.credentials.credentials.tenantId
• properties.credentials.credentials.username
• properties.credentials.credentials.pat
• properties.credentials.credentials.sas
• properties.credentials.credentials.securityToken

Removed:

• properties.value
• properties.valueFormat
• properties.credentials.clientId
• properties.credentials.resourceId
• properties.credentials.pat
• properties.credentials.password
• properties.credentials.username

Updated:

• properties.category - Added values: 'ADLSGen2' 'AmazonMws' 'AmazonRdsForOracle' 'AmazonRdsForSqlServer' 'AmazonRedshift' 'AmazonS3Compatible' 'ApiKey' 'AzureBlob' 'AzureDataExplorer' 'AzureDatabricksDeltaLake' 'AzureMariaDb' 'AzureMySqlDb' 'AzureOneLake' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSqlMi' 'AzureSynapseAnalytics' 'AzureTableStorage' 'Cassandra' 'CognitiveSearch' 'CognitiveService' 'Concur' 'CosmosDb' 'CosmosDbMongoDbApi' 'Couchbase' 'CustomKeys' 'Db2' 'Drill' 'Dynamics' 'DynamicsAx' 'DynamicsCrm' 'Eloqua' 'FileServer' 'FtpServer' 'GenericContainerRegistry' 'GenericHttp' 'GenericRest' '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' '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'
• properties.authType - Added values: 'AAD' (required) 'AccessKey' (required) - Removed values: 'ManagedIdentity' (required)
• properties.credentials.credentials.authType - Added values: 'ApiKey' (required) - Removed values: 'SAS' (required)
• properties.credentials.credentials.credentials.authType - Added values: 'CustomKeys' (required) - Removed values: 'UsernamePassword' (required)

2023-10-01

Added:

• properties.value
• properties.valueFormat
• properties.credentials.clientId
• properties.credentials.resourceId
• properties.credentials.pat
• properties.credentials.sas
• properties.credentials.password
• properties.credentials.username

Removed:

• properties.expiryTime
• properties.isSharedToAll
• properties.metadata
• properties.credentials.accessKeyId
• properties.credentials.secretAccessKey
• properties.credentials.key
• properties.credentials.keys
• properties.credentials.keys.{customized property}
• properties.credentials.authType
• properties.credentials.credentials
• properties.credentials.credentials.clientId
• properties.credentials.credentials.resourceId
• properties.credentials.credentials.pat
• properties.credentials.credentials.sas
• properties.credentials.credentials.clientSecret
• properties.credentials.credentials.tenantId
• properties.credentials.credentials.password
• properties.credentials.credentials.username

Updated:

• properties.category - Removed values: 'ADLSGen2' 'ApiKey' 'AzureMySqlDb' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'CognitiveSearch' 'CognitiveService' 'CustomKeys' 'Redis' 'S3' 'Snowflake'
• properties.authType - Added values: 'ManagedIdentity' (required) - Removed values: 'AccessKey' (required)
• properties.credentials.authType - Added values: 'None' (required) 'PAT' (required) - Removed values: 'ApiKey' (required)
• properties.credentials.credentials.authType - Added values: 'SAS' (required) - Removed values: 'CustomKeys' (required)
• properties.credentials.credentials.credentials.authType - Added values: 'UsernamePassword' (required) - Removed values: 'ManagedIdentity' (required)

2023-08-01-preview

Added:

• properties.isSharedToAll

2023-06-01-preview

Added:

• properties.expiryTime
• properties.metadata
• properties.credentials.accessKeyId
• properties.credentials.secretAccessKey
• properties.credentials.key
• properties.credentials.keys
• properties.credentials.keys.{customized property}
• properties.credentials.authType
• properties.credentials.credentials
• properties.credentials.credentials.clientId
• properties.credentials.credentials.resourceId
• properties.credentials.credentials.pat
• properties.credentials.credentials.sas
• properties.credentials.credentials.clientSecret
• properties.credentials.credentials.tenantId
• properties.credentials.credentials.password
• properties.credentials.credentials.username

Removed:

• properties.value
• properties.valueFormat
• properties.credentials.clientId
• properties.credentials.resourceId
• properties.credentials.pat
• properties.credentials.sas
• properties.credentials.password
• properties.credentials.username

Updated:

• properties.category - Added values: 'ADLSGen2' 'ApiKey' 'AzureMySqlDb' 'AzureOpenAI' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'CognitiveSearch' 'CognitiveService' 'CustomKeys' 'Redis' 'S3' 'Snowflake'
• properties.authType - Added values: 'AccessKey' (required) - Removed values: 'ManagedIdentity' (required)
• properties.credentials.credentials.authType - Added values: 'CustomKeys' (required) - Removed values: 'SAS' (required)
• properties.credentials.credentials.credentials.authType - Added values: 'ManagedIdentity' (required) - Removed values: 'UsernamePassword' (required)

2023-04-01

Removed:

• properties.expiryTime
• properties.credentials.accessKeyId
• properties.credentials.secretAccessKey
• properties.credentials.clientSecret
• properties.credentials.tenantId

Updated:

• properties.category - Removed values: 'AzureDataLakeGen2' 'AzureMySqlDb' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'FeatureStore' 'Redis' 'S3' 'Snowflake'
• properties.authType - Added values: 'ManagedIdentity' (required) - Removed values: 'AccessKey' (required)
• properties.credentials.authType - Added values: 'None' (required) 'PAT' (required) - Removed values: 'ManagedIdentity' (required)
• properties.credentials.credentials.authType - Added values: 'SAS' (required) - Removed values: 'None' (required) 'PAT' (required)
• properties.credentials.credentials.credentials.authType - Added values: 'UsernamePassword' (required) - Removed values: 'SAS' (required)

2023-04-01-preview

Added:

• properties.expiryTime

2023-02-01-preview

No new or updated properties

2022-12-01-preview

Added:

• properties.credentials.accessKeyId
• properties.credentials.secretAccessKey
• properties.credentials.clientSecret
• properties.credentials.tenantId

Updated:

• properties.category - Added values: 'AzureDataLakeGen2' 'AzureMySqlDb' 'AzurePostgresDb' 'AzureSqlDb' 'AzureSynapseAnalytics' 'FeatureStore' 'Redis' 'S3' 'Snowflake'
• properties.authType - Added values: 'AccessKey' (required) - Removed values: 'ManagedIdentity' (required)
• properties.credentials.authType - Added values: 'ManagedIdentity' (required) - Removed values: 'None' (required) 'PAT' (required)
• properties.credentials.credentials.authType - Added values: 'None' (required) 'PAT' (required) - Removed values: 'SAS' (required)
• properties.credentials.credentials.credentials.authType - Added values: 'SAS' (required) - Removed values: 'UsernamePassword' (required)

2022-10-01

Removed:

• properties.credentials.accessKeyId
• properties.credentials.secretAccessKey
• properties.credentials.clientSecret
• properties.credentials.tenantId

Updated:

• properties.category - Added values: 'ContainerRegistry' 'Git' 'PythonFeed'
• properties.authType - Added values: 'ManagedIdentity' (required) - Removed values: 'AccessKey' (required)
• properties.credentials.authType - Added values: 'None' (required) 'PAT' (required) - Removed values: 'ManagedIdentity' (required)
• properties.credentials.credentials.authType - Added values: 'SAS' (required) - Removed values: 'None' (required) 'PAT' (required)
• properties.credentials.credentials.credentials.authType - Added values: 'UsernamePassword' (required) - Removed values: 'SAS' (required)

2022-10-01-preview

Added:

• properties.credentials.accessKeyId
• properties.credentials.secretAccessKey
• properties.credentials.clientSecret
• properties.credentials.tenantId

Updated:

• properties.category - Removed values: 'ContainerRegistry' 'Git' 'PythonFeed'
• properties.authType - Added values: 'AccessKey' (required) - Removed values: 'ManagedIdentity' (required)
• properties.credentials.authType - Added values: 'ManagedIdentity' (required) - Removed values: 'None' (required) 'PAT' (required)
• properties.credentials.credentials.authType - Added values: 'None' (required) 'PAT' (required) - Removed values: 'SAS' (required)
• properties.credentials.credentials.credentials.authType - Added values: 'SAS' (required) - Removed values: 'UsernamePassword' (required)

2022-06-01-preview

No new or updated properties

2022-05-01

Added:

• properties.credentials
• properties.credentials.clientId
• properties.credentials.resourceId
• properties.credentials.pat
• properties.credentials.sas
• properties.credentials.password
• properties.credentials.username

Updated:

• properties changed to required.
• properties.category - Added values: 'ContainerRegistry' 'Git' 'PythonFeed'
• properties.authType - Added values: 'ManagedIdentity' (required)
• properties.authType changed to required.

2022-02-01-preview

No new or updated properties

2022-01-01-preview

No new or updated properties

2021-07-01

No new or updated properties

2021-04-01

No new or updated properties

2021-03-01-preview

No new or updated properties

2021-01-01

Added:

• properties.valueFormat

2020-09-01-preview

No new or updated properties

2020-08-01

No new or updated properties

2020-06-01

Oldest version tracked in change log