Microsoft.MachineLearningServices registries/models/versions 2023-04-01-preview

• Latest
• 2023-10-01
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-04-01
• 2023-04-01-preview
• 2023-02-01-preview
• 2022-12-01-preview
• 2022-10-01-preview

Bicep resource definition

The registries/models/versions resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/registries/models/versions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/registries/models/versions@2023-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    autoDeleteSetting: {
      condition: 'string'
      value: 'string'
    }
    description: 'string'
    flavors: {
      {customized property}: {
        data: {
        {customized property}: 'string'
      }
    }
    intellectualProperty: {
      protectionLevel: 'string'
      publisher: 'string'
    }
    isAnonymous: bool
    isArchived: bool
    jobName: 'string'
    modelType: 'string'
    modelUri: 'string'
    properties: {
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
    }
    stage: 'string'
    tags: {
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
    }
  }
}

Property values

registries/models/versions

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: models
properties	[Required] Additional attributes of the entity.	ModelVersionProperties (required)

ModelVersionProperties

Name	Description	Value
autoDeleteSetting	Specifies the lifecycle setting of managed data asset.	AutoDeleteSetting
description	The asset description text.	string
flavors	Mapping of model flavors to their properties.	ModelVersionFlavors
intellectualProperty	Intellectual Property details. Used if model is an Intellectual Property.	IntellectualProperty
isAnonymous	If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous	bool
isArchived	Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived	bool
jobName	Name of the training job which produced this model	string
modelType	The storage format for this entity. Used for NCD.	string
modelUri	The URI path to the model contents.	string
properties	The asset property dictionary.	ResourceBaseProperties
stage	Stage in the model lifecycle assigned to this model	string
tags	Tag dictionary. Tags can be added, removed, and updated.	object

AutoDeleteSetting

Name	Description	Value
condition	When to check if an asset is expired	'CreatedGreaterThan' 'LastAccessedGreaterThan'
value	Expiration condition value.	string

ModelVersionFlavors

Name	Description	Value
{customized property}		FlavorData

FlavorData

Name	Description	Value
data	Model flavor-specific data.	FlavorData
{customized property}		string

IntellectualProperty

Name	Description	Value
protectionLevel	Protection level of the Intellectual Property.	'All' 'None'
publisher	[Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name.	string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_]

ResourceBaseProperties

Name	Description	Value
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string

ARM template resource definition

The registries/models/versions resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/registries/models/versions resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/registries/models/versions",
  "apiVersion": "2023-04-01-preview",
  "name": "string",
  "properties": {
    "autoDeleteSetting": {
      "condition": "string",
      "value": "string"
    },
    "description": "string",
    "flavors": {
      "{customized property}": {
        "data": {
        "{customized property}": "string"
      }
    },
    "intellectualProperty": {
      "protectionLevel": "string",
      "publisher": "string"
    },
    "isAnonymous": "bool",
    "isArchived": "bool",
    "jobName": "string",
    "modelType": "string",
    "modelUri": "string",
    "properties": {
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string"
    },
    "stage": "string",
    "tags": {
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string"
    }
  }
}

Property values

registries/models/versions

Name	Description	Value
type	The resource type	'Microsoft.MachineLearningServices/registries/models/versions'
apiVersion	The resource api version	'2023-04-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
properties	[Required] Additional attributes of the entity.	ModelVersionProperties (required)

ModelVersionProperties

Name	Description	Value
autoDeleteSetting	Specifies the lifecycle setting of managed data asset.	AutoDeleteSetting
description	The asset description text.	string
flavors	Mapping of model flavors to their properties.	ModelVersionFlavors
intellectualProperty	Intellectual Property details. Used if model is an Intellectual Property.	IntellectualProperty
isAnonymous	If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous	bool
isArchived	Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived	bool
jobName	Name of the training job which produced this model	string
modelType	The storage format for this entity. Used for NCD.	string
modelUri	The URI path to the model contents.	string
properties	The asset property dictionary.	ResourceBaseProperties
stage	Stage in the model lifecycle assigned to this model	string
tags	Tag dictionary. Tags can be added, removed, and updated.	object

AutoDeleteSetting

Name	Description	Value
condition	When to check if an asset is expired	'CreatedGreaterThan' 'LastAccessedGreaterThan'
value	Expiration condition value.	string

ModelVersionFlavors

Name	Description	Value
{customized property}		FlavorData

FlavorData

Name	Description	Value
data	Model flavor-specific data.	FlavorData
{customized property}		string

IntellectualProperty

Name	Description	Value
protectionLevel	Protection level of the Intellectual Property.	'All' 'None'
publisher	[Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name.	string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_]

ResourceBaseProperties

Name	Description	Value
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string

Terraform (AzAPI provider) resource definition

The registries/models/versions resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/registries/models/versions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/registries/models/versions@2023-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoDeleteSetting = {
        condition = "string"
        value = "string"
      }
      description = "string"
      flavors = {
        {customized property} = {
          data = {
          {customized property} = "string"
        }
      }
      intellectualProperty = {
        protectionLevel = "string"
        publisher = "string"
      }
      isAnonymous = bool
      isArchived = bool
      jobName = "string"
      modelType = "string"
      modelUri = "string"
      properties = {
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
      }
      stage = "string"
      tags = {
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
      }
    }
  })
}

Property values

registries/models/versions

Name	Description	Value
type	The resource type	"Microsoft.MachineLearningServices/registries/models/versions@2023-04-01-preview"
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: models
properties	[Required] Additional attributes of the entity.	ModelVersionProperties (required)

ModelVersionProperties

Name	Description	Value
autoDeleteSetting	Specifies the lifecycle setting of managed data asset.	AutoDeleteSetting
description	The asset description text.	string
flavors	Mapping of model flavors to their properties.	ModelVersionFlavors
intellectualProperty	Intellectual Property details. Used if model is an Intellectual Property.	IntellectualProperty
isAnonymous	If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous	bool
isArchived	Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived	bool
jobName	Name of the training job which produced this model	string
modelType	The storage format for this entity. Used for NCD.	string
modelUri	The URI path to the model contents.	string
properties	The asset property dictionary.	ResourceBaseProperties
stage	Stage in the model lifecycle assigned to this model	string
tags	Tag dictionary. Tags can be added, removed, and updated.	object

AutoDeleteSetting

Name	Description	Value
condition	When to check if an asset is expired	"CreatedGreaterThan" "LastAccessedGreaterThan"
value	Expiration condition value.	string

ModelVersionFlavors

Name	Description	Value
{customized property}		FlavorData

FlavorData

Name	Description	Value
data	Model flavor-specific data.	FlavorData
{customized property}		string

IntellectualProperty

Name	Description	Value
protectionLevel	Protection level of the Intellectual Property.	"All" "None"
publisher	[Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name.	string (required) Constraints: Min length = 1 Pattern = [a-zA-Z0-9_]

ResourceBaseProperties

Name	Description	Value
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string
{customized property}		string