Data Versions - Get

Reference

Service:: Machine Learning

API Version:: 2023-10-01

Get version.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Container name.
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.
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	DataVersionBaseResource	Success
Other Status Codes	ErrorResponse	Error

Examples

Get Workspace Data Version Base.

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "dataType": "uri_file",
    "dataUri": "string",
    "description": "string",
    "tags": {
      "string": "string"
    },
    "properties": {
      "string": "string"
    },
    "isAnonymous": false
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DataType	Enum to determine the type of data.
DataVersionBaseResource	Azure Resource Manager resource envelope.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MLTableData	MLTable data definition
systemData	Metadata pertaining to creation and last modification of the resource.
UriFileDataVersion	uri-file data version entity
UriFolderDataVersion	uri-folder data version entity

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataType

Enum to determine the type of data.

Name	Type	Description
mltable	string
uri_file	string
uri_folder	string

DataVersionBaseResource

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	DataVersionBase: MLTableData UriFileDataVersion UriFolderDataVersion	[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"

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.

MLTableData

MLTable data definition

Name	Type	Default Value	Description
dataType	string: mltable		[Required] Specifies the type of data.
dataUri	string		[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330
description	string		The asset description text.
isAnonymous	boolean	False	If the name version are system generated (anonymous registration).
isArchived	boolean	False	Is the asset archived?
properties	object		The asset property dictionary.
referencedUris	string[]		Uris referenced in the MLTable definition (required for lineage)
tags	object		Tag dictionary. Tags can be added, removed, and updated.

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.

UriFileDataVersion

uri-file data version entity

Name	Type	Default Value	Description
dataType	string: uri_file		[Required] Specifies the type of data.
dataUri	string		[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330
description	string		The asset description text.
isAnonymous	boolean	False	If the name version are system generated (anonymous registration).
isArchived	boolean	False	Is the asset archived?
properties	object		The asset property dictionary.
tags	object		Tag dictionary. Tags can be added, removed, and updated.

UriFolderDataVersion

uri-folder data version entity

Name	Type	Default Value	Description
dataType	string: uri_folder		[Required] Specifies the type of data.
dataUri	string		[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330
description	string		The asset description text.
isAnonymous	boolean	False	If the name version are system generated (anonymous registration).
isArchived	boolean	False	Is the asset archived?
properties	object		The asset property dictionary.
tags	object		Tag dictionary. Tags can be added, removed, and updated.

Share via