agent_applications

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

Overview

Name	agent_applications
Type	Resource
Id	azure.cognitive_services.agent_applications

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.
agentIdentityBlueprint	object	The EntraId Agentic Blueprint of the application.
agents	array	The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application.
authorizationPolicy	object	Gets or sets the authorization policy associated with this agentic application instance.
baseUrl	string	The application's dedicated invocation endpoint.
defaultInstanceIdentity	object	The (default) agent instance identity of the application.
description	string	The asset description text.
displayName	string	The display name of the application.
isEnabled	boolean	Enabledstate of the application.
provisioningState	string	Provisioning state of the application. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
trafficRoutingPolicy	object	Gets or sets the traffic routing policy for the application's deployments.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
agentIdentityBlueprint	object	The EntraId Agentic Blueprint of the application.
agents	array	The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application.
authorizationPolicy	object	Gets or sets the authorization policy associated with this agentic application instance.
baseUrl	string	The application's dedicated invocation endpoint.
defaultInstanceIdentity	object	The (default) agent instance identity of the application.
description	string	The asset description text.
displayName	string	The display name of the application.
isEnabled	boolean	Enabledstate of the application.
provisioningState	string	Provisioning state of the application. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
trafficRoutingPolicy	object	Gets or sets the traffic routing policy for the application's deployments.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, project_name, name, subscription_id		Gets an Agent Application by name. Gets an Agent Application by name.
list	select	resource_group_name, account_name, project_name, subscription_id	count, $skip, $skipToken, searchText, orderBy, orderByAsc	Lists Agent Applications in the project. Lists Agent Applications in the project.
create_or_update	insert	resource_group_name, account_name, project_name, name, subscription_id, properties		Creates or updates an Agent Application (asynchronous). Creates or updates an Agent Application (asynchronous).
create_or_update	replace	resource_group_name, account_name, project_name, name, subscription_id, properties		Creates or updates an Agent Application (asynchronous). Creates or updates an Agent Application (asynchronous).
delete	delete	resource_group_name, account_name, project_name, name, subscription_id		Delete Agent Application. Delete Agent Application.
list_agents	exec	resource_group_name, account_name, project_name, name, subscription_id		Lists agents for an Agent Application. Lists agents for an Agent Application.
enable	exec	resource_group_name, account_name, project_name, name, subscription_id		Enables an Agent Application. Enables an Agent Application.
disable	exec	resource_group_name, account_name, project_name, name, subscription_id		Disables an Agent Application. Disables an Agent Application.

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.
name	string	Name for the Agent Application. Required.
project_name	string	The name of Cognitive Services account's project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skip	integer	Number of agent applications to skip. Default value is None.
$skipToken	string	Continuation token for pagination. Default value is None.
count	integer	Number of agent applications to be retrieved in a page of results. Default value is 30.
orderBy	string	Field to order by. Default value is None.
orderByAsc	boolean	Whether to order in ascending order. Default value is False.
searchText	string	Search text for filtering agent applications. Default value is None.

SELECT examples

get

Gets an Agent Application by name. Gets an Agent Application by name.

SELECT
id,
name,
agentIdentityBlueprint,
agents,
authorizationPolicy,
baseUrl,
defaultInstanceIdentity,
description,
displayName,
isEnabled,
provisioningState,
systemData,
tags,
trafficRoutingPolicy,
type
FROM azure.cognitive_services.agent_applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists Agent Applications in the project. Lists Agent Applications in the project.

SELECT
id,
name,
agentIdentityBlueprint,
agents,
authorizationPolicy,
baseUrl,
defaultInstanceIdentity,
description,
displayName,
isEnabled,
provisioningState,
systemData,
tags,
trafficRoutingPolicy,
type
FROM azure.cognitive_services.agent_applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND count = '{{ count }}'
AND $skip = '{{ $skip }}'
AND $skipToken = '{{ $skipToken }}'
AND searchText = '{{ searchText }}'
AND orderBy = '{{ orderBy }}'
AND orderByAsc = '{{ orderByAsc }}'
;

INSERT examples

create_or_update

Creates or updates an Agent Application (asynchronous). Creates or updates an Agent Application (asynchronous).

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

Manifest

# Description fields are for documentation purposes
- name: agent_applications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the agent_applications resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the agent_applications resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the agent_applications resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the agent_applications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the agent_applications resource.
  - name: properties
    description: |
      [Required] Additional attributes of the entity. Required.
    value:
      description: "{{ description }}"
      tags: "{{ tags }}"
      displayName: "{{ displayName }}"
      baseUrl: "{{ baseUrl }}"
      agents:
        - agentId: "{{ agentId }}"
          agentName: "{{ agentName }}"
      agentIdentityBlueprint:
        kind: "{{ kind }}"
        type: "{{ type }}"
        clientId: "{{ clientId }}"
        principalId: "{{ principalId }}"
        tenantId: "{{ tenantId }}"
        subject: "{{ subject }}"
        provisioningState: "{{ provisioningState }}"
      defaultInstanceIdentity:
        kind: "{{ kind }}"
        type: "{{ type }}"
        clientId: "{{ clientId }}"
        principalId: "{{ principalId }}"
        tenantId: "{{ tenantId }}"
        subject: "{{ subject }}"
        provisioningState: "{{ provisioningState }}"
      authorizationPolicy:
        type: "{{ type }}"
      trafficRoutingPolicy:
        protocol: "{{ protocol }}"
        rules:
          - ruleId: "{{ ruleId }}"
            description: "{{ description }}"
            deploymentId: "{{ deploymentId }}"
            trafficPercentage: {{ trafficPercentage }}
      provisioningState: "{{ provisioningState }}"
      isEnabled: {{ isEnabled }}

REPLACE examples

create_or_update

Creates or updates an Agent Application (asynchronous). Creates or updates an Agent Application (asynchronous).

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

DELETE examples

delete

Delete Agent Application. Delete Agent Application.

DELETE FROM azure.cognitive_services.agent_applications
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND project_name = '{{ project_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_agents

Lists agents for an Agent Application. Lists agents for an Agent Application.

EXEC azure.cognitive_services.agent_applications.list_agents 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable

Enables an Agent Application. Enables an Agent Application.

EXEC azure.cognitive_services.agent_applications.enable 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

disable

Disables an Agent Application. Disables an Agent Application.

EXEC azure.cognitive_services.agent_applications.disable 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;