Data Containers - List

Reference

Service:: Machine Learning

API Version:: 2024-04-01

List data containers.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data?api-version=2024-04-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data?api-version=2024-04-01&$skip={$skip}&listViewType={listViewType}

URI Parameters

Name	In	Required	Type	Description
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.
listViewType	query		ListViewType	View type for including/excluding (for example) archived entities.

Responses

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

Examples

List Workspace Data Container.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data?api-version=2024-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123",
      "name": "datastore123",
      "type": "Microsoft.MachineLearningServices/workspaces/data",
      "properties": {
        "dataType": "UriFile",
        "description": "string",
        "tags": {
          "tag1": "value1",
          "tag2": "value2"
        },
        "properties": {
          "properties1": "value1",
          "properties2": "value2"
        }
      },
      "systemData": {
        "createdAt": "2020-12-01T12:00:00.000Z",
        "createdBy": "John Smith",
        "createdByType": "User",
        "lastModifiedAt": "2020-12-01T12:00:00.000Z",
        "lastModifiedBy": "John Smith",
        "lastModifiedByType": "User"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer124",
      "name": "datastore124",
      "type": "Microsoft.MachineLearningServices/workspaces/data",
      "properties": {
        "dataType": "UriFile",
        "description": "string",
        "tags": {
          "tag1": "value1",
          "tag2": "value2"
        },
        "properties": {
          "properties1": "value1",
          "properties2": "value2"
        }
      },
      "systemData": {
        "createdAt": "2020-12-01T12:00:00.000Z",
        "createdBy": "John Smith",
        "createdByType": "User",
        "lastModifiedAt": "2020-12-01T12:00:00.000Z",
        "lastModifiedBy": "John Smith",
        "lastModifiedByType": "User"
      }
    }
  ],
  "nextLink": "nextlink"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DataContainer	Container for data asset versions.
DataContainerResource	Azure Resource Manager resource envelope.
DataContainerResourceArmPaginatedResult	A paginated list of DataContainer entities.
DataType	Enum to determine the type of data.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
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

DataContainer

Container for data asset versions.

Name	Type	Default Value	Description
dataType	DataType		[Required] Specifies the type of data.
description	string		The asset description text.
isArchived	boolean	False	Is the asset archived?
latestVersion	string		The latest version inside this container.
nextVersion	string		The next auto incremental version
properties	object		The asset property dictionary.
tags	object		Tag dictionary. Tags can be added, removed, and updated.

DataContainerResource

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

DataContainerResourceArmPaginatedResult

A paginated list of DataContainer entities.

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

DataType

Enum to determine the type of data.

Name	Type	Description
mltable	string
uri_file	string
uri_folder	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.

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.