beta_models

Creates, updates, deletes, gets or lists a beta_models resource.

Overview

Name	beta_models
Type	Resource
Id	azure.ai_projects.beta_models

Fields

The following fields are returned by SELECT queries:

get_credentials

Name	Datatype	Description
blobReference	object	Credential info to access the storage account. Required.

get

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
artifactProfile	object	The artifact profile of the model.
baseModel	string	Base model asset ID.
blobUri	string	URI of the model artifact in blob storage. Required.
description	string	The asset description text.
loraConfig	object	Adapter-specific configuration. Required when weight_type is lora; ignored otherwise. May be auto-populated from adapter_config.json when present in the uploaded files — user-provided values take precedence over auto-detected values.
source	object	The source of the model.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
version	string	The version of the resource. Required.
warnings	array	Service-computed advisory warnings derived from the artifact profile.
weightType	string	The weight type of the model. Known values are: "FullWeight", "LoRA", and "DraftModel". (FullWeight, LoRA, DraftModel)

list_versions

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
artifactProfile	object	The artifact profile of the model.
baseModel	string	Base model asset ID.
blobUri	string	URI of the model artifact in blob storage. Required.
description	string	The asset description text.
loraConfig	object	Adapter-specific configuration. Required when weight_type is lora; ignored otherwise. May be auto-populated from adapter_config.json when present in the uploaded files — user-provided values take precedence over auto-detected values.
source	object	The source of the model.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
version	string	The version of the resource. Required.
warnings	array	Service-computed advisory warnings derived from the artifact profile.
weightType	string	The weight type of the model. Known values are: "FullWeight", "LoRA", and "DraftModel". (FullWeight, LoRA, DraftModel)

list

Name	Datatype	Description
id	string	Asset ID, a unique identifier for the asset.
name	string	The name of the resource. Required.
artifactProfile	object	The artifact profile of the model.
baseModel	string	Base model asset ID.
blobUri	string	URI of the model artifact in blob storage. Required.
description	string	The asset description text.
loraConfig	object	Adapter-specific configuration. Required when weight_type is lora; ignored otherwise. May be auto-populated from adapter_config.json when present in the uploaded files — user-provided values take precedence over auto-detected values.
source	object	The source of the model.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
version	string	The version of the resource. Required.
warnings	array	Service-computed advisory warnings derived from the artifact profile.
weightType	string	The weight type of the model. Known values are: "FullWeight", "LoRA", and "DraftModel". (FullWeight, LoRA, DraftModel)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_credentials	select	name, version, endpoint		Get model asset credentials. Retrieves temporary credentials for accessing the storage backing the specified model version.
get	select	name, version, endpoint		Get a model version. Retrieves the specified model version, returning 404 if it does not exist.
list_versions	select	name, endpoint		List versions. List all versions of the given ModelVersion.
list	select	endpoint		List latest versions. List the latest version of each ModelVersion.
update	update	name, version, endpoint		Update a model version. Update an existing ModelVersion with the given version id.
delete	delete	name, version, endpoint		Delete a model version. Delete the specific version of the ModelVersion. The service returns 200 OK if the ModelVersion was deleted successfully or if the ModelVersion does not exist.
pending_create_version	exec	name, version, endpoint, blobUri		Create a model version async. Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a location header for polling the operation status.
pending_upload	exec	name, version, endpoint, pendingUploadType		Start a pending upload. Initiates a new pending upload or retrieves an existing one for the specified model version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
name	string	Name of the model. Required.
version	string	Version of the model. Required.

SELECT examples

get_credentials

Get model asset credentials. Retrieves temporary credentials for accessing the storage backing the specified model version.

SELECT
blobReference
FROM azure.ai_projects.beta_models
WHERE name = '{{ name }}' -- required
AND version = '{{ version }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get

Get a model version. Retrieves the specified model version, returning 404 if it does not exist.

SELECT
id,
name,
artifactProfile,
baseModel,
blobUri,
description,
loraConfig,
source,
tags,
version,
warnings,
weightType
FROM azure.ai_projects.beta_models
WHERE name = '{{ name }}' -- required
AND version = '{{ version }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_versions

List versions. List all versions of the given ModelVersion.

SELECT
id,
name,
artifactProfile,
baseModel,
blobUri,
description,
loraConfig,
source,
tags,
version,
warnings,
weightType
FROM azure.ai_projects.beta_models
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List latest versions. List the latest version of each ModelVersion.

SELECT
id,
name,
artifactProfile,
baseModel,
blobUri,
description,
loraConfig,
source,
tags,
version,
warnings,
weightType
FROM azure.ai_projects.beta_models
WHERE endpoint = '{{ endpoint }}' -- required
;

UPDATE examples

update

Update a model version. Update an existing ModelVersion with the given version id.

UPDATE azure.ai_projects.beta_models
SET 
description = '{{ description }}',
tags = '{{ tags }}'
WHERE 
name = '{{ name }}' --required
AND version = '{{ version }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
id,
name,
artifactProfile,
baseModel,
blobUri,
description,
loraConfig,
source,
tags,
version,
warnings,
weightType;

DELETE examples

delete

Delete a model version. Delete the specific version of the ModelVersion. The service returns 200 OK if the ModelVersion was deleted successfully or if the ModelVersion does not exist.

DELETE FROM azure.ai_projects.beta_models
WHERE name = '{{ name }}' --required
AND version = '{{ version }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

pending_create_version

Create a model version async. Creates a model version asynchronously with blob content validation. Returns 202 Accepted with a location header for polling the operation status.

EXEC azure.ai_projects.beta_models.pending_create_version 
@name='{{ name }}' --required, 
@version='{{ version }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"blobUri": "{{ blobUri }}", 
"weightType": "{{ weightType }}", 
"baseModel": "{{ baseModel }}", 
"source": "{{ source }}", 
"loraConfig": "{{ loraConfig }}", 
"description": "{{ description }}", 
"tags": "{{ tags }}"
}'
;

pending_upload

Start a pending upload. Initiates a new pending upload or retrieves an existing one for the specified model version.

EXEC azure.ai_projects.beta_models.pending_upload 
@name='{{ name }}' --required, 
@version='{{ version }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"pendingUploadId": "{{ pendingUploadId }}", 
"connectionName": "{{ connectionName }}", 
"pendingUploadType": "{{ pendingUploadType }}"
}'
;