Items - Update ML Experiment

Service:

MLExperiment

API Version:

v1

Updates the properties of the specified machine learning experiment.

Permissions

The caller must have contributor or higher role on the workspace.

Required Delegated Scopes

MLExperiment.ReadWrite.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal	No
Managed identities	No

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mlExperiments/{mlExperimentId}

URI Parameters

Name	In	Required	Type	Description
mlExperimentId	path	True	string uuid	The machine learning experiment ID.
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Type	Description
description	string	The machine learning experiment description. Maximum length is 256 characters.
displayName	string	The machine learning experiment display name. The display name must follow naming rules according to item type.

Responses

Name	Type	Description
200 OK	MLExperiment	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found. InvalidRequest - Invalid update request.

Examples

Update an machine learning experiment example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mlExperiments/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "MLExperiment_New_Name",
  "description": "A new description for machine learning experiment."
}

Sample response

Status code:

200

{
  "displayName": "MLExperiment_New_Name",
  "description": "A new description for machine learning experiment.",
  "type": "MLExperiment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemType	The type of the item. Additional item types may be added over time.
MLExperiment	A machine learning experiment object.
UpdateMLExperimentRequest	Update machine learning experiment request.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemType

The type of the item. Additional item types may be added over time.

Name	Type	Description
Dashboard	string	PowerBI dashboard.
DataPipeline	string	A data pipeline.
Datamart	string	PowerBI datamart.
Environment	string	An environment.
Eventhouse	string	An eventhouse.
Eventstream	string	An eventstream.
KQLDashboard	string	A KQL dashboard.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	A lakehouse.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredDatabase	string	A mirrored database.
MirroredWarehouse	string	A mirrored warehouse.
Notebook	string	A notebook.
PaginatedReport	string	PowerBI paginated report.
Reflex	string	A Reflex.
Report	string	PowerBI report.
SQLEndpoint	string	An SQL endpoint.
SemanticModel	string	PowerBI semantic model.
SparkJobDefinition	string	A spark job definition.
Warehouse	string	A warehouse.

MLExperiment

A machine learning experiment object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
id	string	The item ID.
type	ItemType	The item type.
workspaceId	string	The workspace ID.

UpdateMLExperimentRequest

Update machine learning experiment request.

Name	Type	Description
description	string	The machine learning experiment description. Maximum length is 256 characters.
displayName	string	The machine learning experiment display name. The display name must follow naming rules according to item type.