Features - List

Reference

Service:: Machine Learning

API Version:: 2023-10-01

List Features.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features?api-version=2023-10-01&$skip={$skip}&tags={tags}&featureName={featureName}&description={description}&listViewType={listViewType}&pageSize={pageSize}

URI Parameters

Name	In	Required	Type	Description
featuresetName	path	True	string	Featureset name. This is case-sensitive. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$`
featuresetVersion	path	True	string	Featureset Version identifier. 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.
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.
$skip	query		string	Continuation token for pagination.
description	query		string	Description of the featureset.
featureName	query		string	feature name.
listViewType	query		ListViewType	[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.
pageSize	query		integer int32	Page size.
tags	query		string	Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2

Responses

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

Examples

List Feature.

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/features?api-version=2023-10-01&tags=string&featureName=string&description=string

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "description": "string",
        "tags": {
          "string": "string"
        },
        "properties": {
          "string": "string"
        },
        "featureName": "string",
        "dataType": "Boolean"
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999+00:50",
        "createdBy": "string",
        "createdByType": "Key",
        "lastModifiedAt": "2020-01-01T12:34:56.999+00:50",
        "lastModifiedBy": "string",
        "lastModifiedByType": "ManagedIdentity"
      }
    }
  ],
  "nextLink": "string"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Feature	DTO object representing feature
FeatureDataType
FeatureResource	Azure Resource Manager resource envelope.
FeatureResourceArmPaginatedResult	A paginated list of Feature entities.
ListViewType
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	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.

Feature

DTO object representing feature

Name	Type	Default value	Description
dataType	FeatureDataType	String	Specifies type
description	string		The asset description text.
featureName	string		Specifies name
properties	object		The asset property dictionary.
tags	object		Tag dictionary. Tags can be added, removed, and updated.

FeatureDataType

Name	Type	Description
Binary	string
Boolean	string
Datetime	string
Double	string
Float	string
Integer	string
Long	string
String	string

FeatureResource

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

FeatureResourceArmPaginatedResult

A paginated list of Feature entities.

Name	Type	Description
nextLink	string	The link to the next page of Feature objects. If null, there are no additional pages.
value	FeatureResource[]	An array of objects of type Feature.

ListViewType

Name	Type	Description
ActiveOnly	string
All	string
ArchivedOnly	string

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.

Share via