Microsoft.CognitiveServices (preview:2025-10-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 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 ,
]
,
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 ,
]
,
enablePublicHostingEnvironment:
{
Description: Whether public hosting environment is enabled for the capability host ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
}

⚐ 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 :  List capabilityHost.
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": [
          {
            "@removed_a251ac86cdb744c9b137e31ff10e4550": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_97b894ef4b4b41aaa25d20cdb4e13a23": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_02b57592c48440a28f3d17ff42013809": {
              "#name": "enablePublicHostingEnvironment",
              "Description": "Whether public hosting environment is enabled for the capability host",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    }
  }
}

⚼ 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": {
    "capabilityHost": {
      "Description": {
        "new": "Azure Resource Manager resource envelope for Project CapabilityHost.",
        "old": "Azure Resource Manager resource envelope."
      },
      "$properties": {
        "properties": [
          {
            "@removed_60eb9b9259ff4add8b7a24b3826f99b6": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_7d0894d888814ba1afbb8ec7d5a2f433": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_e133051b2aec46238c710419f6ce93e6": {
              "#name": "enablePublicHostingEnvironment",
              "Description": "Whether public hosting environment is enabled for the capability host",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Azure Resource Manager resource envelope for Project CapabilityHost.",
        "old": "Azure Resource Manager resource envelope."
      },
      "$properties": {
        "properties": [
          {
            "@removed_cff38637db4647d28dcedd9610e85e92": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_4f33866449cf4ab79bff475ba669c786": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_75c3e396238c41e4a4674838859aca79": {
              "#name": "enablePublicHostingEnvironment",
              "Description": "Whether public hosting environment is enabled for the capability host",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    },
    "201": {
      "Description": {
        "new": "Azure Resource Manager resource envelope for Project CapabilityHost.",
        "old": "Azure Resource Manager resource envelope."
      },
      "$properties": {
        "properties": [
          {
            "@removed_20f2f971691a47378a80439ed45f09f8": {
              "#name": "capabilityHostKind",
              "Description": "Kind of this capability host.",
              "Enum": [
                [
                  "Agents",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_365a2a5ff0a14df595b6e2339d6667bb": {
              "#name": "customerSubnet",
              "Description": "Customer subnet info to help set up this capability host.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_6fbbd48700814e3aab662bb0dff8af45": {
              "#name": "enablePublicHostingEnvironment",
              "Description": "Whether public hosting environment is enabled for the capability host",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    }
  }
}

⚼ 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 ,
capabilityHost:
{
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 ,
}
,
]
,
}
,
}