Azure.AI.Projects (preview:2025-05-15)

2025/05/09 • 24 new methods

Connections_List (new)
Description :  List all connections in the project, without populating connection credentials
Reference :  Link ¶

⚼ Request

GET:  /connections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connectionType:
{
Description: List connections of this specific type ,
Required: False ,
}
string ,
defaultConnection:
{
Description: List connections that are default connections ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of Connection items ,
}
{
value:
{
Description: The Connection items on this page ,
Required: True ,
}
[
{
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
id:
{
Description: A unique identifier for the connection, generated by the service ,
Required: True ,
}
string ,
type:
{
Description: Category of the connection ,
Enum:
{
AzureOpenAI: Azure OpenAI Service ,
AzureBlob: Azure Blob Storage, with specified container ,
AzureStorageAccount: Azure Blob Storage, with container not specified (used by Agents) ,
CognitiveSearch: Azure AI Search ,
CosmosDB: CosmosDB ,
ApiKey: Generic connection that uses API Key authentication ,
AppConfig: Application Configuration ,
AppInsights: Application Insights ,
CustomKeys: Custom Keys ,
}
,
Required: True ,
}
enum ,
target:
{
Description: The connection URL to be used for this service ,
Required: True ,
}
string ,
isDefault:
{
Description: Whether the connection is tagged as the default connection of its type ,
Required: True ,
}
boolean ,
credentials:
{
Description: The credentials used by the connection ,
Required: True ,
}
{
type:
{
Description: The type of credential used by the connection ,
Enum:
{
ApiKey: API Key credential ,
AAD: Entra ID credential (formerly known as AAD) ,
SAS: Shared Access Signature (SAS) credential ,
CustomKeys: Custom credential ,
None: No credential ,
}
,
Required: True ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the connection ,
Required: True ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Connections_Get (new)
Description :  Get a connection by name, without populating connection credentials
Reference :  Link ¶

⚼ Request

GET:  /connections/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Response from the list and get connections operations ,
}
{
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
id:
{
Description: A unique identifier for the connection, generated by the service ,
Required: True ,
}
string ,
type:
{
Description: Category of the connection ,
Enum:
{
AzureOpenAI: Azure OpenAI Service ,
AzureBlob: Azure Blob Storage, with specified container ,
AzureStorageAccount: Azure Blob Storage, with container not specified (used by Agents) ,
CognitiveSearch: Azure AI Search ,
CosmosDB: CosmosDB ,
ApiKey: Generic connection that uses API Key authentication ,
AppConfig: Application Configuration ,
AppInsights: Application Insights ,
CustomKeys: Custom Keys ,
}
,
Required: True ,
}
enum ,
target:
{
Description: The connection URL to be used for this service ,
Required: True ,
}
string ,
isDefault:
{
Description: Whether the connection is tagged as the default connection of its type ,
Required: True ,
}
boolean ,
credentials:
{
Description: The credentials used by the connection ,
Required: True ,
}
{
type:
{
Description: The type of credential used by the connection ,
Enum:
{
ApiKey: API Key credential ,
AAD: Entra ID credential (formerly known as AAD) ,
SAS: Shared Access Signature (SAS) credential ,
CustomKeys: Custom credential ,
None: No credential ,
}
,
Required: True ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the connection ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}
Connections_GetWithCredentials (new)
Description :  Get a connection by name, with its connection credentials
Reference :  Link ¶

⚼ Request

POST:  /connections/{name}/getConnectionWithCredentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Response from the list and get connections operations ,
}
{
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
id:
{
Description: A unique identifier for the connection, generated by the service ,
Required: True ,
}
string ,
type:
{
Description: Category of the connection ,
Enum:
{
AzureOpenAI: Azure OpenAI Service ,
AzureBlob: Azure Blob Storage, with specified container ,
AzureStorageAccount: Azure Blob Storage, with container not specified (used by Agents) ,
CognitiveSearch: Azure AI Search ,
CosmosDB: CosmosDB ,
ApiKey: Generic connection that uses API Key authentication ,
AppConfig: Application Configuration ,
AppInsights: Application Insights ,
CustomKeys: Custom Keys ,
}
,
Required: True ,
}
enum ,
target:
{
Description: The connection URL to be used for this service ,
Required: True ,
}
string ,
isDefault:
{
Description: Whether the connection is tagged as the default connection of its type ,
Required: True ,
}
boolean ,
credentials:
{
Description: The credentials used by the connection ,
Required: True ,
}
{
type:
{
Description: The type of credential used by the connection ,
Enum:
{
ApiKey: API Key credential ,
AAD: Entra ID credential (formerly known as AAD) ,
SAS: Shared Access Signature (SAS) credential ,
CustomKeys: Custom credential ,
None: No credential ,
}
,
Required: True ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the connection ,
Required: True ,
}
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_ListLatest (new)
Description :  List the latest version of each DatasetVersion
Reference :  Link ¶

⚼ Request

GET:  /datasets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DatasetVersion items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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_ListVersions (new)
Description :  List all versions of the given DatasetVersion
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The DatasetVersion items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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_GetVersion (new)
Description :  Get the specific version of the DatasetVersion
Reference :  Link ¶

⚼ 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_CreateOrUpdateVersion (new)
Description :  Create a new or update an existing DatasetVersion with the given version id
Reference :  Link ¶

⚼ Request

PATCH:  /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 create or replace. ,
Required: True ,
}
string ,
body:
{
Description: The definition of the DatasetVersion to create or update ,
Required: True ,
}
{
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 (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 (201)

{
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 (new)
Description :  Delete the specific version of the DatasetVersion
Reference :  Link ¶

⚼ 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 ,
}
,
}
,
}
,
}
Datasets_GetCredentials (new)
Description :  Get the SAS credential to access the storage account associated with a Dataset version.
Reference :  Link ¶

⚼ Request

POST:  /datasets/{name}/versions/{version}/credentials
{
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 operate on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
blobReference:
{
Description: Credential info to access the storage account. ,
Required: True ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Required: True ,
}
string ,
storageAccountArmId:
{
Description: ARM ID of the storage account to use. ,
Required: True ,
}
string ,
credential:
{
Description: Credential info to access the storage account. ,
Required: True ,
}
{
sasUri:
{
Description: SAS uri ,
Required: True ,
}
string ,
type:
{
Description: Type of credential ,
Enum:
{
SAS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ 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_StartPendingUploadVersion (new)
Description :  Start a new or get an existing pending upload of a dataset for a specific version.
Reference :  Link ¶

⚼ Request

POST:  /datasets/{name}/versions/{version}/startPendingUpload
{
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 operate on. ,
Required: True ,
}
string ,
body:
{
Description: Parameters for the action ,
Required: True ,
}
{
pendingUploadId:
{
Description: If PendingUploadId is not provided, a random GUID will be used. ,
Required: False ,
}
string ,
connectionName:
{
Description: Azure Storage Account connection name to use for generating temporary SAS token ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: BlobReference is the only supported type. ,
Enum:
{
BlobReference: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
blobReference:
{
Description: Container-level read, write, list SAS. ,
Required: True ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Required: True ,
}
string ,
storageAccountArmId:
{
Description: ARM ID of the storage account to use. ,
Required: True ,
}
string ,
credential:
{
Description: Credential info to access the storage account. ,
Required: True ,
}
{
sasUri:
{
Description: SAS uri ,
Required: True ,
}
string ,
type:
{
Description: Type of credential ,
Enum:
{
SAS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
pendingUploadId:
{
Description: ID for this upload request. ,
Required: True ,
}
string ,
version:
{
Description: Version of asset to be created if user did not specify version when initially creating upload ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: BlobReference is the only supported type ,
Enum:
{
BlobReference: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ 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 ,
}
,
}
,
}
,
}
Deployments_List (new)
Description :  List all deployed models in the project
Reference :  Link ¶

⚼ Request

GET:  /deployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
modelPublisher:
{
Description: Model publisher to filter models by ,
Required: False ,
}
string ,
modelName:
{
Description: Model name (the publisher specific name) to filter models by ,
Required: False ,
}
string ,
deploymentType:
{
Description: Type of deployment to filter list by ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of Deployment items ,
}
{
value:
{
Description: The Deployment items on this page ,
Required: True ,
}
[
{
type:
{
Description: The type of the deployment ,
Enum:
{
ModelDeployment: Model deployment ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Name of the deployment ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Deployments_Get (new)
Description :  Get a deployed model.
Reference :  Link ¶

⚼ Request

GET:  /deployments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Name of the deployment ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model Deployment Definition ,
}
{
type:
{
Description: The type of the deployment ,
Enum:
{
ModelDeployment: Model deployment ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Name of the deployment ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Evaluations_List (new)
Description :  List evaluation runs
Reference :  Link ¶

⚼ Request

GET:  /evaluations/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of Evaluation items ,
}
{
value:
{
Description: The Evaluation items on this page ,
Required: True ,
}
[
{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Evaluations_Get (new)
Description :  Get an evaluation run by name.
Reference :  Link ¶

⚼ Request

GET:  /evaluations/runs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Evaluation Definition ,
}
{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}
Evaluations_Create (new)
Description :  Creates an evaluation run.
Reference :  Link ¶

⚼ Request

POST:  /evaluations/runs:run
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
evaluation:
{
Description: Evaluation to be run ,
Required: True ,
}
{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}
Evaluations_CreateAgentEvaluation (new)
Description :  Creates an agent evaluation run.
Reference :  Link ¶

⚼ Request

POST:  /evaluations/runs:runAgent
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
evaluation:
{
Description: Agent evaluation to be run ,
Required: True ,
}
{
runId:
{
Description: Identifier of the agent run. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the agent thread. This field is mandatory currently, but it will be optional in the future. ,
Required: False ,
}
string ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
object ,
samplingConfiguration:
{
Description: Sampling configuration for the evaluation. ,
Required: False ,
}
{
name:
{
Description: Name of the sampling strategy. ,
Required: True ,
}
string ,
samplingPercent:
{
Description: Percentage of sampling per hour (0-100). ,
Format: float ,
Required: True ,
}
number ,
maxRequestRate:
{
Description: Maximum request rate per hour (0 to 1000). ,
Format: float ,
Required: True ,
}
number ,
}
,
redactionConfiguration:
{
Description: Redaction configuration for the evaluation. ,
Required: False ,
}
{
redactScoreProperties:
{
Description: Redact score properties. If not specified, the default is to redact in production. ,
Required: False ,
}
boolean ,
}
,
appInsightsConnectionString:
{
Description: Pass the AppInsights connection string to the agent evaluation for the evaluation results and the errors logs. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the agent evaluation run. ,
Required: True ,
}
string ,
status:
{
Description: Status of the agent evaluation. Options: Running, Completed, Failed. ,
Required: True ,
}
string ,
error:
{
Description: The reason of the request failure for the long running process, if applicable. ,
Required: False ,
}
string ,
result:
{
Description: The agent evaluation result. ,
Required: False ,
}
[
{
evaluator:
{
Description: Evaluator's name. This is the name of the evaluator that was used to evaluate the agent's completion. ,
Required: True ,
}
string ,
evaluatorId:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
score:
{
Description: Score of the given evaluator. No restriction on range. ,
Format: float ,
Required: True ,
}
number ,
status:
{
Description: Status of the evaluator result. Options: Running, Completed, Failed, NotApplicable. ,
Required: True ,
}
string ,
reason:
{
Description: Reasoning for the evaluation result. ,
Required: False ,
}
string ,
version:
{
Description: Version of the evaluator that was used to evaluate the agent's completion. ,
Required: False ,
}
string ,
threadId:
{
Description: The unique identifier of the thread. ,
Required: False ,
}
string ,
runId:
{
Description: The unique identifier of the run. ,
Required: True ,
}
string ,
error:
{
Description: A string explaining why there was an error, if applicable. ,
Required: False ,
}
string ,
additionalDetails:
{
Description: Additional properties relevant to the evaluator. These will differ between evaluators. ,
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_ListLatest (new)
Description :  List the latest version of each Index
Reference :  Link ¶

⚼ Request

GET:  /indexes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Index items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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_ListVersions (new)
Description :  List all versions of the given Index
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Index items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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 (new)
Description :  Get the specific version of the Index
Reference :  Link ¶

⚼ 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_CreateOrUpdateVersion (new)
Description :  Create a new or update an existing Index with the given version id
Reference :  Link ¶

⚼ Request

PATCH:  /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 create or replace. ,
Required: True ,
}
string ,
body:
{
Description: The definition of the Index to create or update ,
Required: True ,
}
{
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 (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 (201)

{
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 (new)
Description :  Delete the specific version of the Index
Reference :  Link ¶

⚼ 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 ,
}
,
}
,
}
,
}
RedTeams_List (new)
Description :  List a redteam by name.
Reference :  Link ¶

⚼ Request

GET:  /redTeams/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of RedTeam items ,
}
{
value:
{
Description: The RedTeam items on this page ,
Required: True ,
}
[
{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
RedTeams_Get (new)
Description :  Get a redteam by name.
Reference :  Link ¶

⚼ Request

GET:  /redTeams/runs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Red team details. ,
}
{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
RedTeams_Create (new)
Description :  Creates a redteam run.
Reference :  Link ¶

⚼ Request

POST:  /redTeams/runs:run
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
RedTeam:
{
Description: Redteam to be run ,
Required: True ,
}
{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}