Workspaces - Update

Service:

Machine Learning

API Version:

2024-10-01

Updates a machine learning workspace with the specified parameters.

HTTP

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	Name of Azure Machine Learning workspace. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
identity	ManagedServiceIdentity	The identity of the resource.
properties.applicationInsights	string	ARM id of the application insights associated with this workspace.
properties.containerRegistry	string	ARM id of the container registry associated with this workspace.
properties.description	string	The description of this workspace.
properties.enableDataIsolation	boolean
properties.encryption	EncryptionUpdateProperties
properties.featureStoreSettings	FeatureStoreSettings	Settings for feature store type workspace.
properties.friendlyName	string	The friendly name for this workspace.
properties.imageBuildCompute	string	The compute name for image build
properties.managedNetwork	ManagedNetworkSettings	Managed Network settings for a machine learning workspace.
properties.primaryUserAssignedIdentity	string	The user assigned identity resource id that represents the workspace identity.
properties.publicNetworkAccess	PublicNetworkAccess	Whether requests from Public Network are allowed.
properties.serverlessComputeSettings	ServerlessComputeSettings	Settings for serverless compute created in the workspace
properties.serviceManagedResourcesSettings	ServiceManagedResourcesSettings	The service managed resource settings.
properties.v1LegacyMode	boolean	Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
sku	Sku	The sku of the workspace.
tags	object	The resource tags for the machine learning workspace.

Responses

Name	Type	Description
200 OK	Workspace	The request was successful; the request was well-formed and received properly.
202 Accepted		Accepted Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Error response describing why the operation failed

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Update Workspace

Sample request

HTTP

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace?api-version=2024-10-01

{
  "properties": {
    "friendlyName": "New friendly name",
    "description": "new description",
    "publicNetworkAccess": "Disabled"
  }
}

Sample response

Status code:

200

JSON

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace",
  "name": "testworkspace",
  "type": "Microsoft.MachineLearningServices/workspaces",
  "location": "eastus2euap",
  "identity": {
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "type": "SystemAssigned"
  },
  "properties": {
    "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry",
    "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv",
    "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights",
    "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount",
    "discoveryUrl": "http://example.com",
    "friendlyName": "New friendly name",
    "description": "new description",
    "publicNetworkAccess": "Disabled"
  }
}

Status code:

202

HTTP

Location: example_location

Definitions

Name	Description
ComputeRuntimeDto	Compute runtime config for feature store type workspace.
CosmosDbSettings
createdByType	The type of identity that created the resource.
EncryptionKeyVaultProperties
EncryptionKeyVaultUpdateProperties
EncryptionProperty
EncryptionStatus	Indicates whether or not the encryption is enabled for the workspace.
EncryptionUpdateProperties
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FeatureStoreSettings	Settings for feature store type workspace.
FirewallSku	Firewall Sku used for FQDN Rules
FqdnOutboundRule	FQDN Outbound Rule for the managed network of a machine learning workspace.
IdentityForCmk	Identity that will be used to access key vault for encryption at rest
IsolationMode	Isolation mode for the managed network of a machine learning workspace.
ManagedNetworkProvisionStatus	Status of the Provisioning for the managed network of a machine learning workspace.
ManagedNetworkSettings	Managed Network settings for a machine learning workspace.
ManagedNetworkStatus	Status for the managed network of a machine learning workspace.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
NotebookPreparationError
NotebookResourceInfo
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointDestination	Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.
PrivateEndpointOutboundRule	Private Endpoint Outbound Rule for the managed network of a machine learning workspace.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProvisioningState	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
PublicNetworkAccess	Whether requests from Public Network are allowed.
RuleAction	The action enum for networking rule.
RuleCategory	Category of a managed network Outbound Rule of a machine learning workspace.
RuleStatus	Type of a managed network Outbound Rule of a machine learning workspace.
RuleType	Type of a managed network Outbound Rule of a machine learning workspace.
ServerlessComputeSettings
ServiceManagedResourcesSettings
ServiceTagDestination	Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.
ServiceTagOutboundRule	Service Tag Outbound Rule for the managed network of a machine learning workspace.
SharedPrivateLinkResource
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties
Workspace	An object that represents a machine learning workspace.
WorkspaceHubConfig	WorkspaceHub's configuration object.
WorkspaceUpdateParameters	The parameters for updating a machine learning workspace.

ComputeRuntimeDto

Object

Compute runtime config for feature store type workspace.

Name	Type	Description
sparkRuntimeVersion	string

CosmosDbSettings

Object

Name	Type	Description
collectionsThroughput	integer	The throughput of the collections in cosmosdb database

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

EncryptionKeyVaultProperties

Object

Name	Type	Description
identityClientId	string	For future use - The client id of the identity which will be used to access key vault.
keyIdentifier	string	Key vault uri to access the encryption key.
keyVaultArmId	string	The ArmId of the keyVault where the customer owned encryption key is present.

EncryptionKeyVaultUpdateProperties

Object

Name	Type	Description
keyIdentifier	string

EncryptionProperty

Object

Name	Type	Description
identity	IdentityForCmk	The identity that will be used to access the key vault for encryption at rest.
keyVaultProperties	EncryptionKeyVaultProperties	Customer Key vault properties.
status	EncryptionStatus	Indicates whether or not the encryption is enabled for the workspace.

EncryptionStatus

Enumeration

Indicates whether or not the encryption is enabled for the workspace.

Value	Description
Disabled
Enabled

EncryptionUpdateProperties

Object

Name	Type	Description
keyVaultProperties	EncryptionKeyVaultUpdateProperties

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

FeatureStoreSettings

Object

Settings for feature store type workspace.

Name	Type	Description
computeRuntime	ComputeRuntimeDto	Compute runtime config for feature store type workspace.
offlineStoreConnectionName	string
onlineStoreConnectionName	string

FirewallSku

Enumeration

Firewall Sku used for FQDN Rules

Value	Description
Basic
Standard

FqdnOutboundRule

Object

FQDN Outbound Rule for the managed network of a machine learning workspace.

Name	Type	Description
category	RuleCategory	Category of a managed network Outbound Rule of a machine learning workspace.
destination	string
status	RuleStatus	Type of a managed network Outbound Rule of a machine learning workspace.
type	string: FQDN	Type of a managed network Outbound Rule of a machine learning workspace.

IdentityForCmk

Object

Identity that will be used to access key vault for encryption at rest

Name	Type	Description
userAssignedIdentity	string	The ArmId of the user assigned identity that will be used to access the customer managed key vault

IsolationMode

Enumeration

Isolation mode for the managed network of a machine learning workspace.

Value	Description
AllowInternetOutbound
AllowOnlyApprovedOutbound
Disabled

ManagedNetworkProvisionStatus

Object

Status of the Provisioning for the managed network of a machine learning workspace.

Name	Type	Description
sparkReady	boolean
status	ManagedNetworkStatus	Status for the managed network of a machine learning workspace.

ManagedNetworkSettings

Object

Managed Network settings for a machine learning workspace.

Name	Type	Description
firewallSku	FirewallSku	Firewall Sku used for FQDN Rules
isolationMode	IsolationMode	Isolation mode for the managed network of a machine learning workspace.
networkId	string
outboundRules	object
status	ManagedNetworkProvisionStatus	Status of the Provisioning for the managed network of a machine learning workspace.

ManagedNetworkStatus

Enumeration

Status for the managed network of a machine learning workspace.

Value	Description
Active
Inactive

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

NotebookPreparationError

Object

Name	Type	Description
errorMessage	string
statusCode	integer

NotebookResourceInfo

Object

Name	Type	Description
fqdn	string
notebookPreparationError	NotebookPreparationError	The error that occurs when preparing notebook.
resourceId	string	the data plane resourceId that used to initialize notebook component

PrivateEndpoint

Object

The Private Endpoint resource.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint

PrivateEndpointConnection

Object

The Private Endpoint Connection resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	The identity of the resource.
location	string	Specifies the location of the resource.
name	string	The name of the resource
properties.privateEndpoint	PrivateEndpoint	The resource of private end point.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
sku	Sku	The sku of the workspace.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Contains resource tags defined as key/value pairs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointDestination

Object

Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

Name	Type	Description
serviceResourceId	string
sparkEnabled	boolean
sparkStatus	RuleStatus	Type of a managed network Outbound Rule of a machine learning workspace.
subresourceTarget	string

PrivateEndpointOutboundRule

Object

Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

Name	Type	Description
category	RuleCategory	Category of a managed network Outbound Rule of a machine learning workspace.
destination	PrivateEndpointDestination	Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.
status	RuleStatus	Type of a managed network Outbound Rule of a machine learning workspace.
type	string: PrivateEndpoint	Type of a managed network Outbound Rule of a machine learning workspace.

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value	Description
Approved
Disconnected
Pending
Rejected
Timeout

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

Enumeration

The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.

Value	Description
Canceled
Creating
Deleting
Failed
Succeeded
Unknown
Updating

PublicNetworkAccess

Enumeration

Whether requests from Public Network are allowed.

Value	Description
Disabled
Enabled

RuleAction

Enumeration

The action enum for networking rule.

Value	Description
Allow
Deny

RuleCategory

Enumeration

Category of a managed network Outbound Rule of a machine learning workspace.

Value	Description
Dependency
Recommended
Required
UserDefined

RuleStatus

Enumeration

Type of a managed network Outbound Rule of a machine learning workspace.

Value	Description
Active
Inactive

RuleType

Enumeration

Type of a managed network Outbound Rule of a machine learning workspace.

Value	Description
FQDN
PrivateEndpoint
ServiceTag

ServerlessComputeSettings

Object

Name	Type	Description
serverlessComputeCustomSubnet	string	The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed
serverlessComputeNoPublicIP	boolean	The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint

ServiceManagedResourcesSettings

Object

Name	Type	Description
cosmosDb	CosmosDbSettings	The settings for the service managed cosmosdb account.

ServiceTagDestination

Object

Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

Name	Type	Description
action	RuleAction	The action enum for networking rule.
addressPrefixes	string[]	Optional, if provided, the ServiceTag property will be ignored.
portRanges	string
protocol	string
serviceTag	string

ServiceTagOutboundRule

Object

Service Tag Outbound Rule for the managed network of a machine learning workspace.

Name	Type	Description
category	RuleCategory	Category of a managed network Outbound Rule of a machine learning workspace.
destination	ServiceTagDestination	Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.
status	RuleStatus	Type of a managed network Outbound Rule of a machine learning workspace.
type	string: ServiceTag	Type of a managed network Outbound Rule of a machine learning workspace.

SharedPrivateLinkResource

Object

Name	Type	Description
name	string	Unique name of the private link.
properties.groupId	string	The private link resource group id.
properties.privateLinkResourceId	string	The resource id that private link links to.
properties.requestMessage	string	Request message.
properties.status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Sku

Object

The resource model definition representing SKU

Name	Type	Description
capacity	integer	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. Ex - P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

Enumeration

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Value	Description
Basic
Free
Premium
Standard

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.

Workspace

Object

An object that represents a machine learning workspace.

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity		The identity of the resource.
kind	string
location	string		Specifies the location of the resource.
name	string		The name of the resource
properties.allowPublicAccessWhenBehindVnet	boolean	False	The flag to indicate whether to allow public access when behind VNet.
properties.applicationInsights	string		ARM id of the application insights associated with this workspace.
properties.associatedWorkspaces	string[]
properties.containerRegistry	string		ARM id of the container registry associated with this workspace.
properties.description	string		The description of this workspace.
properties.discoveryUrl	string		Url for the discovery service to identify regional endpoints for machine learning experimentation services
properties.enableDataIsolation	boolean
properties.encryption	EncryptionProperty		The encryption settings of Azure ML workspace.
properties.featureStoreSettings	FeatureStoreSettings		Settings for feature store type workspace.
properties.friendlyName	string		The friendly name for this workspace. This name in mutable
properties.hbiWorkspace	boolean	False	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
properties.hubResourceId	string
properties.imageBuildCompute	string		The compute name for image build
properties.keyVault	string		ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
properties.managedNetwork	ManagedNetworkSettings		Managed Network settings for a machine learning workspace.
properties.mlFlowTrackingUri	string		The URI associated with this workspace that machine learning flow must point at to set up tracking.
properties.notebookInfo	NotebookResourceInfo		The notebook info of Azure ML workspace.
properties.primaryUserAssignedIdentity	string		The user assigned identity resource id that represents the workspace identity.
properties.privateEndpointConnections	PrivateEndpointConnection[]		The list of private endpoint connections in the workspace.
properties.privateLinkCount	integer		Count of private connections in the workspace
properties.provisioningState	ProvisioningState		The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
properties.publicNetworkAccess	PublicNetworkAccess		Whether requests from Public Network are allowed.
properties.serverlessComputeSettings	ServerlessComputeSettings		Settings for serverless compute created in the workspace
properties.serviceManagedResourcesSettings	ServiceManagedResourcesSettings		The service managed resource settings.
properties.serviceProvisionedResourceGroup	string		The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		The list of shared private link resources in this workspace.
properties.storageAccount	string		ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
properties.storageHnsEnabled	boolean		If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
properties.tenantId	string		The tenant id associated with this workspace.
properties.v1LegacyMode	boolean	False	Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
properties.workspaceHubConfig	WorkspaceHubConfig		WorkspaceHub's configuration object.
properties.workspaceId	string		The immutable id associated with this workspace.
sku	Sku		The sku of the workspace.
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Contains resource tags defined as key/value pairs.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WorkspaceHubConfig

Object

WorkspaceHub's configuration object.

Name	Type	Description
additionalWorkspaceStorageAccounts	string[]
defaultWorkspaceResourceGroup	string

WorkspaceUpdateParameters

Object

The parameters for updating a machine learning workspace.

Name	Type	Description
identity	ManagedServiceIdentity	The identity of the resource.
properties.applicationInsights	string	ARM id of the application insights associated with this workspace.
properties.containerRegistry	string	ARM id of the container registry associated with this workspace.
properties.description	string	The description of this workspace.
properties.enableDataIsolation	boolean
properties.encryption	EncryptionUpdateProperties
properties.featureStoreSettings	FeatureStoreSettings	Settings for feature store type workspace.
properties.friendlyName	string	The friendly name for this workspace.
properties.imageBuildCompute	string	The compute name for image build
properties.managedNetwork	ManagedNetworkSettings	Managed Network settings for a machine learning workspace.
properties.primaryUserAssignedIdentity	string	The user assigned identity resource id that represents the workspace identity.
properties.publicNetworkAccess	PublicNetworkAccess	Whether requests from Public Network are allowed.
properties.serverlessComputeSettings	ServerlessComputeSettings	Settings for serverless compute created in the workspace
properties.serviceManagedResourcesSettings	ServiceManagedResourcesSettings	The service managed resource settings.
properties.v1LegacyMode	boolean	Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
sku	Sku	The sku of the workspace.
tags	object	The resource tags for the machine learning workspace.