Registry Model Versions - List

Service:: Machine Learning

API Version:: 2024-10-01

List versions.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions?api-version=2024-10-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions?api-version=2024-10-01&$skip={$skip}&$orderBy={$orderBy}&$top={$top}&version={version}&description={description}&tags={tags}&properties={properties}&listViewType={listViewType}

URI Parameters

Name	In	Required	Type	Description
modelName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$	Container name. This is case-sensitive.
registryName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{2,32}$	Name of Azure Machine Learning registry. This is case-insensitive
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$orderBy	query		string	Ordering of list.
$skip	query		string	Continuation token for pagination.
$top	query		integer (int32)	Maximum number of records to return.
description	query		string	Model description.
listViewType	query		ListViewType	View type for including/excluding (for example) archived entities.
properties	query		string	Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2
tags	query		string	Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2
version	query		string	Version identifier.

Responses

Name	Type	Description
200 OK	ModelVersionResourceArmPaginatedResult	Success
Other Status Codes	ErrorResponse	Error

Examples

List Registry Model Version.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/registries/my-aml-registry/models/string/versions?api-version=2024-10-01&$orderBy=string&$top=1&version=string&description=string&tags=string&properties=string

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "description": "string",
        "tags": {
          "string": "string"
        },
        "properties": {
          "string": "string"
        },
        "isAnonymous": false,
        "flavors": {
          "string": {
            "data": {
              "string": "string"
            }
          }
        },
        "modelType": "CustomModel",
        "modelUri": "string"
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-01-01T12:34:56.999Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      }
    }
  ],
  "nextLink": "string"
}

Definitions

Name	Description
AssetProvisioningState	Provisioning state of registry asset.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FlavorData
ListViewType
ModelVersion	Model asset version details.
ModelVersionResource	Azure Resource Manager resource envelope.
ModelVersionResourceArmPaginatedResult	A paginated list of ModelVersion entities.
systemData	Metadata pertaining to creation and last modification of the resource.

AssetProvisioningState

Enumeration

Provisioning state of registry asset.

Value	Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

FlavorData

Object

Name	Type	Description
data	object	Model flavor-specific data.

ListViewType

Enumeration

Value	Description
ActiveOnly
ArchivedOnly
All

ModelVersion

Object

Model asset version details.

Name	Type	Default value	Description
description	string		The asset description text.
flavors	<string, FlavorData>		Mapping of model flavors to their properties.
isAnonymous	boolean	False	If the name version are system generated (anonymous registration).
isArchived	boolean	False	Is the asset archived?
jobName	string		Name of the training job which produced this model
modelType	string		The storage format for this entity. Used for NCD.
modelUri	string		The URI path to the model contents.
properties	object		The asset property dictionary.
provisioningState	AssetProvisioningState		Provisioning state for the model version.
stage	string		Stage in the model lifecycle assigned to this model
tags	object		Tag dictionary. Tags can be added, removed, and updated.

ModelVersionResource

Object

Azure Resource Manager resource envelope.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	ModelVersion	[Required] Additional attributes of the entity.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ModelVersionResourceArmPaginatedResult

Object

A paginated list of ModelVersion entities.

Name	Type	Description
nextLink	string	The link to the next page of ModelVersion objects. If null, there are no additional pages.
value	ModelVersionResource[]	An array of objects of type ModelVersion.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.

Share via

Registry Model Versions - List

URI Parameters

Responses

Examples

List Registry Model Version.

Sample request

Sample response

Definitions

AssetProvisioningState

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlavorData

ListViewType

ModelVersion

ModelVersionResource

ModelVersionResourceArmPaginatedResult

systemData