Microsoft.CognitiveServices (preview:2025-04-01)

2025/11/07 • 2 new, 2 updated methods

AccountCapabilityHosts_List (new)
Description :  List capabilityHost.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of Capability Host objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Capability Host. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
capabilityHostKind:
{
Description: Kind of this capability host. ,
Enum:
{
Agents: No description available. ,
}
,
Required: False ,
}
enum ,
customerSubnet:
{
Description: Customer subnet info to help set up this capability host. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
storageConnections:
{
Description: List of Storage connections. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of Thread storage connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of VectorStore connections. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProjectCapabilityHosts_List (new)
Description :  Lists all project capabilityHosts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of Project Capability Host objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Project Capability Host. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB). ,
Required: False ,
}
[
string ,
]
,
storageConnections:
{
Description: List of connection names from those available in the account or project to be used as a storage resource. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of connection names from those available in the account or project to be used for Thread storage. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProjectCapabilityHosts_Get (updated)
Description :  Get project capabilityHost.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProjectCapabilityHosts_Get",
  "$responses": {
    "200": {
      "Description": {
        "new": "Azure Resource Manager resource envelope for Project CapabilityHost.",
        "old": "Azure Resource Manager resource envelope."
      },
      "$properties": {
        "properties": [
          {
            "#name": "vectorStoreConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).",
              "old": "List of VectorStore connections."
            }
          },
          {
            "#name": "storageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used as a storage resource.",
              "old": "List of Storage connections."
            }
          },
          {
            "#name": "threadStorageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for Thread storage.",
              "old": "List of Thread storage connections."
            }
          },
          {
            "@removed_7014984461124c609116165cbeba9938": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_98ebc3c6c1194b29ab1d9cdb82bfcecb": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts/{capabilityHostName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
capabilityHostName:
{
Description: The name of the capability host associated with the Cognitive Services Resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB). ,
Required: False ,
}
[
string ,
]
,
storageConnections:
{
Description: List of connection names from those available in the account or project to be used as a storage resource. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of connection names from those available in the account or project to be used for Thread storage. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProjectCapabilityHosts_CreateOrUpdate (updated)
Description :  Create or update project capabilityHost.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProjectCapabilityHosts_CreateOrUpdate",
  "$parameters": {
    "body": {
      "Description": {
        "new": "Azure Resource Manager resource envelope for Project CapabilityHost.",
        "old": "Azure Resource Manager resource envelope."
      },
      "$properties": {
        "properties": [
          {
            "#name": "vectorStoreConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).",
              "old": "List of VectorStore connections."
            }
          },
          {
            "#name": "storageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used as a storage resource.",
              "old": "List of Storage connections."
            }
          },
          {
            "#name": "threadStorageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for Thread storage.",
              "old": "List of Thread storage connections."
            }
          },
          {
            "@removed_cbef9bbdeae7446fb44a2a1185df8e98": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_3c21cb628c164463b3f7e9448c34f840": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Azure Resource Manager resource envelope for Project CapabilityHost.",
        "old": "Azure Resource Manager resource envelope."
      },
      "$properties": {
        "properties": [
          {
            "#name": "vectorStoreConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).",
              "old": "List of VectorStore connections."
            }
          },
          {
            "#name": "storageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used as a storage resource.",
              "old": "List of Storage connections."
            }
          },
          {
            "#name": "threadStorageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for Thread storage.",
              "old": "List of Thread storage connections."
            }
          },
          {
            "@removed_d8e6f6c09a8a4dc48a6305ad7b81e941": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_b273abff5e3741f19c826578c331f46b": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    },
    "201": {
      "Description": {
        "new": "Azure Resource Manager resource envelope for Project CapabilityHost.",
        "old": "Azure Resource Manager resource envelope."
      },
      "$properties": {
        "properties": [
          {
            "#name": "vectorStoreConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).",
              "old": "List of VectorStore connections."
            }
          },
          {
            "#name": "storageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used as a storage resource.",
              "old": "List of Storage connections."
            }
          },
          {
            "#name": "threadStorageConnections",
            "Description": {
              "new": "List of connection names from those available in the account or project to be used for Thread storage.",
              "old": "List of Thread storage connections."
            }
          },
          {
            "@removed_0c5c0a01e6af4aefbca0255d34ea2f99": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_f30b50c7558f42719e6517ef5a63f22e": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts/{capabilityHostName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
capabilityHostName:
{
Description: The name of the capability host associated with the Cognitive Services Resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: CapabilityHost definition. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB). ,
Required: False ,
}
[
string ,
]
,
storageConnections:
{
Description: List of connection names from those available in the account or project to be used as a storage resource. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of connection names from those available in the account or project to be used for Thread storage. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB). ,
Required: False ,
}
[
string ,
]
,
storageConnections:
{
Description: List of connection names from those available in the account or project to be used as a storage resource. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of connection names from those available in the account or project to be used for Thread storage. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout:
{
Description: Timeout for the client to use when polling the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}
,
$schema:
{
Description: Azure Resource Manager resource envelope for Project CapabilityHost. ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB). ,
Required: False ,
}
[
string ,
]
,
storageConnections:
{
Description: List of connection names from those available in the account or project to be used as a storage resource. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of connection names from those available in the account or project to be used for Thread storage. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}