Azure.AI.Projects (stable:v1)

2025/07/30 • 4 updated methods

Datasets_GetVersion (updated)
Description :  Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Datasets_GetVersion",
  "Description": {
    "new": "Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.",
    "old": "Get the specific version of the DatasetVersion"
  }
}

⚼ Request

GET:  /datasets/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the DatasetVersion to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
dataUri:
{
Description: URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
type:
{
Description: Dataset type ,
Enum:
{
uri_file: URI file. ,
uri_folder: URI folder. ,
}
,
Required: True ,
}
enum ,
isReference:
{
Description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted ,
Required: False ,
}
boolean ,
connectionName:
{
Description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset ,
Required: False ,
}
string ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Datasets_DeleteVersion (updated)
Description :  Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Datasets_DeleteVersion",
  "Description": {
    "new": "Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist.",
    "old": "Delete the specific version of the DatasetVersion"
  }
}

⚼ Request

DELETE:  /datasets/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the DatasetVersion to delete. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Indexes_GetVersion (updated)
Description :  Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Indexes_GetVersion",
  "Description": {
    "new": "Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.",
    "old": "Get the specific version of the Index"
  }
}

⚼ Request

GET:  /indexes/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the Index to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Type of index ,
Enum:
{
AzureSearch: Azure search ,
CosmosDBNoSqlVectorStore: CosmosDB ,
ManagedAzureSearch: Managed Azure Search ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Indexes_DeleteVersion (updated)
Description :  Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Indexes_DeleteVersion",
  "Description": {
    "new": "Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.",
    "old": "Delete the specific version of the Index"
  }
}

⚼ Request

DELETE:  /indexes/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the Index to delete. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}