Featureset Versions - Get

Service:

Machine Learning

API Version:

2023-10-01

Get version.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}?api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Container name. This is case-sensitive.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
version	path	True	string	Version identifier. This is case-sensitive.
workspaceName	path	True	string	Name of Azure Machine Learning workspace. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	The API version to use for this operation.

Responses

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

Examples

Get Workspace Featureset Version.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/featuresets/string/versions/string?api-version=2023-10-01

Sample response

Status code:

200

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "tags": {
      "string": "string"
    },
    "properties": {
      "string": "string"
    },
    "isArchived": false,
    "isAnonymous": false,
    "specification": {
      "path": "string"
    },
    "materializationSettings": {
      "storeType": "None",
      "schedule": {
        "endTime": "string",
        "startTime": "string",
        "timeZone": "string",
        "triggerType": "Recurrence",
        "frequency": "Minute",
        "interval": 1,
        "schedule": {
          "hours": [
            1
          ],
          "minutes": [
            1
          ],
          "weekDays": [
            "Wednesday"
          ],
          "monthDays": [
            1
          ]
        }
      },
      "notification": {
        "emails": [
          "string"
        ],
        "emailOn": [
          "JobFailed"
        ]
      },
      "resource": {
        "instanceType": "string"
      },
      "sparkConfiguration": {
        "string": "string"
      }
    },
    "stage": "string",
    "entities": [
      "string"
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999+00:52",
    "createdBy": "string",
    "createdByType": "Key",
    "lastModifiedAt": "2020-01-01T12:34:56.999+00:52",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application"
  }
}

Definitions

Name	Description
AssetProvisioningState	Provisioning state of registry asset.
AzureDevOpsWebhook	Webhook details specific for Azure DevOps
createdByType	The type of identity that created the resource.
EmailNotificationEnableType	Enum to determine the email notification type.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FeaturesetSpecification	DTO object representing specification
FeaturesetVersion	DTO object representing feature set version
FeaturesetVersionResource	Azure Resource Manager resource envelope.
MaterializationComputeResource	DTO object representing compute resource
MaterializationSettings
MaterializationStoreType
NotificationSetting	Configuration for notification.
RecurrenceFrequency	Enum to describe the frequency of a recurrence schedule
RecurrenceSchedule
RecurrenceTrigger
systemData	Metadata pertaining to creation and last modification of the resource.
TriggerType
WebhookType	Enum to determine the webhook callback service type.
WeekDay	Enum of weekday

AssetProvisioningState

Provisioning state of registry asset.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

AzureDevOpsWebhook

Webhook details specific for Azure DevOps

Name	Type	Description
eventType	string	Send callback on a specified notification event
webhookType	string: AzureDevOps	[Required] Specifies the type of service to send a callback

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EmailNotificationEnableType

Enum to determine the email notification type.

Name	Type	Description
JobCancelled	string
JobCompleted	string
JobFailed	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

FeaturesetSpecification

DTO object representing specification

Name	Type	Description
path	string	Specifies the spec path

FeaturesetVersion

DTO object representing feature set version

Name	Type	Default value	Description
description	string		The asset description text.
entities	string[]		Specifies list of entities
isAnonymous	boolean	False	If the name version are system generated (anonymous registration).
isArchived	boolean	False	Is the asset archived?
materializationSettings	MaterializationSettings		Specifies the materialization settings
properties	object		The asset property dictionary.
provisioningState	AssetProvisioningState		Provisioning state for the featureset version container.
specification	FeaturesetSpecification		Specifies the feature spec details
stage	string		Specifies the asset stage
tags	object		Tag dictionary. Tags can be added, removed, and updated.

FeaturesetVersionResource

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	FeaturesetVersion	[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"

MaterializationComputeResource

DTO object representing compute resource

Name	Type	Description
instanceType	string	Specifies the instance type

MaterializationSettings

Name	Type	Default value	Description
notification	NotificationSetting		Specifies the notification details
resource	MaterializationComputeResource		Specifies the compute resource settings
schedule	RecurrenceTrigger		Specifies the schedule details
sparkConfiguration	object		Specifies the spark compute settings
storeType	MaterializationStoreType	None	Specifies the stores to which materialization should happen

MaterializationStoreType

Name	Type	Description
None	string
Offline	string
Online	string
OnlineAndOffline	string

NotificationSetting

Configuration for notification.

Name	Type	Description
emailOn	EmailNotificationEnableType[]	Send email notification to user on specified notification type
emails	string[]	This is the email recipient list which has a limitation of 499 characters in total concat with comma separator
webhooks	object	Send webhook callback to a service. Key is a user-provided name for the webhook.

RecurrenceFrequency

Enum to describe the frequency of a recurrence schedule

Name	Type	Description
Day	string	Day frequency
Hour	string	Hour frequency
Minute	string	Minute frequency
Month	string	Month frequency
Week	string	Week frequency

RecurrenceSchedule

Name	Type	Description
hours	integer[]	[Required] List of hours for the schedule.
minutes	integer[]	[Required] List of minutes for the schedule.
monthDays	integer[]	List of month days for the schedule
weekDays	WeekDay[]	List of days for the schedule.

RecurrenceTrigger

Name	Type	Default value	Description
endTime	string		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
frequency	RecurrenceFrequency		[Required] The frequency to trigger schedule.
interval	integer		[Required] Specifies schedule interval in conjunction with frequency
schedule	RecurrenceSchedule		The recurrence schedule.
startTime	string		Specifies start time of schedule in ISO 8601 format, but without a UTC offset.
timeZone	string	UTC	Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11
triggerType	string: Recurrence		[Required]

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	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	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.

TriggerType

Name	Type	Description
Cron	string
Recurrence	string

WebhookType

Enum to determine the webhook callback service type.

Name	Type	Description
AzureDevOps	string

WeekDay

Enum of weekday

Name	Type	Description
Friday	string	Friday weekday
Monday	string	Monday weekday
Saturday	string	Saturday weekday
Sunday	string	Sunday weekday
Thursday	string	Thursday weekday
Tuesday	string	Tuesday weekday
Wednesday	string	Wednesday weekday