account_capability_hosts

Creates, updates, deletes, gets or lists an account_capability_hosts resource.

Overview

Name	account_capability_hosts
Type	Resource
Id	azure.cognitive_services.account_capability_hosts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
aiServicesConnections	array	List of AI services connections.
capabilityHostKind	string	Kind of this capability host. "Agents" (Agents)
customerSubnet	string	Customer subnet info to help set up this capability host.
description	string	The asset description text.
enablePublicHostingEnvironment	boolean	Whether public hosting environment is enabled for the capability host.
provisioningState	string	Provisioning state for the CapabilityHost. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
storageConnections	array	List of connection names from those available in the account or project to be used as a storage resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
threadStorageConnections	array	List of connection names from those available in the account or project to be used for Thread storage.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vectorStoreConnections	array	List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).

list

Name	Datatype	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.
aiServicesConnections	array	List of AI services connections.
capabilityHostKind	string	Kind of this capability host. "Agents" (Agents)
customerSubnet	string	Customer subnet info to help set up this capability host.
description	string	The asset description text.
enablePublicHostingEnvironment	boolean	Whether public hosting environment is enabled for the capability host.
provisioningState	string	Provisioning state for the CapabilityHost. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
storageConnections	array	List of connection names from those available in the account or project to be used as a storage resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
threadStorageConnections	array	List of connection names from those available in the account or project to be used for Thread storage.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vectorStoreConnections	array	List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, capability_host_name, subscription_id		Get account capabilityHost. Get account capabilityHost.
list	select	resource_group_name, account_name, subscription_id		List capabilityHost. List capabilityHost.
create_or_update	insert	resource_group_name, account_name, capability_host_name, subscription_id, properties		Create or update account capabilityHost. Create or update account capabilityHost.
create_or_update	replace	resource_group_name, account_name, capability_host_name, subscription_id, properties		Create or update account capabilityHost. Create or update account capabilityHost.
delete	delete	resource_group_name, account_name, capability_host_name, subscription_id		Delete account capabilityHost. Delete account capabilityHost.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The name of Cognitive Services account. Required.
capability_host_name	string	The name of the capability host associated with the Cognitive Services Resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get account capabilityHost. Get account capabilityHost.

SELECT
id,
name,
aiServicesConnections,
capabilityHostKind,
customerSubnet,
description,
enablePublicHostingEnvironment,
provisioningState,
storageConnections,
systemData,
tags,
threadStorageConnections,
type,
vectorStoreConnections
FROM azure.cognitive_services.account_capability_hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND capability_host_name = '{{ capability_host_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List capabilityHost. List capabilityHost.

SELECT
id,
name,
aiServicesConnections,
capabilityHostKind,
customerSubnet,
description,
enablePublicHostingEnvironment,
provisioningState,
storageConnections,
systemData,
tags,
threadStorageConnections,
type,
vectorStoreConnections
FROM azure.cognitive_services.account_capability_hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update account capabilityHost. Create or update account capabilityHost.

INSERT INTO azure.cognitive_services.account_capability_hosts (
properties,
resource_group_name,
account_name,
capability_host_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ capability_host_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: account_capability_hosts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the account_capability_hosts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the account_capability_hosts resource.
  - name: capability_host_name
    value: "{{ capability_host_name }}"
    description: Required parameter for the account_capability_hosts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the account_capability_hosts resource.
  - name: properties
    description: |
      [Required] Additional attributes of the entity. Required.
    value:
      description: "{{ description }}"
      tags: "{{ tags }}"
      aiServicesConnections:
        - "{{ aiServicesConnections }}"
      capabilityHostKind: "{{ capabilityHostKind }}"
      customerSubnet: "{{ customerSubnet }}"
      provisioningState: "{{ provisioningState }}"
      storageConnections:
        - "{{ storageConnections }}"
      threadStorageConnections:
        - "{{ threadStorageConnections }}"
      vectorStoreConnections:
        - "{{ vectorStoreConnections }}"
      enablePublicHostingEnvironment: {{ enablePublicHostingEnvironment }}

REPLACE examples

create_or_update

Create or update account capabilityHost. Create or update account capabilityHost.

REPLACE azure.cognitive_services.account_capability_hosts
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND capability_host_name = '{{ capability_host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete account capabilityHost. Delete account capabilityHost.

DELETE FROM azure.cognitive_services.account_capability_hosts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND capability_host_name = '{{ capability_host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;