Edit

Share via

Endpoint - Deactivate ML Model Endpoint Version

Service:
MLModel
API Version:
v1

Deactivates the specified model version version.
This API supports long running operations (LRO).

Permissions

The caller must have write permission on the MLModel.

Required Delegated Scopes

MLModel.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 and Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint/versions/{name}/deactivate

URI Parameters

Name In Required Type Description
modelId
 path True

string (uuid)

The machine learning model ID.
name
 path True

string

The MLModel version name.
workspaceId
 path True

string (uuid)

The workspace ID.

Responses

Name Type Description
200 OK

Machine learning model endpoint deactivation completed successfully.
202 Accepted

Request accepted, model activation in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • NotFound - Version not found.

  • UnknownError - An error occurred.

  • Conflict - Model endpoint version is already deactivating.

  • BadInput - User Input is invalid.

Examples

Example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cf5fef71-f7f3-43f3-ae7f-3c427922bef1/mlmodels/7e92a6fc-3ef5-40bf-96df-ddae3fcde313/endpoint/versions/1/deactivate

Sample response

Status code:
200
Status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

ErrorRelatedResource

Object

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

Object

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

Object

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.