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

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

2024-07-01-preview

Added:

• properties.allowRoleAssignmentOnRG
• properties.containerRegistries
• properties.enableServiceSideCMKEncryption
• properties.enableSimplifiedCmk
• properties.enableSoftwareBillOfMaterials
• properties.encryption.cosmosDbResourceId
• properties.encryption.searchAccountResourceId
• properties.encryption.storageAccountResourceId
• properties.existingWorkspaces
• properties.ipAllowlist
• properties.keyVaults
• properties.managedNetwork.outboundRules.parentRuleNames
• properties.managedNetwork.outboundRules.parentRuleNames.type
• properties.managedNetwork.outboundRules.parentRuleNames.destination
• properties.managedNetwork.outboundRules.parentRuleNames.destination.action
• properties.managedNetwork.outboundRules.parentRuleNames.destination.portRanges
• properties.managedNetwork.outboundRules.parentRuleNames.destination.protocol
• properties.managedNetwork.outboundRules.parentRuleNames.destination.serviceTag
• softDeleteRetentionInDays
• storageAccounts
• systemDatastoresAuthMode

Removed:

• properties.managedNetwork.outboundRules.destination.action
• properties.managedNetwork.outboundRules.destination.portRanges
• properties.managedNetwork.outboundRules.destination.protocol
• properties.managedNetwork.outboundRules.destination.serviceTag

Updated:

• properties changed to required.

2024-04-01

Removed:

• properties.containerRegistries
• properties.enableSoftwareBillOfMaterials
• properties.encryption.cosmosDbResourceId
• properties.encryption.searchAccountResourceId
• properties.encryption.storageAccountResourceId
• properties.existingWorkspaces
• properties.ipAllowlist
• properties.keyVaults
• softDeleteRetentionInDays
• storageAccounts
• systemDatastoresAuthMode

Updated:

• properties changed to not required.

2024-04-01-preview

Updated:

• properties.managedNetwork.outboundRules.{customized property}.category - Added values: 'Dependency'

2024-01-01-preview

Added:

• properties.associatedWorkspaces
• properties.containerRegistries
• properties.enableDataIsolation
• properties.enableSoftwareBillOfMaterials
• properties.encryption.cosmosDbResourceId
• properties.encryption.searchAccountResourceId
• properties.encryption.storageAccountResourceId
• properties.existingWorkspaces
• properties.hubResourceId
• properties.ipAllowlist
• properties.keyVaults
• softDeleteRetentionInDays
• storageAccounts
• systemDatastoresAuthMode
• workspaceHubConfig
• workspaceHubConfig.additionalWorkspaceStorageAccounts
• workspaceHubConfig.defaultWorkspaceResourceGroup

Updated:

• properties changed to required.

2023-10-01

Removed:

• properties.associatedWorkspaces
• properties.containerRegistries
• properties.enableDataIsolation
• properties.encryption.cosmosDbResourceId
• properties.encryption.searchAccountResourceId
• properties.encryption.storageAccountResourceId
• properties.existingWorkspaces
• properties.hubResourceId
• properties.keyVaults
• softDeleteRetentionInDays
• storageAccounts
• systemDatastoresAuthMode
• workspaceHubConfig
• workspaceHubConfig.additionalWorkspaceStorageAccounts
• workspaceHubConfig.defaultWorkspaceResourceGroup

Updated:

• properties changed to not required.

2023-08-01-preview

Added:

• serverlessComputeSettings
• serverlessComputeSettings.serverlessComputeCustomSubnet
• serverlessComputeSettings.serverlessComputeNoPublicIP

2023-06-01-preview

Added:

• kind
• properties.associatedWorkspaces
• properties.containerRegistries
• properties.enableDataIsolation
• properties.encryption.cosmosDbResourceId
• properties.encryption.searchAccountResourceId
• properties.encryption.storageAccountResourceId
• properties.existingWorkspaces
• properties.featureStoreSettings
• properties.featureStoreSettings.computeRuntime
• properties.featureStoreSettings.computeRuntime.sparkRuntimeVersion
• properties.featureStoreSettings.offlineStoreConnectionName
• properties.featureStoreSettings.onlineStoreConnectionName
• properties.hubResourceId
• properties.keyVaults
• properties.managedNetwork
• properties.managedNetwork.isolationMode
• properties.managedNetwork.outboundRules
• properties.managedNetwork.outboundRules.{customized property}
• properties.managedNetwork.outboundRules.category
• properties.managedNetwork.outboundRules.status
• properties.managedNetwork.outboundRules.type
• properties.managedNetwork.outboundRules.destination
• properties.managedNetwork.outboundRules.destination.serviceResourceId
• properties.managedNetwork.outboundRules.destination.sparkEnabled
• properties.managedNetwork.outboundRules.destination.sparkStatus
• properties.managedNetwork.outboundRules.destination.subresourceTarget
• properties.managedNetwork.outboundRules.destination.action
• properties.managedNetwork.outboundRules.destination.portRanges
• properties.managedNetwork.outboundRules.destination.protocol
• properties.managedNetwork.outboundRules.destination.serviceTag
• properties.status
• properties.status.sparkReady
• properties.status.status
• primaryUserAssignedIdentity
• publicNetworkAccess
• serviceManagedResourcesSettings
• serviceManagedResourcesSettings.cosmosDb
• serviceManagedResourcesSettings.cosmosDb.collectionsThroughput
• sharedPrivateLinkResources
• sharedPrivateLinkResources.name
• sharedPrivateLinkResources.properties
• sharedPrivateLinkResources.properties.groupId
• sharedPrivateLinkResources.properties.privateLinkResourceId
• sharedPrivateLinkResources.properties.requestMessage
• sharedPrivateLinkResources.properties.status
• softDeleteRetentionInDays
• storageAccounts
• systemDatastoresAuthMode
• workspaceHubConfig
• workspaceHubConfig.additionalWorkspaceStorageAccounts
• workspaceHubConfig.defaultWorkspaceResourceGroup

Removed:

• properties.primaryUserAssignedIdentity
• properties.publicNetworkAccess
• properties.serviceManagedResourcesSettings
• properties.serviceManagedResourcesSettings.cosmosDb
• properties.serviceManagedResourcesSettings.cosmosDb.collectionsThroughput
• properties.sharedPrivateLinkResources
• properties.sharedPrivateLinkResources.name
• properties.sharedPrivateLinkResources.properties
• properties.sharedPrivateLinkResources.properties.groupId
• properties.sharedPrivateLinkResources.properties.privateLinkResourceId
• properties.sharedPrivateLinkResources.properties.requestMessage
• properties.sharedPrivateLinkResources.properties.status

Updated:

• properties changed to required.

2023-04-01

Added:

• properties.primaryUserAssignedIdentity
• properties.publicNetworkAccess
• properties.serviceManagedResourcesSettings
• properties.serviceManagedResourcesSettings.cosmosDb
• properties.serviceManagedResourcesSettings.cosmosDb.collectionsThroughput
• properties.sharedPrivateLinkResources
• properties.sharedPrivateLinkResources.name
• properties.sharedPrivateLinkResources.properties
• properties.sharedPrivateLinkResources.properties.groupId
• properties.sharedPrivateLinkResources.properties.privateLinkResourceId
• properties.sharedPrivateLinkResources.properties.requestMessage
• properties.sharedPrivateLinkResources.properties.status

Removed:

• kind
• properties.containerRegistries
• properties.enableDataIsolation
• properties.existingWorkspaces
• properties.featureStoreSettings
• properties.featureStoreSettings.computeRuntime
• properties.featureStoreSettings.computeRuntime.sparkRuntimeVersion
• properties.featureStoreSettings.offlineStoreConnectionName
• properties.featureStoreSettings.onlineStoreConnectionName
• properties.hubResourceId
• properties.keyVaults
• properties.managedNetwork
• properties.managedNetwork.isolationMode
• properties.managedNetwork.outboundRules
• properties.managedNetwork.outboundRules.{customized property}
• properties.managedNetwork.outboundRules.category
• properties.managedNetwork.outboundRules.status
• properties.managedNetwork.outboundRules.type
• properties.managedNetwork.outboundRules.destination
• properties.managedNetwork.outboundRules.destination.serviceResourceId
• properties.managedNetwork.outboundRules.destination.sparkEnabled
• properties.managedNetwork.outboundRules.destination.sparkStatus
• properties.managedNetwork.outboundRules.destination.subresourceTarget
• properties.managedNetwork.outboundRules.destination.portRanges
• properties.managedNetwork.outboundRules.destination.protocol
• properties.managedNetwork.outboundRules.destination.serviceTag
• properties.status
• properties.status.sparkReady
• properties.status.status
• primaryUserAssignedIdentity
• publicNetworkAccess
• serviceManagedResourcesSettings
• serviceManagedResourcesSettings.cosmosDb
• serviceManagedResourcesSettings.cosmosDb.collectionsThroughput
• sharedPrivateLinkResources
• sharedPrivateLinkResources.name
• sharedPrivateLinkResources.properties
• sharedPrivateLinkResources.properties.groupId
• sharedPrivateLinkResources.properties.privateLinkResourceId
• sharedPrivateLinkResources.properties.requestMessage
• sharedPrivateLinkResources.properties.status
• softDeleteRetentionInDays
• storageAccounts
• systemDatastoresAuthMode

2023-04-01-preview

Added:

• properties.containerRegistries
• properties.enableDataIsolation
• properties.existingWorkspaces
• properties.hubResourceId
• properties.keyVaults
• properties.managedNetwork
• properties.managedNetwork.isolationMode
• properties.managedNetwork.outboundRules
• properties.managedNetwork.outboundRules.{customized property}
• properties.managedNetwork.outboundRules.category
• properties.managedNetwork.outboundRules.status
• properties.managedNetwork.outboundRules.type
• properties.managedNetwork.outboundRules.destination
• properties.managedNetwork.outboundRules.destination.serviceResourceId
• properties.managedNetwork.outboundRules.destination.sparkEnabled
• properties.managedNetwork.outboundRules.destination.sparkStatus
• properties.managedNetwork.outboundRules.destination.subresourceTarget
• properties.managedNetwork.outboundRules.destination.portRanges
• properties.managedNetwork.outboundRules.destination.protocol
• properties.managedNetwork.outboundRules.destination.serviceTag
• properties.status
• properties.status.sparkReady
• properties.status.status
• primaryUserAssignedIdentity
• publicNetworkAccess
• serviceManagedResourcesSettings
• serviceManagedResourcesSettings.cosmosDb
• serviceManagedResourcesSettings.cosmosDb.collectionsThroughput
• sharedPrivateLinkResources
• sharedPrivateLinkResources.name
• sharedPrivateLinkResources.properties
• sharedPrivateLinkResources.properties.groupId
• sharedPrivateLinkResources.properties.privateLinkResourceId
• sharedPrivateLinkResources.properties.requestMessage
• sharedPrivateLinkResources.properties.status
• storageAccounts

Removed:

• properties.primaryUserAssignedIdentity
• properties.publicNetworkAccess
• properties.serviceManagedResourcesSettings
• properties.serviceManagedResourcesSettings.cosmosDb
• properties.serviceManagedResourcesSettings.cosmosDb.collectionsThroughput
• properties.sharedPrivateLinkResources
• properties.sharedPrivateLinkResources.name
• properties.sharedPrivateLinkResources.properties
• properties.sharedPrivateLinkResources.properties.groupId
• properties.sharedPrivateLinkResources.properties.privateLinkResourceId
• properties.sharedPrivateLinkResources.properties.requestMessage
• properties.sharedPrivateLinkResources.properties.status

2023-02-01-preview

Added:

• softDeleteRetentionInDays

Removed:

• properties.featureStoreSettings.allowRoleAssignmentsOnResourceGroupLevel

2022-12-01-preview

Added:

• kind
• properties.featureStoreSettings
• properties.featureStoreSettings.allowRoleAssignmentsOnResourceGroupLevel
• properties.featureStoreSettings.computeRuntime
• properties.featureStoreSettings.computeRuntime.sparkRuntimeVersion
• properties.featureStoreSettings.offlineStoreConnectionName
• properties.featureStoreSettings.onlineStoreConnectionName
• systemDatastoresAuthMode

2022-10-01

No new or updated properties

2022-10-01-preview

No new or updated properties

2022-06-01-preview

No new or updated properties

2022-05-01

Added:

• v1LegacyMode

2022-02-01-preview

Added:

• sku.capacity
• sku.family
• sku.size

Removed:

• properties.allowRecoverSoftDeletedWorkspace
• properties.encryption.cosmosDbResourceId
• properties.encryption.searchAccountResourceId
• properties.encryption.storageAccountResourceId
• softDeleteEnabled

Updated:

• identity.type - Added values: 'UserAssigned' (required) - Removed values: 'UserAssigned'
• identity.type changed to required.
• sku.name changed to required.
• sku.tier - Added values: 'Basic' 'Free' 'Premium' 'Standard'

2022-01-01-preview

Added:

• properties.allowRecoverSoftDeletedWorkspace
• properties.encryption.cosmosDbResourceId
• properties.encryption.searchAccountResourceId
• properties.encryption.storageAccountResourceId
• softDeleteEnabled

2021-07-01

Added:

• properties.publicNetworkAccess

2021-04-01

No new or updated properties

2021-03-01-preview

Updated:

• properties.encryption.identity.userAssignedIdentity changed to not required.

2021-01-01

Added:

• properties.encryption.identity
• properties.encryption.identity.userAssignedIdentity
• properties.primaryUserAssignedIdentity
• properties.serviceManagedResourcesSettings
• properties.serviceManagedResourcesSettings.cosmosDb
• properties.serviceManagedResourcesSettings.cosmosDb.collectionsThroughput

2020-09-01-preview

Updated:

• identity.type - Added values: 'UserAssigned' - Removed values: 'UserAssigned' (required)
• identity.type changed to not required.

2020-08-01

No new or updated properties

2020-06-01

Updated:

• identity.type - Added values: 'UserAssigned' (required) - Removed values: 'UserAssigned'
• identity.type changed to required.

2020-05-15-preview

No new or updated properties

2020-05-01-preview

Updated:

• identity.type - Added values: 'UserAssigned' - Removed values: 'UserAssigned' (required)
• identity.type changed to not required.

2020-04-01

Updated:

• identity.type - Added values: 'UserAssigned' (required) - Removed values: 'UserAssigned'
• identity.type changed to required.

2020-03-01

Added:

• identity.userAssignedIdentities
• identity.userAssignedIdentities.{customized property}
• properties.allowPublicAccessWhenBehindVnet
• properties.imageBuildCompute
• properties.sharedPrivateLinkResources
• properties.sharedPrivateLinkResources.name
• properties.sharedPrivateLinkResources.properties
• properties.sharedPrivateLinkResources.properties.groupId
• properties.sharedPrivateLinkResources.properties.privateLinkResourceId
• properties.sharedPrivateLinkResources.properties.requestMessage
• properties.sharedPrivateLinkResources.properties.status
• storageAccount

Removed:

• properties.storageAccount

Updated:

• identity.type - Added values: 'None' 'SystemAssigned,UserAssigned' 'UserAssigned'

2020-02-18-preview

No new or updated properties

2020-01-01

Added:

• properties.encryption
• properties.encryption.keyVaultProperties
• properties.encryption.keyVaultProperties.identityClientId
• properties.encryption.keyVaultProperties.keyIdentifier
• properties.encryption.keyVaultProperties.keyVaultArmId
• properties.encryption.status
• properties.hbiWorkspace

2019-11-01

Added:

• sku
• sku.name
• sku.tier

2019-06-01

No new or updated properties

2019-05-01

No new or updated properties

2018-11-19

Removed:

• properties.batchaiWorkspace

2018-03-01-preview

Oldest version tracked in change log