agent_deployments

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

Overview

Name	agent_deployments
Type	Resource
Id	azure.cognitive_services.agent_deployments

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.
agents	array	Returns a flat list of agent:version deployed in this deployment.
deploymentId	string	Gets or sets the unique identifier of the deployment.
deploymentType	string	Gets or sets the type of deployment for the agent. Required. Known values are: "Managed", "Hosted", and "Custom".
description	string	The asset description text.
displayName	string	Gets or sets the display name of the deployment.
protocols	array	Gets or sets the supported protocol types and versions exposed by this deployment.
provisioningState	string	Gets or sets the provisioning state of the agent deployment. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
state	string	Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents). Known values are: "Starting", "Running", "Stopping", "Stopped", "Failed", "Deleting", "Deleted", and "Updating". (Starting, Running, Stopping, Stopped, Failed, Deleting, Deleted, Updating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
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.
agents	array	Returns a flat list of agent:version deployed in this deployment.
deploymentId	string	Gets or sets the unique identifier of the deployment.
deploymentType	string	Gets or sets the type of deployment for the agent. Required. Known values are: "Managed", "Hosted", and "Custom".
description	string	The asset description text.
displayName	string	Gets or sets the display name of the deployment.
protocols	array	Gets or sets the supported protocol types and versions exposed by this deployment.
provisioningState	string	Gets or sets the provisioning state of the agent deployment. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
state	string	Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents). Known values are: "Starting", "Running", "Stopping", "Stopped", "Failed", "Deleting", "Deleted", and "Updating". (Starting, Running, Stopping, Stopped, Failed, Deleting, Deleted, Updating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tag dictionary. Tags can be added, removed, and updated.
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, app_name, deployment_name, subscription_id		Gets an Agent Deployment by name. Gets an Agent Deployment by name.
list	select	resource_group_name, account_name, project_name, app_name, subscription_id	count, $skipToken, orderBy, orderByAsc	Lists Agent Deployments in the application. Lists Agent Deployments in the application.
create_or_update	insert	resource_group_name, account_name, project_name, app_name, deployment_name, subscription_id, properties		Creates or updates an Agent Deployment (asynchronous). Creates or updates an Agent Deployment (asynchronous).
create_or_update	replace	resource_group_name, account_name, project_name, app_name, deployment_name, subscription_id, properties		Creates or updates an Agent Deployment (asynchronous). Creates or updates an Agent Deployment (asynchronous).
delete	delete	resource_group_name, account_name, project_name, app_name, deployment_name, subscription_id		Delete Agent Deployment. Delete Agent Deployment.
start	exec	resource_group_name, account_name, project_name, app_name, deployment_name, subscription_id		Starts an Agent Deployment. Starts an Agent Deployment.
stop	exec	resource_group_name, account_name, project_name, app_name, deployment_name, subscription_id		Stops an Agent Deployment. Stops an Agent Deployment.

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.
app_name	string	The name of the application associated with the Cognitive Services Account. Required.
deployment_name	string	The name of the deployment associated with the Cognitive Services Account. 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
$skipToken	string	Continuation token for pagination. Default value is None.
count	integer	Number of agent deployments 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.

SELECT examples

get

Gets an Agent Deployment by name. Gets an Agent Deployment by name.

SELECT
id,
name,
agents,
deploymentId,
deploymentType,
description,
displayName,
protocols,
provisioningState,
state,
systemData,
tags,
type
FROM azure.cognitive_services.agent_deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists Agent Deployments in the application. Lists Agent Deployments in the application.

SELECT
id,
name,
agents,
deploymentId,
deploymentType,
description,
displayName,
protocols,
provisioningState,
state,
systemData,
tags,
type
FROM azure.cognitive_services.agent_deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND count = '{{ count }}'
AND $skipToken = '{{ $skipToken }}'
AND orderBy = '{{ orderBy }}'
AND orderByAsc = '{{ orderByAsc }}'
;

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: agent_deployments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the agent_deployments resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the agent_deployments resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the agent_deployments resource.
  - name: app_name
    value: "{{ app_name }}"
    description: Required parameter for the agent_deployments resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the agent_deployments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the agent_deployments resource.
  - name: properties
    description: |
      [Required] Additional attributes of the entity. Required.
    value:
      description: "{{ description }}"
      tags: "{{ tags }}"
      displayName: "{{ displayName }}"
      deploymentId: "{{ deploymentId }}"
      state: "{{ state }}"
      protocols:
        - protocol: "{{ protocol }}"
          version: "{{ version }}"
      agents:
        - agentId: "{{ agentId }}"
          agentName: "{{ agentName }}"
          agentVersion: "{{ agentVersion }}"
      deploymentType: "{{ deploymentType }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

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

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

DELETE examples

delete

Delete Agent Deployment. Delete Agent Deployment.

DELETE FROM azure.cognitive_services.agent_deployments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND project_name = '{{ project_name }}' --required
AND app_name = '{{ app_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts an Agent Deployment. Starts an Agent Deployment.

EXEC azure.cognitive_services.agent_deployments.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops an Agent Deployment. Stops an Agent Deployment.

EXEC azure.cognitive_services.agent_deployments.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;