model_versions

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

Overview

Name	model_versions
Type	Resource
Id	azure.ml_services.model_versions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	[Required] Additional attributes of the entity. (x-ms-client-name: ModelVersionProperties)

list

Name	Datatype	Description
properties	object	[Required] Additional attributes of the entity. (x-ms-client-name: ModelVersionProperties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, name, version
list	select	subscriptionId, resourceGroupName, workspaceName, name	$skip, $orderBy, $top, version, description, offset, tags, properties, feed, listViewType
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, name, version, data__properties
delete	delete	subscriptionId, resourceGroupName, workspaceName, name, version
publish	exec	subscriptionId, resourceGroupName, workspaceName, name, 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
name	string	Container name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
version	string	Version identifier.
workspaceName	string	Azure Machine Learning Workspace Name
$orderBy	string	Ordering of list.
$skip	string	Continuation token for pagination.
$top	integer (int32)	Maximum number of records to return.
description	string	Model description.
feed	string	Name of the feed.
listViewType	string	View type for including/excluding (for example) archived entities.
offset	integer (int32)	Number of initial results to skip.
properties	string	Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2
tags	string	Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2
version	string	Model version.

SELECT examples

get

Success

SELECT
properties
FROM azure.ml_services.model_versions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND name = '{{ name }}' -- required
AND version = '{{ version }}' -- required
;

list

Success

SELECT
properties
FROM azure.ml_services.model_versions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND name = '{{ name }}' -- required
AND $skip = '{{ $skip }}'
AND $orderBy = '{{ $orderBy }}'
AND $top = '{{ $top }}'
AND version = '{{ version }}'
AND description = '{{ description }}'
AND offset = '{{ offset }}'
AND tags = '{{ tags }}'
AND properties = '{{ properties }}'
AND feed = '{{ feed }}'
AND listViewType = '{{ listViewType }}'
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.model_versions (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
name,
version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ name }}',
'{{ version }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: model_versions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the model_versions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the model_versions resource.
    - name: workspaceName
      value: string
      description: Required parameter for the model_versions resource.
    - name: name
      value: string
      description: Required parameter for the model_versions resource.
    - name: version
      value: string
      description: Required parameter for the model_versions resource.
    - name: properties
      value: object
      description: |
        [Required] Additional attributes of the entity.

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.model_versions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND name = '{{ name }}' --required
AND version = '{{ version }}' --required
;

Lifecycle Methods

publish

Success

EXEC azure.ml_services.model_versions.publish 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@name='{{ name }}' --required, 
@version='{{ version }}' --required 
@@json=
'{
"destinationName": "{{ destinationName }}", 
"destinationVersion": "{{ destinationVersion }}", 
"registryName": "{{ registryName }}"
}'
;