Skip to main content

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.

Download Microsoft Edge More info about Internet Explorer and Microsoft Edge
microsoft-foundry.rest.security.o-auth2-auth

Models

Update a model version

PATCH /models/{name}/versions/{version}

Updates an existing model version identified by its version ID.

Query parameters

api-version string required

The API version to use for this operation.

Path parameters

name string required

The name of the resource

version string required

The specific version id of the UpdateModelVersionRequest to create or update.

Header parameters

Foundry-Features enum required

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

Models=V1Preview

Request Body

The UpdateModelVersionRequest to create or update.

Content-Type: application/merge-patch+json
description string

The asset description text.

tags object

Tag dictionary. Tags can be added, removed, and updated.

[key: string] string

Responses

The request has succeeded.

Body

Content-Type: application/json
blobUri string required

URI of the model artifact in blob storage

weightType string | enum

The weight type of the model.

Any of the following:
string
enum
FullWeightLoRADraftModel
baseModel string

Base model asset ID

source ModelSourceData

Source information for the model

sourceType string | enum

The source type of the model.

Any of the following:
string
enum
LocalUploadTrainingJob
jobId string

The job ID that produced this model

loraConfig LoraConfig

Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time.

rank integer

LoRA rank (r). Positive integer. Common values: 8, 16, 32, 64.

alpha integer

LoRA scaling factor (α). Positive integer; typically 2× the rank.

targetModules string[]

Model layers modified by the adapter (e.g., q_proj, v_proj). Auto-detected from adapter_config.json if omitted.

dropout number

Dropout rate used during training. Informational — not used at serving time.

artifactProfile ArtifactProfile

Artifact profile of the model

category string | enum required

The artifact profile category.

Any of the following:
string
enum
DataOnlyRuntimeDependentUnknown
signals FoundryModelArtifactProfileSignal[]

Signals detected in the model artifact

warnings FoundryModelWarning[]

Service-computed advisory warnings derived from the artifact profile.

id string

Asset ID, a unique identifier for the asset

name string required

The name of the resource

version string required

The version of the resource

description string

The asset description text.

tags object

Tag dictionary. Tags can be added, removed, and updated.

[key: string] string

The request has succeeded and a new resource has been created as a result.

Body

Content-Type: application/json
blobUri string required

URI of the model artifact in blob storage

weightType string | enum

The weight type of the model.

Any of the following:
string
enum
FullWeightLoRADraftModel
baseModel string

Base model asset ID

source ModelSourceData

Source information for the model

sourceType string | enum

The source type of the model.

Any of the following:
string
enum
LocalUploadTrainingJob
jobId string

The job ID that produced this model

loraConfig LoraConfig

Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time.

rank integer

LoRA rank (r). Positive integer. Common values: 8, 16, 32, 64.

alpha integer

LoRA scaling factor (α). Positive integer; typically 2× the rank.

targetModules string[]

Model layers modified by the adapter (e.g., q_proj, v_proj). Auto-detected from adapter_config.json if omitted.

dropout number

Dropout rate used during training. Informational — not used at serving time.

artifactProfile ArtifactProfile

Artifact profile of the model

category string | enum required

The artifact profile category.

Any of the following:
string
enum
DataOnlyRuntimeDependentUnknown
signals FoundryModelArtifactProfileSignal[]

Signals detected in the model artifact

warnings FoundryModelWarning[]

Service-computed advisory warnings derived from the artifact profile.

id string

Asset ID, a unique identifier for the asset

name string required

The name of the resource

version string required

The version of the resource

description string

The asset description text.

tags object

Tag dictionary. Tags can be added, removed, and updated.

[key: string] string

Client error

Headers

x-ms-error-code string

String error code indicating what went wrong.

Body

Content-Type: application/json
error Azure.Core.Foundations.Error required

The error object.

code string required

One of a server-defined set of error codes.

message string required

A human-readable representation of the error.

target string

The target of the error.

details Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.

innererror Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

code string

One of a server-defined set of error codes.

innererror Azure.Core.Foundations.InnerError

Server error

Headers

x-ms-error-code string

String error code indicating what went wrong.

Body

Content-Type: application/json
error Azure.Core.Foundations.Error required

The error object.

code string required

One of a server-defined set of error codes.

message string required

A human-readable representation of the error.

target string

The target of the error.

details Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.

innererror Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

code string

One of a server-defined set of error codes.

innererror Azure.Core.Foundations.InnerError

Request

PATCH /models/{name}/versions/{version} HTTP/1.1

Response

Status: 200
Content-Type: application/json
Status: 201
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
en-us
Your Privacy Choices
  • AI Disclaimer
  • Previous Versions
  • Blog
  • Contribute
  • Privacy
  • Consumer Health Privacy
  • Terms of Use
  • Trademarks
  • © Microsoft 2026