published on Wednesday, Aug 5, 2026 by Pulumi
published on Wednesday, Aug 5, 2026 by Pulumi
Gets an Agent Deployment by name.
Uses Azure REST API version 2025-10-01-preview.
Other available API versions: 2025-12-01, 2026-01-15-preview, 2026-03-01, 2026-03-15-preview, 2026-05-01, 2026-05-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cognitiveservices [ApiVersion]. See the version guide for details.
Using getAgentDeployment
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAgentDeployment(args: GetAgentDeploymentArgs, opts?: InvokeOptions): Promise<GetAgentDeploymentResult>
function getAgentDeploymentOutput(args: GetAgentDeploymentOutputArgs, opts?: InvokeOptions): Output<GetAgentDeploymentResult>def get_agent_deployment(account_name: Optional[str] = None,
app_name: Optional[str] = None,
deployment_name: Optional[str] = None,
project_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAgentDeploymentResult
def get_agent_deployment_output(account_name: pulumi.Input[Optional[str]] = None,
app_name: pulumi.Input[Optional[str]] = None,
deployment_name: pulumi.Input[Optional[str]] = None,
project_name: pulumi.Input[Optional[str]] = None,
resource_group_name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAgentDeploymentResult]func LookupAgentDeployment(ctx *Context, args *LookupAgentDeploymentArgs, opts ...InvokeOption) (*LookupAgentDeploymentResult, error)
func LookupAgentDeploymentOutput(ctx *Context, args *LookupAgentDeploymentOutputArgs, opts ...InvokeOption) LookupAgentDeploymentResultOutput> Note: This function is named LookupAgentDeployment in the Go SDK.
public static class GetAgentDeployment
{
public static Task<GetAgentDeploymentResult> InvokeAsync(GetAgentDeploymentArgs args, InvokeOptions? opts = null)
public static Output<GetAgentDeploymentResult> Invoke(GetAgentDeploymentInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAgentDeploymentResult> getAgentDeployment(GetAgentDeploymentArgs args, InvokeOptions options)
public static Output<GetAgentDeploymentResult> getAgentDeployment(GetAgentDeploymentArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cognitiveservices:getAgentDeployment
arguments:
# arguments dictionarydata "azure-native_cognitiveservices_get_agent_deployment" "name" {
# arguments
}The following arguments are supported:
- Account
Name string - The name of Cognitive Services account.
- App
Name string - The name of the application associated with the Cognitive Services Account
- Deployment
Name string - The name of the deployment associated with the Cognitive Services Account
- Project
Name string - The name of Cognitive Services account's project.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Account
Name string - The name of Cognitive Services account.
- App
Name string - The name of the application associated with the Cognitive Services Account
- Deployment
Name string - The name of the deployment associated with the Cognitive Services Account
- Project
Name string - The name of Cognitive Services account's project.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- account_
name string - The name of Cognitive Services account.
- app_
name string - The name of the application associated with the Cognitive Services Account
- deployment_
name string - The name of the deployment associated with the Cognitive Services Account
- project_
name string - The name of Cognitive Services account's project.
- resource_
group_ stringname - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- app
Name String - The name of the application associated with the Cognitive Services Account
- deployment
Name String - The name of the deployment associated with the Cognitive Services Account
- project
Name String - The name of Cognitive Services account's project.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- account
Name string - The name of Cognitive Services account.
- app
Name string - The name of the application associated with the Cognitive Services Account
- deployment
Name string - The name of the deployment associated with the Cognitive Services Account
- project
Name string - The name of Cognitive Services account's project.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- account_
name str - The name of Cognitive Services account.
- app_
name str - The name of the application associated with the Cognitive Services Account
- deployment_
name str - The name of the deployment associated with the Cognitive Services Account
- project_
name str - The name of Cognitive Services account's project.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- app
Name String - The name of the application associated with the Cognitive Services Account
- deployment
Name String - The name of the deployment associated with the Cognitive Services Account
- project
Name String - The name of Cognitive Services account's project.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getAgentDeployment Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- 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
Pulumi.
Azure | Pulumi.Native. Cognitive Services. Outputs. Hosted Agent Deployment Response Azure Native. Cognitive Services. Outputs. Managed Agent Deployment Response - [Required] Additional attributes of the entity.
- 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
- The name of the resource
- Properties
Hosted
Agent | ManagedDeployment Response Agent Deployment Response - [Required] Additional attributes of the entity.
- 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name string
- The name of the resource
- properties object | object
- [Required] Additional attributes of the entity.
- system_
data object - 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
- The name of the resource
- properties
Hosted
Agent | ManagedDeployment Response Agent Deployment Response - [Required] Additional attributes of the entity.
- 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name string
- The name of the resource
- properties
Hosted
Agent | ManagedDeployment Response Agent Deployment Response - [Required] Additional attributes of the entity.
- 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name str
- The name of the resource
- properties
Hosted
Agent | ManagedDeployment Response Agent Deployment Response - [Required] Additional attributes of the entity.
- 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
- The name of the resource
- properties Property Map | Property Map
- [Required] Additional attributes of the entity.
- 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
AgentProtocolVersionResponse
HostedAgentDeploymentResponse
- 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(object)
- 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(object)
- 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.
- 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.
ManagedAgentDeploymentResponse
- 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(object)
- 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(object)
- 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.
- 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
- 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 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.
VersionedAgentReferenceResponse
- 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 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).
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Wednesday, Aug 5, 2026 by Pulumi