Agent Deployment resource
Uses Azure REST API version 2025-10-01-preview.
Example Usage
Create or Update Agent Deployment.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var agentDeployment = new AzureNative.CognitiveServices.AgentDeployment("agentDeployment", new()
{
AccountName = "my-cognitive-services-account",
AppName = "agent-app-1",
DeploymentName = "deployment-1",
ProjectName = "my-project",
Properties = new AzureNative.CognitiveServices.Inputs.ManagedAgentDeploymentArgs
{
Agents = new[]
{
new AzureNative.CognitiveServices.Inputs.VersionedAgentReferenceArgs
{
AgentId = "agent-123",
AgentName = "support-agent",
AgentVersion = "1.0.0",
},
},
DeploymentType = "Managed",
DisplayName = "Production Deployment",
Protocols = new[]
{
new AzureNative.CognitiveServices.Inputs.AgentProtocolVersionArgs
{
Protocol = AzureNative.CognitiveServices.AgentProtocol.Agent,
Version = "1.0",
},
},
State = AzureNative.CognitiveServices.AgentDeploymentState.Starting,
},
ResourceGroupName = "test-rg",
});
});
package main
import (
cognitiveservices "github.com/pulumi/pulumi-azure-native-sdk/cognitiveservices/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cognitiveservices.NewAgentDeployment(ctx, "agentDeployment", &cognitiveservices.AgentDeploymentArgs{
AccountName: pulumi.String("my-cognitive-services-account"),
AppName: pulumi.String("agent-app-1"),
DeploymentName: pulumi.String("deployment-1"),
ProjectName: pulumi.String("my-project"),
Properties: &cognitiveservices.ManagedAgentDeploymentArgs{
Agents: cognitiveservices.VersionedAgentReferenceArray{
&cognitiveservices.VersionedAgentReferenceArgs{
AgentId: pulumi.String("agent-123"),
AgentName: pulumi.String("support-agent"),
AgentVersion: pulumi.String("1.0.0"),
},
},
DeploymentType: pulumi.String("Managed"),
DisplayName: pulumi.String("Production Deployment"),
Protocols: cognitiveservices.AgentProtocolVersionArray{
&cognitiveservices.AgentProtocolVersionArgs{
Protocol: pulumi.String(cognitiveservices.AgentProtocolAgent),
Version: pulumi.String("1.0"),
},
},
State: pulumi.String(cognitiveservices.AgentDeploymentStateStarting),
},
ResourceGroupName: pulumi.String("test-rg"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cognitiveservices.AgentDeployment;
import com.pulumi.azurenative.cognitiveservices.AgentDeploymentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var agentDeployment = new AgentDeployment("agentDeployment", AgentDeploymentArgs.builder()
.accountName("my-cognitive-services-account")
.appName("agent-app-1")
.deploymentName("deployment-1")
.projectName("my-project")
.properties(ManagedAgentDeploymentArgs.builder()
.agents(VersionedAgentReferenceArgs.builder()
.agentId("agent-123")
.agentName("support-agent")
.agentVersion("1.0.0")
.build())
.deploymentType("Managed")
.displayName("Production Deployment")
.protocols(AgentProtocolVersionArgs.builder()
.protocol("Agent")
.version("1.0")
.build())
.state("Starting")
.build())
.resourceGroupName("test-rg")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const agentDeployment = new azure_native.cognitiveservices.AgentDeployment("agentDeployment", {
accountName: "my-cognitive-services-account",
appName: "agent-app-1",
deploymentName: "deployment-1",
projectName: "my-project",
properties: {
agents: [{
agentId: "agent-123",
agentName: "support-agent",
agentVersion: "1.0.0",
}],
deploymentType: "Managed",
displayName: "Production Deployment",
protocols: [{
protocol: azure_native.cognitiveservices.AgentProtocol.Agent,
version: "1.0",
}],
state: azure_native.cognitiveservices.AgentDeploymentState.Starting,
},
resourceGroupName: "test-rg",
});
import pulumi
import pulumi_azure_native as azure_native
agent_deployment = azure_native.cognitiveservices.AgentDeployment("agentDeployment",
account_name="my-cognitive-services-account",
app_name="agent-app-1",
deployment_name="deployment-1",
project_name="my-project",
properties={
"agents": [{
"agent_id": "agent-123",
"agent_name": "support-agent",
"agent_version": "1.0.0",
}],
"deployment_type": "Managed",
"display_name": "Production Deployment",
"protocols": [{
"protocol": azure_native.cognitiveservices.AgentProtocol.AGENT,
"version": "1.0",
}],
"state": azure_native.cognitiveservices.AgentDeploymentState.STARTING,
},
resource_group_name="test-rg")
resources:
agentDeployment:
type: azure-native:cognitiveservices:AgentDeployment
properties:
accountName: my-cognitive-services-account
appName: agent-app-1
deploymentName: deployment-1
projectName: my-project
properties:
agents:
- agentId: agent-123
agentName: support-agent
agentVersion: 1.0.0
deploymentType: Managed
displayName: Production Deployment
protocols:
- protocol: Agent
version: '1.0'
state: Starting
resourceGroupName: test-rg
Create AgentDeployment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AgentDeployment(name: string, args: AgentDeploymentArgs, opts?: CustomResourceOptions);@overload
def AgentDeployment(resource_name: str,
args: AgentDeploymentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AgentDeployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
app_name: Optional[str] = None,
project_name: Optional[str] = None,
properties: Optional[Union[HostedAgentDeploymentArgs, ManagedAgentDeploymentArgs]] = None,
resource_group_name: Optional[str] = None,
deployment_name: Optional[str] = None)func NewAgentDeployment(ctx *Context, name string, args AgentDeploymentArgs, opts ...ResourceOption) (*AgentDeployment, error)public AgentDeployment(string name, AgentDeploymentArgs args, CustomResourceOptions? opts = null)
public AgentDeployment(String name, AgentDeploymentArgs args)
public AgentDeployment(String name, AgentDeploymentArgs args, CustomResourceOptions options)
type: azure-native:cognitiveservices:AgentDeployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AgentDeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AgentDeploymentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AgentDeploymentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentDeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentDeploymentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var agentDeploymentResource = new AzureNative.CognitiveServices.AgentDeployment("agentDeploymentResource", new()
{
AccountName = "string",
AppName = "string",
ProjectName = "string",
Properties = new AzureNative.CognitiveServices.Inputs.HostedAgentDeploymentArgs
{
DeploymentType = "Hosted",
Agents = new[]
{
new AzureNative.CognitiveServices.Inputs.VersionedAgentReferenceArgs
{
AgentId = "string",
AgentName = "string",
AgentVersion = "string",
},
},
DeploymentId = "string",
Description = "string",
DisplayName = "string",
MaxReplicas = 0,
MinReplicas = 0,
Protocols = new[]
{
new AzureNative.CognitiveServices.Inputs.AgentProtocolVersionArgs
{
Protocol = "string",
Version = "string",
},
},
State = "string",
Tags =
{
{ "string", "string" },
},
},
ResourceGroupName = "string",
DeploymentName = "string",
});
example, err := cognitiveservices.NewAgentDeployment(ctx, "agentDeploymentResource", &cognitiveservices.AgentDeploymentArgs{
AccountName: pulumi.String("string"),
AppName: pulumi.String("string"),
ProjectName: pulumi.String("string"),
Properties: &cognitiveservices.HostedAgentDeploymentArgs{
DeploymentType: pulumi.String("Hosted"),
Agents: cognitiveservices.VersionedAgentReferenceArray{
&cognitiveservices.VersionedAgentReferenceArgs{
AgentId: pulumi.String("string"),
AgentName: pulumi.String("string"),
AgentVersion: pulumi.String("string"),
},
},
DeploymentId: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
MaxReplicas: pulumi.Int(0),
MinReplicas: pulumi.Int(0),
Protocols: cognitiveservices.AgentProtocolVersionArray{
&cognitiveservices.AgentProtocolVersionArgs{
Protocol: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
State: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
ResourceGroupName: pulumi.String("string"),
DeploymentName: pulumi.String("string"),
})
var agentDeploymentResource = new AgentDeployment("agentDeploymentResource", AgentDeploymentArgs.builder()
.accountName("string")
.appName("string")
.projectName("string")
.properties(HostedAgentDeploymentArgs.builder()
.deploymentType("Hosted")
.agents(VersionedAgentReferenceArgs.builder()
.agentId("string")
.agentName("string")
.agentVersion("string")
.build())
.deploymentId("string")
.description("string")
.displayName("string")
.maxReplicas(0)
.minReplicas(0)
.protocols(AgentProtocolVersionArgs.builder()
.protocol("string")
.version("string")
.build())
.state("string")
.tags(Map.of("string", "string"))
.build())
.resourceGroupName("string")
.deploymentName("string")
.build());
agent_deployment_resource = azure_native.cognitiveservices.AgentDeployment("agentDeploymentResource",
account_name="string",
app_name="string",
project_name="string",
properties={
"deployment_type": "Hosted",
"agents": [{
"agent_id": "string",
"agent_name": "string",
"agent_version": "string",
}],
"deployment_id": "string",
"description": "string",
"display_name": "string",
"max_replicas": 0,
"min_replicas": 0,
"protocols": [{
"protocol": "string",
"version": "string",
}],
"state": "string",
"tags": {
"string": "string",
},
},
resource_group_name="string",
deployment_name="string")
const agentDeploymentResource = new azure_native.cognitiveservices.AgentDeployment("agentDeploymentResource", {
accountName: "string",
appName: "string",
projectName: "string",
properties: {
deploymentType: "Hosted",
agents: [{
agentId: "string",
agentName: "string",
agentVersion: "string",
}],
deploymentId: "string",
description: "string",
displayName: "string",
maxReplicas: 0,
minReplicas: 0,
protocols: [{
protocol: "string",
version: "string",
}],
state: "string",
tags: {
string: "string",
},
},
resourceGroupName: "string",
deploymentName: "string",
});
type: azure-native:cognitiveservices:AgentDeployment
properties:
accountName: string
appName: string
deploymentName: string
projectName: string
properties:
agents:
- agentId: string
agentName: string
agentVersion: string
deploymentId: string
deploymentType: Hosted
description: string
displayName: string
maxReplicas: 0
minReplicas: 0
protocols:
- protocol: string
version: string
state: string
tags:
string: string
resourceGroupName: string
AgentDeployment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AgentDeployment resource accepts the following input properties:
- Account
Name string - The name of Cognitive Services account.
- App
Name string - The name of the application associated with the Cognitive Services Account
- Project
Name string - The name of Cognitive Services account's project.
- Properties
Pulumi.
Azure | Pulumi.Native. Cognitive Services. Inputs. Hosted Agent Deployment Azure Native. Cognitive Services. Inputs. Managed Agent Deployment - [Required] Additional attributes of the entity.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Deployment
Name string - The name of the deployment associated with the Cognitive Services Account
- Account
Name string - The name of Cognitive Services account.
- App
Name string - The name of the application associated with the Cognitive Services Account
- Project
Name string - The name of Cognitive Services account's project.
- Properties
Hosted
Agent | ManagedDeployment Args Agent Deployment Args - [Required] Additional attributes of the entity.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Deployment
Name string - The name of the deployment associated with the Cognitive Services Account
- account
Name String - The name of Cognitive Services account.
- app
Name String - The name of the application associated with the Cognitive Services Account
- project
Name String - The name of Cognitive Services account's project.
- properties
Hosted
Agent | ManagedDeployment Agent Deployment - [Required] Additional attributes of the entity.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- deployment
Name String - The name of the deployment associated with the Cognitive Services Account
- account
Name string - The name of Cognitive Services account.
- app
Name string - The name of the application associated with the Cognitive Services Account
- project
Name string - The name of Cognitive Services account's project.
- properties
Hosted
Agent | ManagedDeployment Agent Deployment - [Required] Additional attributes of the entity.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- deployment
Name string - The name of the deployment associated with the Cognitive Services Account
- account_
name str - The name of Cognitive Services account.
- app_
name str - The name of the application associated with the Cognitive Services Account
- project_
name str - The name of Cognitive Services account's project.
- properties
Hosted
Agent | ManagedDeployment Args Agent Deployment Args - [Required] Additional attributes of the entity.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- deployment_
name str - The name of the deployment associated with the Cognitive Services Account
- account
Name String - The name of Cognitive Services account.
- app
Name String - The name of the application associated with the Cognitive Services Account
- project
Name String - The name of Cognitive Services account's project.
- properties Property Map | Property Map
- [Required] Additional attributes of the entity.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- deployment
Name String - The name of the deployment associated with the Cognitive Services Account
Outputs
All input properties are implicitly available as output properties. Additionally, the AgentDeployment resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Cognitive Services. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - 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"
Supporting Types
AgentDeploymentState, AgentDeploymentStateArgs
- Starting
StartingThe deployment is starting.- Running
RunningThe deployment started/is operational.- Stopping
StoppingThe deployment is being stopped.- Stopped
StoppedThe deployment was stopped.- Failed
FailedThe deployment failed.- Deleting
DeletingThe deployment is being deleted.- Deleted
DeletedThe deployment was deleted.- Updating
UpdatingThe deployment is being updated.
- Agent
Deployment State Starting StartingThe deployment is starting.- Agent
Deployment State Running RunningThe deployment started/is operational.- Agent
Deployment State Stopping StoppingThe deployment is being stopped.- Agent
Deployment State Stopped StoppedThe deployment was stopped.- Agent
Deployment State Failed FailedThe deployment failed.- Agent
Deployment State Deleting DeletingThe deployment is being deleted.- Agent
Deployment State Deleted DeletedThe deployment was deleted.- Agent
Deployment State Updating UpdatingThe deployment is being updated.
- Starting
StartingThe deployment is starting.- Running
RunningThe deployment started/is operational.- Stopping
StoppingThe deployment is being stopped.- Stopped
StoppedThe deployment was stopped.- Failed
FailedThe deployment failed.- Deleting
DeletingThe deployment is being deleted.- Deleted
DeletedThe deployment was deleted.- Updating
UpdatingThe deployment is being updated.
- Starting
StartingThe deployment is starting.- Running
RunningThe deployment started/is operational.- Stopping
StoppingThe deployment is being stopped.- Stopped
StoppedThe deployment was stopped.- Failed
FailedThe deployment failed.- Deleting
DeletingThe deployment is being deleted.- Deleted
DeletedThe deployment was deleted.- Updating
UpdatingThe deployment is being updated.
- STARTING
StartingThe deployment is starting.- RUNNING
RunningThe deployment started/is operational.- STOPPING
StoppingThe deployment is being stopped.- STOPPED
StoppedThe deployment was stopped.- FAILED
FailedThe deployment failed.- DELETING
DeletingThe deployment is being deleted.- DELETED
DeletedThe deployment was deleted.- UPDATING
UpdatingThe deployment is being updated.
- "Starting"
StartingThe deployment is starting.- "Running"
RunningThe deployment started/is operational.- "Stopping"
StoppingThe deployment is being stopped.- "Stopped"
StoppedThe deployment was stopped.- "Failed"
FailedThe deployment failed.- "Deleting"
DeletingThe deployment is being deleted.- "Deleted"
DeletedThe deployment was deleted.- "Updating"
UpdatingThe deployment is being updated.
AgentProtocol, AgentProtocolArgs
- Agent
AgentAgent protocol (aka Active)- A2A
A2AAgent2Agent standard- Responses
ResponsesOpenAI-compatible
- Agent
Protocol Agent AgentAgent protocol (aka Active)- Agent
Protocol A2A A2AAgent2Agent standard- Agent
Protocol Responses ResponsesOpenAI-compatible
- Agent
AgentAgent protocol (aka Active)- A2A
A2AAgent2Agent standard- Responses
ResponsesOpenAI-compatible
- Agent
AgentAgent protocol (aka Active)- A2A
A2AAgent2Agent standard- Responses
ResponsesOpenAI-compatible
- AGENT
AgentAgent protocol (aka Active)- A2_A
A2AAgent2Agent standard- RESPONSES
ResponsesOpenAI-compatible
- "Agent"
AgentAgent protocol (aka Active)- "A2A"
A2AAgent2Agent standard- "Responses"
ResponsesOpenAI-compatible
AgentProtocolVersion, AgentProtocolVersionArgs
Type modeling the protocol and version used by an agent/exposed by a deployment.- Protocol
string | Pulumi.
Azure Native. Cognitive Services. Agent Protocol - The protocol used by the agent/exposed by a deployment.
- Version string
- The version of the protocol.
- Protocol
string | Agent
Protocol - The protocol used by the agent/exposed by a deployment.
- Version string
- The version of the protocol.
- protocol
String | Agent
Protocol - The protocol used by the agent/exposed by a deployment.
- version String
- The version of the protocol.
- protocol
string | Agent
Protocol - The protocol used by the agent/exposed by a deployment.
- version string
- The version of the protocol.
- protocol
str | Agent
Protocol - The protocol used by the agent/exposed by a deployment.
- version str
- The version of the protocol.
- protocol String | "Agent" | "A2A" | "Responses"
- The protocol used by the agent/exposed by a deployment.
- version String
- The version of the protocol.
AgentProtocolVersionResponse, AgentProtocolVersionResponseArgs
Type modeling the protocol and version used by an agent/exposed by a deployment.HostedAgentDeployment, HostedAgentDeploymentArgs
Represents a hosted agent deployment where the underlying infrastructure is owned by the platform.- Agents
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Versioned Agent Reference> - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Max
Replicas int - Gets or sets the maximum number of replicas for this hosted deployment.
- Min
Replicas int - Gets or sets the minimum number of replicas for this hosted deployment.
- Protocols
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Agent Protocol Version> - Gets or sets the supported protocol types and versions exposed by this deployment.
- State
string | Pulumi.
Azure Native. Cognitive Services. Agent Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Dictionary<string, string>
- Tag dictionary. Tags can be added, removed, and updated.
- Agents
[]Versioned
Agent Reference - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Max
Replicas int - Gets or sets the maximum number of replicas for this hosted deployment.
- Min
Replicas int - Gets or sets the minimum number of replicas for this hosted deployment.
- Protocols
[]Agent
Protocol Version - Gets or sets the supported protocol types and versions exposed by this deployment.
- State
string | Agent
Deployment State Enum - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- map[string]string
- Tag dictionary. Tags can be added, removed, and updated.
- agents
List<Versioned
Agent Reference> - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- max
Replicas Integer - Gets or sets the maximum number of replicas for this hosted deployment.
- min
Replicas Integer - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols
List<Agent
Protocol Version> - Gets or sets the supported protocol types and versions exposed by this deployment.
- state
String | Agent
Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String,String>
- Tag dictionary. Tags can be added, removed, and updated.
- agents
Versioned
Agent Reference[] - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id string - Gets or sets the unique identifier of the deployment.
- description string
- The asset description text.
- display
Name string - Gets or sets the display name of the deployment.
- max
Replicas number - Gets or sets the maximum number of replicas for this hosted deployment.
- min
Replicas number - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols
Agent
Protocol Version[] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state
string | Agent
Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- {[key: string]: string}
- Tag dictionary. Tags can be added, removed, and updated.
- agents
Sequence[Versioned
Agent Reference] - Returns a flat list of agent:version deployed in this deployment.
- deployment_
id str - Gets or sets the unique identifier of the deployment.
- description str
- The asset description text.
- display_
name str - Gets or sets the display name of the deployment.
- max_
replicas int - Gets or sets the maximum number of replicas for this hosted deployment.
- min_
replicas int - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols
Sequence[Agent
Protocol Version] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state
str | Agent
Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Mapping[str, str]
- Tag dictionary. Tags can be added, removed, and updated.
- agents List<Property Map>
- Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- max
Replicas Number - Gets or sets the maximum number of replicas for this hosted deployment.
- min
Replicas Number - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols List<Property Map>
- Gets or sets the supported protocol types and versions exposed by this deployment.
- state String | "Starting" | "Running" | "Stopping" | "Stopped" | "Failed" | "Deleting" | "Deleted" | "Updating"
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String>
- Tag dictionary. Tags can be added, removed, and updated.
HostedAgentDeploymentResponse, HostedAgentDeploymentResponseArgs
Represents a hosted agent deployment where the underlying infrastructure is owned by the platform.- Provisioning
State string - Gets or sets the provisioning state of the agent deployment.
- Agents
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Versioned Agent Reference Response> - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Max
Replicas int - Gets or sets the maximum number of replicas for this hosted deployment.
- Min
Replicas int - Gets or sets the minimum number of replicas for this hosted deployment.
- Protocols
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Agent Protocol Version Response> - Gets or sets the supported protocol types and versions exposed by this deployment.
- State string
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Dictionary<string, string>
- Tag dictionary. Tags can be added, removed, and updated.
- Provisioning
State string - Gets or sets the provisioning state of the agent deployment.
- Agents
[]Versioned
Agent Reference Response - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Max
Replicas int - Gets or sets the maximum number of replicas for this hosted deployment.
- Min
Replicas int - Gets or sets the minimum number of replicas for this hosted deployment.
- Protocols
[]Agent
Protocol Version Response - Gets or sets the supported protocol types and versions exposed by this deployment.
- State string
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- map[string]string
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning
State String - Gets or sets the provisioning state of the agent deployment.
- agents
List<Versioned
Agent Reference Response> - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- max
Replicas Integer - Gets or sets the maximum number of replicas for this hosted deployment.
- min
Replicas Integer - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols
List<Agent
Protocol Version Response> - Gets or sets the supported protocol types and versions exposed by this deployment.
- state String
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String,String>
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning
State string - Gets or sets the provisioning state of the agent deployment.
- agents
Versioned
Agent Reference Response[] - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id string - Gets or sets the unique identifier of the deployment.
- description string
- The asset description text.
- display
Name string - Gets or sets the display name of the deployment.
- max
Replicas number - Gets or sets the maximum number of replicas for this hosted deployment.
- min
Replicas number - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols
Agent
Protocol Version Response[] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state string
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- {[key: string]: string}
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning_
state str - Gets or sets the provisioning state of the agent deployment.
- agents
Sequence[Versioned
Agent Reference Response] - Returns a flat list of agent:version deployed in this deployment.
- deployment_
id str - Gets or sets the unique identifier of the deployment.
- description str
- The asset description text.
- display_
name str - Gets or sets the display name of the deployment.
- max_
replicas int - Gets or sets the maximum number of replicas for this hosted deployment.
- min_
replicas int - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols
Sequence[Agent
Protocol Version Response] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state str
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Mapping[str, str]
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning
State String - Gets or sets the provisioning state of the agent deployment.
- agents List<Property Map>
- Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- max
Replicas Number - Gets or sets the maximum number of replicas for this hosted deployment.
- min
Replicas Number - Gets or sets the minimum number of replicas for this hosted deployment.
- protocols List<Property Map>
- Gets or sets the supported protocol types and versions exposed by this deployment.
- state String
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String>
- Tag dictionary. Tags can be added, removed, and updated.
ManagedAgentDeployment, ManagedAgentDeploymentArgs
Represents a managed agent deployment where the underlying infrastructure is managed by the platform in the deployer's subscription.- Agents
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Versioned Agent Reference> - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Protocols
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Agent Protocol Version> - Gets or sets the supported protocol types and versions exposed by this deployment.
- State
string | Pulumi.
Azure Native. Cognitive Services. Agent Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Dictionary<string, string>
- Tag dictionary. Tags can be added, removed, and updated.
- Agents
[]Versioned
Agent Reference - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Protocols
[]Agent
Protocol Version - Gets or sets the supported protocol types and versions exposed by this deployment.
- State
string | Agent
Deployment State Enum - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- map[string]string
- Tag dictionary. Tags can be added, removed, and updated.
- agents
List<Versioned
Agent Reference> - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- protocols
List<Agent
Protocol Version> - Gets or sets the supported protocol types and versions exposed by this deployment.
- state
String | Agent
Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String,String>
- Tag dictionary. Tags can be added, removed, and updated.
- agents
Versioned
Agent Reference[] - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id string - Gets or sets the unique identifier of the deployment.
- description string
- The asset description text.
- display
Name string - Gets or sets the display name of the deployment.
- protocols
Agent
Protocol Version[] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state
string | Agent
Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- {[key: string]: string}
- Tag dictionary. Tags can be added, removed, and updated.
- agents
Sequence[Versioned
Agent Reference] - Returns a flat list of agent:version deployed in this deployment.
- deployment_
id str - Gets or sets the unique identifier of the deployment.
- description str
- The asset description text.
- display_
name str - Gets or sets the display name of the deployment.
- protocols
Sequence[Agent
Protocol Version] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state
str | Agent
Deployment State - Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Mapping[str, str]
- Tag dictionary. Tags can be added, removed, and updated.
- agents List<Property Map>
- Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- protocols List<Property Map>
- Gets or sets the supported protocol types and versions exposed by this deployment.
- state String | "Starting" | "Running" | "Stopping" | "Stopped" | "Failed" | "Deleting" | "Deleted" | "Updating"
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String>
- Tag dictionary. Tags can be added, removed, and updated.
ManagedAgentDeploymentResponse, ManagedAgentDeploymentResponseArgs
Represents a managed agent deployment where the underlying infrastructure is managed by the platform in the deployer's subscription.- Provisioning
State string - Gets or sets the provisioning state of the agent deployment.
- Agents
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Versioned Agent Reference Response> - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Protocols
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Agent Protocol Version Response> - Gets or sets the supported protocol types and versions exposed by this deployment.
- State string
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Dictionary<string, string>
- Tag dictionary. Tags can be added, removed, and updated.
- Provisioning
State string - Gets or sets the provisioning state of the agent deployment.
- Agents
[]Versioned
Agent Reference Response - Returns a flat list of agent:version deployed in this deployment.
- Deployment
Id string - Gets or sets the unique identifier of the deployment.
- Description string
- The asset description text.
- Display
Name string - Gets or sets the display name of the deployment.
- Protocols
[]Agent
Protocol Version Response - Gets or sets the supported protocol types and versions exposed by this deployment.
- State string
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- map[string]string
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning
State String - Gets or sets the provisioning state of the agent deployment.
- agents
List<Versioned
Agent Reference Response> - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- protocols
List<Agent
Protocol Version Response> - Gets or sets the supported protocol types and versions exposed by this deployment.
- state String
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String,String>
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning
State string - Gets or sets the provisioning state of the agent deployment.
- agents
Versioned
Agent Reference Response[] - Returns a flat list of agent:version deployed in this deployment.
- deployment
Id string - Gets or sets the unique identifier of the deployment.
- description string
- The asset description text.
- display
Name string - Gets or sets the display name of the deployment.
- protocols
Agent
Protocol Version Response[] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state string
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- {[key: string]: string}
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning_
state str - Gets or sets the provisioning state of the agent deployment.
- agents
Sequence[Versioned
Agent Reference Response] - Returns a flat list of agent:version deployed in this deployment.
- deployment_
id str - Gets or sets the unique identifier of the deployment.
- description str
- The asset description text.
- display_
name str - Gets or sets the display name of the deployment.
- protocols
Sequence[Agent
Protocol Version Response] - Gets or sets the supported protocol types and versions exposed by this deployment.
- state str
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Mapping[str, str]
- Tag dictionary. Tags can be added, removed, and updated.
- provisioning
State String - Gets or sets the provisioning state of the agent deployment.
- agents List<Property Map>
- Returns a flat list of agent:version deployed in this deployment.
- deployment
Id String - Gets or sets the unique identifier of the deployment.
- description String
- The asset description text.
- display
Name String - Gets or sets the display name of the deployment.
- protocols List<Property Map>
- Gets or sets the supported protocol types and versions exposed by this deployment.
- state String
- Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).
- Map<String>
- Tag dictionary. Tags can be added, removed, and updated.
SystemDataResponse, SystemDataResponseArgs
Metadata pertaining to creation and last modification of the resource.- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
VersionedAgentReference, VersionedAgentReferenceArgs
Type modeling a reference to a version of an agent definition.- Agent
Id string - Gets the agent's unique identifier within the organization (subscription).
- Agent
Name string - Gets the agent's name (unique within the project/app).
- Agent
Version string - Gets the agent's version (unique for each agent lineage).
- Agent
Id string - Gets the agent's unique identifier within the organization (subscription).
- Agent
Name string - Gets the agent's name (unique within the project/app).
- Agent
Version string - Gets the agent's version (unique for each agent lineage).
- agent
Id String - Gets the agent's unique identifier within the organization (subscription).
- agent
Name String - Gets the agent's name (unique within the project/app).
- agent
Version String - Gets the agent's version (unique for each agent lineage).
- agent
Id string - Gets the agent's unique identifier within the organization (subscription).
- agent
Name string - Gets the agent's name (unique within the project/app).
- agent
Version string - Gets the agent's version (unique for each agent lineage).
- agent_
id str - Gets the agent's unique identifier within the organization (subscription).
- agent_
name str - Gets the agent's name (unique within the project/app).
- agent_
version str - Gets the agent's version (unique for each agent lineage).
- agent
Id String - Gets the agent's unique identifier within the organization (subscription).
- agent
Name String - Gets the agent's name (unique within the project/app).
- agent
Version String - Gets the agent's version (unique for each agent lineage).
VersionedAgentReferenceResponse, VersionedAgentReferenceResponseArgs
Type modeling a reference to a version of an agent definition.- Agent
Id string - Gets the agent's unique identifier within the organization (subscription).
- Agent
Name string - Gets the agent's name (unique within the project/app).
- Agent
Version string - Gets the agent's version (unique for each agent lineage).
- Agent
Id string - Gets the agent's unique identifier within the organization (subscription).
- Agent
Name string - Gets the agent's name (unique within the project/app).
- Agent
Version string - Gets the agent's version (unique for each agent lineage).
- agent
Id String - Gets the agent's unique identifier within the organization (subscription).
- agent
Name String - Gets the agent's name (unique within the project/app).
- agent
Version String - Gets the agent's version (unique for each agent lineage).
- agent
Id string - Gets the agent's unique identifier within the organization (subscription).
- agent
Name string - Gets the agent's name (unique within the project/app).
- agent
Version string - Gets the agent's version (unique for each agent lineage).
- agent_
id str - Gets the agent's unique identifier within the organization (subscription).
- agent_
name str - Gets the agent's name (unique within the project/app).
- agent_
version str - Gets the agent's version (unique for each agent lineage).
- agent
Id String - Gets the agent's unique identifier within the organization (subscription).
- agent
Name String - Gets the agent's name (unique within the project/app).
- agent
Version String - Gets the agent's version (unique for each agent lineage).
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:cognitiveservices:AgentDeployment deployment-1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
