Indexes - List Latest

Service:

Machine Learning

API Version:

2024-04-01-preview

List the latest version of each index. Latest is defined by most recent created by date.

GET {endpoint}/genericasset/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/indexes?api-version=2024-04-01-preview

With optional parameters:

GET {endpoint}/genericasset/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/indexes?api-version=2024-04-01-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	Supported Azure-AI asset endpoints.
resourceGroupName	path	True	string	The name of the Resource Group.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the AzureML workspace or AI project.
api-version	query	True	string minLength: 1	The API version to use for this operation.
maxpagesize	query		integer (int32)	The maximum number of result items per page.
skip	query		integer (int32)	The number of result items to skip.
top	query		integer (int32)	The number of result items to return.

Responses

Name	Type	Description
200 OK	PagedIndex	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://ml.azure.com/.default

Examples

Indexes_ListLatest - generated by [MaximumSet] rule

Sample request

HTTP

GET {endpoint}/genericasset/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/ergihga/indexes?api-version=2024-04-01-preview&top=13&skip=10&maxpagesize=24

Sample response

Status code:

200

{
  "value": [
    {
      "stage": "xsjjrkichkl",
      "systemData": {
        "createdAt": "2024-02-23T17:43:10.246Z",
        "createdBy": "wpptdszccfqvk",
        "createdByType": "fzkgqxclzaiyqnalegovlcsnne",
        "lastModifiedAt": "2024-02-23T17:43:10.247Z"
      },
      "tags": {},
      "properties": {},
      "storageUri": "dlvlmnwf",
      "id": "exr",
      "description": "izwslsfziaecbzkywc"
    }
  ],
  "nextLink": "https://microsoft.com/abtorrra"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Index	Index resource Definition
PagedIndex	Paged collection of IndexVersion items.
SystemData	Metadata pertaining to creation and last modification of the resource.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

Index

Object

Index resource Definition

Name	Type	Default value	Description
description	string		Description information of the asset.
id	string		Fully qualified resource Id: azureml://workspace/{workspaceName}/indexes/{name}/versions/{version} of the index.
properties	object		Asset's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
stage	string	Development	Update stage to 'Archive' to archive the asset. Default is Development, which means the asset is under development.
storageUri	string		Default workspace blob storage Uri. Should work across storage types and auth scenarios.
systemData	SystemData		Metadata containing createdBy and modifiedBy information.
tags	object		Asset's tags. Unlike properties, tags are fully mutable.

PagedIndex

Object

Paged collection of IndexVersion items.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	Index[]	The list of Indexes.

SystemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp the resource was created at.
createdBy	string	The identity that created the resource.
createdByType	string	The identity type that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)