Capability Hosts - Create Or Update

Service:: Machine Learning

API Version:: 2025-12-01

Create or update capabilityHost.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/capabilityHosts/{name}?api-version=2025-12-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	CapabilityHost name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Azure Machine Learning Workspace Name
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties	True	CapabilityHostProperties	[Required] Additional attributes of the entity.

Responses

Name	Type	Description
200 OK	CapabilityHost	Resource 'CapabilityHost' update operation succeeded
201 Created	CapabilityHost	The request has succeeded and a new resource has been created as a result. Headers Azure-AsyncOperation: string Retry-After: integer x-ms-async-operation-timeout: string
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

CapabilityHost

Resource 'CapabilityHost' update operation succeeded

201 Created

CapabilityHost

The request has succeeded and a new resource has been created as a result.

Headers

Azure-AsyncOperation: string
Retry-After: integer
x-ms-async-operation-timeout: string

Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

CreateOrUpdate CapabilityHost.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/capabilityHosts/capabilityHostName?api-version=2025-12-01

{
  "properties": {
    "acaEnvironmentConnections": [
      "sampleAcaEnvironmentConnection"
    ],
    "aiServicesConnections": [
      "sampleAIServiceConnection"
    ],
    "customerSubnet": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet",
    "storageConnections": [
      "sampleStorageConnection"
    ],
    "threadStorageConnections": [
      "sampleThreadStorageConnection"
    ],
    "vectorStoreConnections": [
      "sampleVectorStoreConnection"
    ]
  }
}

Sample response

Status code:: 200

{
  "name": "capabilityHostName",
  "type": "Microsoft.MachineLearningServices/workspaces/capabilityHosts",
  "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/capabilityHosts/capabilityHostName",
  "properties": {
    "description": "string",
    "acaEnvironmentConnections": [
      "sampleAcaEnvironmentConnection"
    ],
    "aiServicesConnections": [
      "sampleAIServiceConnection"
    ],
    "customerSubnet": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne",
    "provisioningState": "Succeeded",
    "storageConnections": [
      "sampleStorageConnection"
    ],
    "tags": {
      "string": "string"
    },
    "threadStorageConnections": [
      "sampleThreadStorageConnection"
    ],
    "vectorStoreConnections": [
      "sampleVectoStoreConnection"
    ]
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999+00:22",
    "createdBy": "string",
    "createdByType": "ManagedIdentity",
    "lastModifiedAt": "2020-01-01T12:34:56.999+00:22",
    "lastModifiedBy": "string",
    "lastModifiedByType": "ManagedIdentity"
  }
}

Status code:: 201

Location: example_location

{
  "name": "capabilityHostName",
  "type": "Microsoft.MachineLearningServices/workspaces/capabilityHosts",
  "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/capabilityHosts/capabilityHostName",
  "properties": {
    "description": "string",
    "acaEnvironmentConnections": [
      "sampleAcaEnvironmentConnection"
    ],
    "aiServicesConnections": [
      "sampleAIServiceConnection"
    ],
    "customerSubnet": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne",
    "provisioningState": "Succeeded",
    "storageConnections": [
      "sampleStorageConnection"
    ],
    "tags": {
      "string": "string"
    },
    "threadStorageConnections": [
      "sampleThreadStorageConnection"
    ],
    "vectorStoreConnections": [
      "sampleVectoStoreConnection"
    ]
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999+00:22",
    "createdBy": "string",
    "createdByType": "ManagedIdentity",
    "lastModifiedAt": "2020-01-01T12:34:56.999+00:22",
    "lastModifiedBy": "string",
    "lastModifiedByType": "ManagedIdentity"
  }
}

Definitions

Name	Description
CapabilityHost	Azure Resource Manager resource envelope.
CapabilityHostKind	Kind of this capability host.
CapabilityHostProperties
CapabilityHostProvisioningState	Provisioning state of capability host.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

CapabilityHost

Object

Azure Resource Manager resource envelope.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	CapabilityHostProperties	[Required] Additional attributes of the entity.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

CapabilityHostKind

Enumeration

Kind of this capability host.

Value	Description
Agents

CapabilityHostProperties

Object

Name	Type	Default value	Description
acaEnvironmentConnections	string[]		List of Aca Environment connections.
aiServicesConnections	string[]		List of AI services connections.
capabilityHostKind	CapabilityHostKind	Agents	Kind of this capability host.
customerSubnet	string		Customer subnet info to help set up this capability host.
description	string		The asset description text.
messages	string[]		List of messages containing errors.
properties	object		The asset property dictionary.
provisioningState	CapabilityHostProvisioningState		Provisioning state for the CapabilityHost.
storageConnections	string[]		List of Storage connections.
tags	object		Tag dictionary. Tags can be added, removed, and updated.
threadStorageConnections	string[]		List of Thread storage connections.
vectorStoreConnections	string[]		List of VectorStore connections.

CapabilityHostProvisioningState

Enumeration

Provisioning state of capability host.

Value	Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Capability Hosts - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

CreateOrUpdate CapabilityHost.

Sample request

Sample response

Definitions

CapabilityHost

CapabilityHostKind

CapabilityHostProperties

CapabilityHostProvisioningState

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData