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 workspaces/featuresets/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/workspaces/featuresets/versions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/featuresets/versions@2024-10-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
entities: [
'string'
]
isAnonymous: bool
isArchived: bool
materializationSettings: {
notification: {
emailOn: [
'string'
]
emails: [
'string'
]
webhooks: {
{customized property}: {
eventType: 'string'
webhookType: 'string'
// For remaining properties, see Webhook objects
}
}
}
resource: {
instanceType: 'string'
}
schedule: {
endTime: 'string'
frequency: 'string'
interval: int
schedule: {
hours: [
int
]
minutes: [
int
]
monthDays: [
int
]
weekDays: [
'string'
]
}
startTime: 'string'
timeZone: 'string'
triggerType: 'string'
}
sparkConfiguration: {
{customized property}: 'string'
}
storeType: 'string'
}
properties: {
{customized property}: 'string'
}
specification: {
path: 'string'
}
stage: 'string'
tags: {
{customized property}: 'string'
}
}
}
Webhook objects
Set the webhookType property to specify the type of object.
For AzureDevOps, use:
{
webhookType: 'AzureDevOps'
}
Property Values
AzureDevOpsWebhook
| Name | Description | Value |
|---|---|---|
| webhookType | [Required] Specifies the type of service to send a callback | 'AzureDevOps' (required) |
FeaturesetSpecification
| Name | Description | Value |
|---|---|---|
| path | Specifies the spec path | string |
FeaturesetVersionProperties
| Name | Description | Value |
|---|---|---|
| description | The asset description text. | string |
| entities | Specifies list of entities | string[] |
| isAnonymous | If the name version are system generated (anonymous registration). | bool |
| isArchived | Is the asset archived? | bool |
| materializationSettings | Specifies the materialization settings | MaterializationSettings |
| properties | The asset property dictionary. | ResourceBaseProperties |
| specification | Specifies the feature spec details | FeaturesetSpecification |
| stage | Specifies the asset stage | string |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
MaterializationComputeResource
| Name | Description | Value |
|---|---|---|
| instanceType | Specifies the instance type | string |
MaterializationSettings
| Name | Description | Value |
|---|---|---|
| notification | Specifies the notification details | NotificationSetting |
| resource | Specifies the compute resource settings | MaterializationComputeResource |
| schedule | Specifies the schedule details | RecurrenceTrigger |
| sparkConfiguration | Specifies the spark compute settings | MaterializationSettingsSparkConfiguration |
| storeType | Specifies the stores to which materialization should happen | 'None' 'Offline' 'Online' 'OnlineAndOffline' |
MaterializationSettingsSparkConfiguration
| Name | Description | Value |
|---|
Microsoft.MachineLearningServices/workspaces/featuresets/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: workspaces/featuresets |
| properties | [Required] Additional attributes of the entity. | FeaturesetVersionProperties (required) |
NotificationSetting
| Name | Description | Value |
|---|---|---|
| emailOn | Send email notification to user on specified notification type | String array containing any of: 'JobCancelled' 'JobCompleted' 'JobFailed' |
| emails | This is the email recipient list which has a limitation of 499 characters in total concat with comma separator | string[] |
| webhooks | Send webhook callback to a service. Key is a user-provided name for the webhook. | NotificationSettingWebhooks |
NotificationSettingWebhooks
| Name | Description | Value |
|---|
RecurrenceSchedule
| Name | Description | Value |
|---|---|---|
| hours | [Required] List of hours for the schedule. | int[] (required) |
| minutes | [Required] List of minutes for the schedule. | int[] (required) |
| monthDays | List of month days for the schedule | int[] |
| weekDays | List of days for the schedule. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
RecurrenceTrigger
| Name | Description | Value |
|---|---|---|
| endTime | Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely |
string |
| frequency | [Required] The frequency to trigger schedule. | 'Day' 'Hour' 'Minute' 'Month' 'Week' (required) |
| interval | [Required] Specifies schedule interval in conjunction with frequency | int (required) |
| schedule | The recurrence schedule. | RecurrenceSchedule |
| startTime | Specifies start time of schedule in ISO 8601 format, but without a UTC offset. | string |
| timeZone | Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: /windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 |
string |
| triggerType | [Required] | 'Cron' 'Recurrence' (required) |
ResourceBaseProperties
| Name | Description | Value |
|---|
ResourceBaseTags
| Name | Description | Value |
|---|
Webhook
| Name | Description | Value |
|---|---|---|
| eventType | Send callback on a specified notification event | string |
| webhookType | Set to 'AzureDevOps' for type AzureDevOpsWebhook. | 'AzureDevOps' (required) |
ARM template resource definition
The workspaces/featuresets/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/workspaces/featuresets/versions resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/featuresets/versions",
"apiVersion": "2024-10-01",
"name": "string",
"properties": {
"description": "string",
"entities": [ "string" ],
"isAnonymous": "bool",
"isArchived": "bool",
"materializationSettings": {
"notification": {
"emailOn": [ "string" ],
"emails": [ "string" ],
"webhooks": {
"{customized property}": {
"eventType": "string",
"webhookType": "string"
// For remaining properties, see Webhook objects
}
}
},
"resource": {
"instanceType": "string"
},
"schedule": {
"endTime": "string",
"frequency": "string",
"interval": "int",
"schedule": {
"hours": [ "int" ],
"minutes": [ "int" ],
"monthDays": [ "int" ],
"weekDays": [ "string" ]
},
"startTime": "string",
"timeZone": "string",
"triggerType": "string"
},
"sparkConfiguration": {
"{customized property}": "string"
},
"storeType": "string"
},
"properties": {
"{customized property}": "string"
},
"specification": {
"path": "string"
},
"stage": "string",
"tags": {
"{customized property}": "string"
}
}
}
Webhook objects
Set the webhookType property to specify the type of object.
For AzureDevOps, use:
{
"webhookType": "AzureDevOps"
}
Property Values
AzureDevOpsWebhook
| Name | Description | Value |
|---|---|---|
| webhookType | [Required] Specifies the type of service to send a callback | 'AzureDevOps' (required) |
FeaturesetSpecification
| Name | Description | Value |
|---|---|---|
| path | Specifies the spec path | string |
FeaturesetVersionProperties
| Name | Description | Value |
|---|---|---|
| description | The asset description text. | string |
| entities | Specifies list of entities | string[] |
| isAnonymous | If the name version are system generated (anonymous registration). | bool |
| isArchived | Is the asset archived? | bool |
| materializationSettings | Specifies the materialization settings | MaterializationSettings |
| properties | The asset property dictionary. | ResourceBaseProperties |
| specification | Specifies the feature spec details | FeaturesetSpecification |
| stage | Specifies the asset stage | string |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
MaterializationComputeResource
| Name | Description | Value |
|---|---|---|
| instanceType | Specifies the instance type | string |
MaterializationSettings
| Name | Description | Value |
|---|---|---|
| notification | Specifies the notification details | NotificationSetting |
| resource | Specifies the compute resource settings | MaterializationComputeResource |
| schedule | Specifies the schedule details | RecurrenceTrigger |
| sparkConfiguration | Specifies the spark compute settings | MaterializationSettingsSparkConfiguration |
| storeType | Specifies the stores to which materialization should happen | 'None' 'Offline' 'Online' 'OnlineAndOffline' |
MaterializationSettingsSparkConfiguration
| Name | Description | Value |
|---|
Microsoft.MachineLearningServices/workspaces/featuresets/versions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-10-01' |
| name | The resource name | string (required) |
| properties | [Required] Additional attributes of the entity. | FeaturesetVersionProperties (required) |
| type | The resource type | 'Microsoft.MachineLearningServices/workspaces/featuresets/versions' |
NotificationSetting
| Name | Description | Value |
|---|---|---|
| emailOn | Send email notification to user on specified notification type | String array containing any of: 'JobCancelled' 'JobCompleted' 'JobFailed' |
| emails | This is the email recipient list which has a limitation of 499 characters in total concat with comma separator | string[] |
| webhooks | Send webhook callback to a service. Key is a user-provided name for the webhook. | NotificationSettingWebhooks |
NotificationSettingWebhooks
| Name | Description | Value |
|---|
RecurrenceSchedule
| Name | Description | Value |
|---|---|---|
| hours | [Required] List of hours for the schedule. | int[] (required) |
| minutes | [Required] List of minutes for the schedule. | int[] (required) |
| monthDays | List of month days for the schedule | int[] |
| weekDays | List of days for the schedule. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
RecurrenceTrigger
| Name | Description | Value |
|---|---|---|
| endTime | Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely |
string |
| frequency | [Required] The frequency to trigger schedule. | 'Day' 'Hour' 'Minute' 'Month' 'Week' (required) |
| interval | [Required] Specifies schedule interval in conjunction with frequency | int (required) |
| schedule | The recurrence schedule. | RecurrenceSchedule |
| startTime | Specifies start time of schedule in ISO 8601 format, but without a UTC offset. | string |
| timeZone | Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: /windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 |
string |
| triggerType | [Required] | 'Cron' 'Recurrence' (required) |
ResourceBaseProperties
| Name | Description | Value |
|---|
ResourceBaseTags
| Name | Description | Value |
|---|
Webhook
| Name | Description | Value |
|---|---|---|
| eventType | Send callback on a specified notification event | string |
| webhookType | Set to 'AzureDevOps' for type AzureDevOpsWebhook. | 'AzureDevOps' (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The workspaces/featuresets/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/workspaces/featuresets/versions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/featuresets/versions@2024-10-01"
name = "string"
body = {
properties = {
description = "string"
entities = [
"string"
]
isAnonymous = bool
isArchived = bool
materializationSettings = {
notification = {
emailOn = [
"string"
]
emails = [
"string"
]
webhooks = {
{customized property} = {
eventType = "string"
webhookType = "string"
// For remaining properties, see Webhook objects
}
}
}
resource = {
instanceType = "string"
}
schedule = {
endTime = "string"
frequency = "string"
interval = int
schedule = {
hours = [
int
]
minutes = [
int
]
monthDays = [
int
]
weekDays = [
"string"
]
}
startTime = "string"
timeZone = "string"
triggerType = "string"
}
sparkConfiguration = {
{customized property} = "string"
}
storeType = "string"
}
properties = {
{customized property} = "string"
}
specification = {
path = "string"
}
stage = "string"
tags = {
{customized property} = "string"
}
}
}
}
Webhook objects
Set the webhookType property to specify the type of object.
For AzureDevOps, use:
{
webhookType = "AzureDevOps"
}
Property Values
AzureDevOpsWebhook
| Name | Description | Value |
|---|---|---|
| webhookType | [Required] Specifies the type of service to send a callback | 'AzureDevOps' (required) |
FeaturesetSpecification
| Name | Description | Value |
|---|---|---|
| path | Specifies the spec path | string |
FeaturesetVersionProperties
| Name | Description | Value |
|---|---|---|
| description | The asset description text. | string |
| entities | Specifies list of entities | string[] |
| isAnonymous | If the name version are system generated (anonymous registration). | bool |
| isArchived | Is the asset archived? | bool |
| materializationSettings | Specifies the materialization settings | MaterializationSettings |
| properties | The asset property dictionary. | ResourceBaseProperties |
| specification | Specifies the feature spec details | FeaturesetSpecification |
| stage | Specifies the asset stage | string |
| tags | Tag dictionary. Tags can be added, removed, and updated. | ResourceBaseTags |
MaterializationComputeResource
| Name | Description | Value |
|---|---|---|
| instanceType | Specifies the instance type | string |
MaterializationSettings
| Name | Description | Value |
|---|---|---|
| notification | Specifies the notification details | NotificationSetting |
| resource | Specifies the compute resource settings | MaterializationComputeResource |
| schedule | Specifies the schedule details | RecurrenceTrigger |
| sparkConfiguration | Specifies the spark compute settings | MaterializationSettingsSparkConfiguration |
| storeType | Specifies the stores to which materialization should happen | 'None' 'Offline' 'Online' 'OnlineAndOffline' |
MaterializationSettingsSparkConfiguration
| Name | Description | Value |
|---|
Microsoft.MachineLearningServices/workspaces/featuresets/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: workspaces/featuresets |
| properties | [Required] Additional attributes of the entity. | FeaturesetVersionProperties (required) |
| type | The resource type | "Microsoft.MachineLearningServices/workspaces/featuresets/versions@2024-10-01" |
NotificationSetting
| Name | Description | Value |
|---|---|---|
| emailOn | Send email notification to user on specified notification type | String array containing any of: 'JobCancelled' 'JobCompleted' 'JobFailed' |
| emails | This is the email recipient list which has a limitation of 499 characters in total concat with comma separator | string[] |
| webhooks | Send webhook callback to a service. Key is a user-provided name for the webhook. | NotificationSettingWebhooks |
NotificationSettingWebhooks
| Name | Description | Value |
|---|
RecurrenceSchedule
| Name | Description | Value |
|---|---|---|
| hours | [Required] List of hours for the schedule. | int[] (required) |
| minutes | [Required] List of minutes for the schedule. | int[] (required) |
| monthDays | List of month days for the schedule | int[] |
| weekDays | List of days for the schedule. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
RecurrenceTrigger
| Name | Description | Value |
|---|---|---|
| endTime | Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely |
string |
| frequency | [Required] The frequency to trigger schedule. | 'Day' 'Hour' 'Minute' 'Month' 'Week' (required) |
| interval | [Required] Specifies schedule interval in conjunction with frequency | int (required) |
| schedule | The recurrence schedule. | RecurrenceSchedule |
| startTime | Specifies start time of schedule in ISO 8601 format, but without a UTC offset. | string |
| timeZone | Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: /windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 |
string |
| triggerType | [Required] | 'Cron' 'Recurrence' (required) |
ResourceBaseProperties
| Name | Description | Value |
|---|
ResourceBaseTags
| Name | Description | Value |
|---|
Webhook
| Name | Description | Value |
|---|---|---|
| eventType | Send callback on a specified notification event | string |
| webhookType | Set to 'AzureDevOps' for type AzureDevOpsWebhook. | 'AzureDevOps' (required) |