Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The registries/data/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/data/versions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/registries/data/versions@2024-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
autoDeleteSetting: {
condition: 'string'
value: 'string'
}
dataUri: 'string'
description: 'string'
intellectualProperty: {
protectionLevel: 'string'
publisher: 'string'
}
isAnonymous: bool
isArchived: bool
properties: {
{customized property}: 'string'
}
stage: 'string'
tags: {
{customized property}: 'string'
}
dataType: 'string'
// For remaining properties, see DataVersionBaseProperties objects
}
}
DataVersionBaseProperties objects
Set the dataType property to specify the type of object.
For mltable, use:
{
dataType: 'mltable'
referencedUris: [
'string'
]
}
For uri_file, use:
{
dataType: 'uri_file'
}
For uri_folder, use:
{
dataType: 'uri_folder'
}
Property Values
Microsoft.MachineLearningServices/registries/data/versions
| Name | Description | Value |
|---|---|---|
| name | The resource name | 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: registries/data |
| properties | [Required] Additional attributes of the entity. | DataVersionBaseProperties (required) |
AutoDeleteSetting
| Name | Description | Value |
|---|---|---|
| condition | When to check if an asset is expired | 'CreatedGreaterThan' 'LastAccessedGreaterThan' |
| value | Expiration condition value. | string |
DataVersionBaseProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteSetting | Specifies the lifecycle setting of managed data asset. | AutoDeleteSetting |
| dataType | Set to 'mltable' for type MLTableData. Set to 'uri_file' for type UriFileDataVersion. Set to 'uri_folder' for type UriFolderDataVersion. | 'mltable' 'uri_file' 'uri_folder' (required) |
| dataUri | [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| description | The asset description text. | string |
| intellectualProperty | Intellectual Property details. Used if data 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 |
| properties | The asset property dictionary. | ResourceBaseProperties |
| stage | Stage in the data lifecycle assigned to this data asset | string |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
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 Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
MLTableData
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'mltable' (required) |
| referencedUris | Uris referenced in the MLTable definition (required for lineage) | string[] |
ResourceBaseProperties
| Name | Description | Value |
|---|
ResourceBaseTags
| Name | Description | Value |
|---|
UriFileDataVersion
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'uri_file' (required) |
UriFolderDataVersion
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'uri_folder' (required) |
ARM template resource definition
The registries/data/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/data/versions resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/registries/data/versions",
"apiVersion": "2024-01-01-preview",
"name": "string",
"properties": {
"autoDeleteSetting": {
"condition": "string",
"value": "string"
},
"dataUri": "string",
"description": "string",
"intellectualProperty": {
"protectionLevel": "string",
"publisher": "string"
},
"isAnonymous": "bool",
"isArchived": "bool",
"properties": {
"{customized property}": "string"
},
"stage": "string",
"tags": {
"{customized property}": "string"
},
"dataType": "string"
// For remaining properties, see DataVersionBaseProperties objects
}
}
DataVersionBaseProperties objects
Set the dataType property to specify the type of object.
For mltable, use:
{
"dataType": "mltable",
"referencedUris": [ "string" ]
}
For uri_file, use:
{
"dataType": "uri_file"
}
For uri_folder, use:
{
"dataType": "uri_folder"
}
Property Values
Microsoft.MachineLearningServices/registries/data/versions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-01-01-preview' |
| name | The resource name | string (required) |
| properties | [Required] Additional attributes of the entity. | DataVersionBaseProperties (required) |
| type | The resource type | 'Microsoft.MachineLearningServices/registries/data/versions' |
AutoDeleteSetting
| Name | Description | Value |
|---|---|---|
| condition | When to check if an asset is expired | 'CreatedGreaterThan' 'LastAccessedGreaterThan' |
| value | Expiration condition value. | string |
DataVersionBaseProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteSetting | Specifies the lifecycle setting of managed data asset. | AutoDeleteSetting |
| dataType | Set to 'mltable' for type MLTableData. Set to 'uri_file' for type UriFileDataVersion. Set to 'uri_folder' for type UriFolderDataVersion. | 'mltable' 'uri_file' 'uri_folder' (required) |
| dataUri | [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| description | The asset description text. | string |
| intellectualProperty | Intellectual Property details. Used if data 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 |
| properties | The asset property dictionary. | ResourceBaseProperties |
| stage | Stage in the data lifecycle assigned to this data asset | string |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
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 Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
MLTableData
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'mltable' (required) |
| referencedUris | Uris referenced in the MLTable definition (required for lineage) | string[] |
ResourceBaseProperties
| Name | Description | Value |
|---|
ResourceBaseTags
| Name | Description | Value |
|---|
UriFileDataVersion
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'uri_file' (required) |
UriFolderDataVersion
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'uri_folder' (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The registries/data/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/data/versions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/registries/data/versions@2024-01-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
autoDeleteSetting = {
condition = "string"
value = "string"
}
dataUri = "string"
description = "string"
intellectualProperty = {
protectionLevel = "string"
publisher = "string"
}
isAnonymous = bool
isArchived = bool
properties = {
{customized property} = "string"
}
stage = "string"
tags = {
{customized property} = "string"
}
dataType = "string"
// For remaining properties, see DataVersionBaseProperties objects
}
}
}
DataVersionBaseProperties objects
Set the dataType property to specify the type of object.
For mltable, use:
{
dataType = "mltable"
referencedUris = [
"string"
]
}
For uri_file, use:
{
dataType = "uri_file"
}
For uri_folder, use:
{
dataType = "uri_folder"
}
Property Values
Microsoft.MachineLearningServices/registries/data/versions
| Name | Description | Value |
|---|---|---|
| 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: registries/data |
| properties | [Required] Additional attributes of the entity. | DataVersionBaseProperties (required) |
| type | The resource type | "Microsoft.MachineLearningServices/registries/data/versions@2024-01-01-preview" |
AutoDeleteSetting
| Name | Description | Value |
|---|---|---|
| condition | When to check if an asset is expired | 'CreatedGreaterThan' 'LastAccessedGreaterThan' |
| value | Expiration condition value. | string |
DataVersionBaseProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteSetting | Specifies the lifecycle setting of managed data asset. | AutoDeleteSetting |
| dataType | Set to 'mltable' for type MLTableData. Set to 'uri_file' for type UriFileDataVersion. Set to 'uri_folder' for type UriFolderDataVersion. | 'mltable' 'uri_file' 'uri_folder' (required) |
| dataUri | [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| description | The asset description text. | string |
| intellectualProperty | Intellectual Property details. Used if data 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 |
| properties | The asset property dictionary. | ResourceBaseProperties |
| stage | Stage in the data lifecycle assigned to this data asset | string |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
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 Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
MLTableData
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'mltable' (required) |
| referencedUris | Uris referenced in the MLTable definition (required for lineage) | string[] |
ResourceBaseProperties
| Name | Description | Value |
|---|
ResourceBaseTags
| Name | Description | Value |
|---|
UriFileDataVersion
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'uri_file' (required) |
UriFolderDataVersion
| Name | Description | Value |
|---|---|---|
| dataType | [Required] Specifies the type of data. | 'uri_folder' (required) |