published on Wednesday, Aug 5, 2026 by Pulumi
published on Wednesday, Aug 5, 2026 by Pulumi
Gets an Agent Application 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 getAgentApplication
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 getAgentApplication(args: GetAgentApplicationArgs, opts?: InvokeOptions): Promise<GetAgentApplicationResult>
function getAgentApplicationOutput(args: GetAgentApplicationOutputArgs, opts?: InvokeOptions): Output<GetAgentApplicationResult>def get_agent_application(account_name: Optional[str] = None,
name: Optional[str] = None,
project_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAgentApplicationResult
def get_agent_application_output(account_name: pulumi.Input[Optional[str]] = None,
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[GetAgentApplicationResult]func LookupAgentApplication(ctx *Context, args *LookupAgentApplicationArgs, opts ...InvokeOption) (*LookupAgentApplicationResult, error)
func LookupAgentApplicationOutput(ctx *Context, args *LookupAgentApplicationOutputArgs, opts ...InvokeOption) LookupAgentApplicationResultOutput> Note: This function is named LookupAgentApplication in the Go SDK.
public static class GetAgentApplication
{
public static Task<GetAgentApplicationResult> InvokeAsync(GetAgentApplicationArgs args, InvokeOptions? opts = null)
public static Output<GetAgentApplicationResult> Invoke(GetAgentApplicationInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAgentApplicationResult> getAgentApplication(GetAgentApplicationArgs args, InvokeOptions options)
public static Output<GetAgentApplicationResult> getAgentApplication(GetAgentApplicationArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cognitiveservices:getAgentApplication
arguments:
# arguments dictionarydata "azure-native_cognitiveservices_get_agent_application" "name" {
# arguments
}The following arguments are supported:
- Account
Name string - The name of Cognitive Services account.
- Name string
- Name for the Agent Application.
- 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.
- Name string
- Name for the Agent Application.
- 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.
- name string
- Name for the Agent Application.
- 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.
- name String
- Name for the Agent Application.
- 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.
- name string
- Name for the Agent Application.
- 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.
- name str
- Name for the Agent Application.
- 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.
- name String
- Name for the Agent Application.
- 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.
getAgentApplication 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 Native. Cognitive Services. Outputs. Agentic Application Properties 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
Agentic
Application Properties 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
- [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
Agentic
Application Properties 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
Agentic
Application Properties 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
Agentic
Application Properties 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
- [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
AgentReferencePropertiesResponse
- 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_
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).
AgenticApplicationPropertiesResponse
- Is
Enabled bool - Enabledstate of the application.
- Provisioning
State string - Provisioning state of the application.
- Agent
Identity Pulumi.Blueprint Azure Native. Cognitive Services. Inputs. Assigned Identity Response - The EntraId Agentic Blueprint of the application.
- Agents
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Agent Reference Properties Response> - 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.
-
Pulumi.
Azure | Pulumi.Native. Cognitive Services. Inputs. Channels Built In Authorization Policy Response Azure | Pulumi.Native. Cognitive Services. Inputs. Organization Shared Built In Authorization Policy Response Azure Native. Cognitive Services. Inputs. Role Based Built In Authorization Policy Response - Gets or sets the authorization policy associated with this agentic application instance.
- Base
Url string - The application's dedicated invocation endpoint.
- Default
Instance Pulumi.Identity Azure Native. Cognitive Services. Inputs. Assigned Identity Response - The (default) agent instance identity of the application.
- Description string
- The asset description text.
- Display
Name string - The display name of the application.
- Dictionary<string, string>
- Tag dictionary. Tags can be added, removed, and updated.
- Traffic
Routing Pulumi.Policy Azure Native. Cognitive Services. Inputs. Application Traffic Routing Policy Response - Gets or sets the traffic routing policy for the application's deployments.
- Is
Enabled bool - Enabledstate of the application.
- Provisioning
State string - Provisioning state of the application.
- Agent
Identity AssignedBlueprint Identity Response - The EntraId Agentic Blueprint of the application.
- Agents
[]Agent
Reference Properties Response - 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.
-
Channels
Built | OrganizationIn Authorization Policy Response Shared | RoleBuilt In Authorization Policy Response Based Built In Authorization Policy Response - Gets or sets the authorization policy associated with this agentic application instance.
- Base
Url string - The application's dedicated invocation endpoint.
- Default
Instance AssignedIdentity Identity Response - The (default) agent instance identity of the application.
- Description string
- The asset description text.
- Display
Name string - The display name of the application.
- map[string]string
- Tag dictionary. Tags can be added, removed, and updated.
- Traffic
Routing ApplicationPolicy Traffic Routing Policy Response - Gets or sets the traffic routing policy for the application's deployments.
- is_
enabled bool - Enabledstate of the application.
- provisioning_
state string - Provisioning state of the application.
- agent_
identity_ objectblueprint - The EntraId Agentic Blueprint of the application.
- agents list(object)
- 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.
- object | object | object
- Gets or sets the authorization policy associated with this agentic application instance.
- base_
url string - The application's dedicated invocation endpoint.
- default_
instance_ objectidentity - The (default) agent instance identity of the application.
- description string
- The asset description text.
- display_
name string - The display name of the application.
- map(string)
- Tag dictionary. Tags can be added, removed, and updated.
- traffic_
routing_ objectpolicy - Gets or sets the traffic routing policy for the application's deployments.
- is
Enabled Boolean - Enabledstate of the application.
- provisioning
State String - Provisioning state of the application.
- agent
Identity AssignedBlueprint Identity Response - The EntraId Agentic Blueprint of the application.
- agents
List<Agent
Reference Properties Response> - 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.
-
Channels
Built | OrganizationIn Authorization Policy Response Shared | RoleBuilt In Authorization Policy Response Based Built In Authorization Policy Response - Gets or sets the authorization policy associated with this agentic application instance.
- base
Url String - The application's dedicated invocation endpoint.
- default
Instance AssignedIdentity Identity Response - The (default) agent instance identity of the application.
- description String
- The asset description text.
- display
Name String - The display name of the application.
- Map<String,String>
- Tag dictionary. Tags can be added, removed, and updated.
- traffic
Routing ApplicationPolicy Traffic Routing Policy Response - Gets or sets the traffic routing policy for the application's deployments.
- is
Enabled boolean - Enabledstate of the application.
- provisioning
State string - Provisioning state of the application.
- agent
Identity AssignedBlueprint Identity Response - The EntraId Agentic Blueprint of the application.
- agents
Agent
Reference Properties Response[] - 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.
-
Channels
Built | OrganizationIn Authorization Policy Response Shared | RoleBuilt In Authorization Policy Response Based Built In Authorization Policy Response - Gets or sets the authorization policy associated with this agentic application instance.
- base
Url string - The application's dedicated invocation endpoint.
- default
Instance AssignedIdentity Identity Response - The (default) agent instance identity of the application.
- description string
- The asset description text.
- display
Name string - The display name of the application.
- {[key: string]: string}
- Tag dictionary. Tags can be added, removed, and updated.
- traffic
Routing ApplicationPolicy Traffic Routing Policy Response - Gets or sets the traffic routing policy for the application's deployments.
- is_
enabled bool - Enabledstate of the application.
- provisioning_
state str - Provisioning state of the application.
- agent_
identity_ Assignedblueprint Identity Response - The EntraId Agentic Blueprint of the application.
- agents
Sequence[Agent
Reference Properties Response] - 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.
-
Channels
Built | OrganizationIn Authorization Policy Response Shared | RoleBuilt In Authorization Policy Response Based Built In Authorization Policy Response - Gets or sets the authorization policy associated with this agentic application instance.
- base_
url str - The application's dedicated invocation endpoint.
- default_
instance_ Assignedidentity Identity Response - The (default) agent instance identity of the application.
- description str
- The asset description text.
- display_
name str - The display name of the application.
- Mapping[str, str]
- Tag dictionary. Tags can be added, removed, and updated.
- traffic_
routing_ Applicationpolicy Traffic Routing Policy Response - Gets or sets the traffic routing policy for the application's deployments.
- is
Enabled Boolean - Enabledstate of the application.
- provisioning
State String - Provisioning state of the application.
- agent
Identity Property MapBlueprint - The EntraId Agentic Blueprint of the application.
- agents List<Property Map>
- 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.
- Property Map | Property Map | Property Map
- Gets or sets the authorization policy associated with this agentic application instance.
- base
Url String - The application's dedicated invocation endpoint.
- default
Instance Property MapIdentity - The (default) agent instance identity of the application.
- description String
- The asset description text.
- display
Name String - The display name of the application.
- Map<String>
- Tag dictionary. Tags can be added, removed, and updated.
- traffic
Routing Property MapPolicy - Gets or sets the traffic routing policy for the application's deployments.
ApplicationTrafficRoutingPolicyResponse
- Protocol string
- Methodology used to route traffic to the application's deployments.
- Rules
List<Pulumi.
Azure Native. Cognitive Services. Inputs. Traffic Routing Rule Response> - Gets or sets the collection of traffic routing rules.
- Protocol string
- Methodology used to route traffic to the application's deployments.
- Rules
[]Traffic
Routing Rule Response - Gets or sets the collection of traffic routing rules.
- protocol string
- Methodology used to route traffic to the application's deployments.
- rules list(object)
- Gets or sets the collection of traffic routing rules.
- protocol String
- Methodology used to route traffic to the application's deployments.
- rules
List<Traffic
Routing Rule Response> - Gets or sets the collection of traffic routing rules.
- protocol string
- Methodology used to route traffic to the application's deployments.
- rules
Traffic
Routing Rule Response[] - Gets or sets the collection of traffic routing rules.
- protocol str
- Methodology used to route traffic to the application's deployments.
- rules
Sequence[Traffic
Routing Rule Response] - Gets or sets the collection of traffic routing rules.
- protocol String
- Methodology used to route traffic to the application's deployments.
- rules List<Property Map>
- Gets or sets the collection of traffic routing rules.
AssignedIdentityResponse
- Client
Id string - The client ID of the identity.
- Kind string
- Specifies the kind of Entra identity described by this object.
- Principal
Id string - The principal ID of the identity.
- Provisioning
State string - Represents the provisioning state of an identity resource.
- Tenant
Id string - The tenant ID of the identity.
- Type string
- Enumeration of identity types, from the perspective of management.
- Subject string
- The subject of this identity assignment.
- Client
Id string - The client ID of the identity.
- Kind string
- Specifies the kind of Entra identity described by this object.
- Principal
Id string - The principal ID of the identity.
- Provisioning
State string - Represents the provisioning state of an identity resource.
- Tenant
Id string - The tenant ID of the identity.
- Type string
- Enumeration of identity types, from the perspective of management.
- Subject string
- The subject of this identity assignment.
- client_
id string - The client ID of the identity.
- kind string
- Specifies the kind of Entra identity described by this object.
- principal_
id string - The principal ID of the identity.
- provisioning_
state string - Represents the provisioning state of an identity resource.
- tenant_
id string - The tenant ID of the identity.
- type string
- Enumeration of identity types, from the perspective of management.
- subject string
- The subject of this identity assignment.
- client
Id String - The client ID of the identity.
- kind String
- Specifies the kind of Entra identity described by this object.
- principal
Id String - The principal ID of the identity.
- provisioning
State String - Represents the provisioning state of an identity resource.
- tenant
Id String - The tenant ID of the identity.
- type String
- Enumeration of identity types, from the perspective of management.
- subject String
- The subject of this identity assignment.
- client
Id string - The client ID of the identity.
- kind string
- Specifies the kind of Entra identity described by this object.
- principal
Id string - The principal ID of the identity.
- provisioning
State string - Represents the provisioning state of an identity resource.
- tenant
Id string - The tenant ID of the identity.
- type string
- Enumeration of identity types, from the perspective of management.
- subject string
- The subject of this identity assignment.
- client_
id str - The client ID of the identity.
- kind str
- Specifies the kind of Entra identity described by this object.
- principal_
id str - The principal ID of the identity.
- provisioning_
state str - Represents the provisioning state of an identity resource.
- tenant_
id str - The tenant ID of the identity.
- type str
- Enumeration of identity types, from the perspective of management.
- subject str
- The subject of this identity assignment.
- client
Id String - The client ID of the identity.
- kind String
- Specifies the kind of Entra identity described by this object.
- principal
Id String - The principal ID of the identity.
- provisioning
State String - Represents the provisioning state of an identity resource.
- tenant
Id String - The tenant ID of the identity.
- type String
- Enumeration of identity types, from the perspective of management.
- subject String
- The subject of this identity assignment.
ChannelsBuiltInAuthorizationPolicyResponse
OrganizationSharedBuiltInAuthorizationPolicyResponse
RoleBasedBuiltInAuthorizationPolicyResponse
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.
TrafficRoutingRuleResponse
- Deployment
Id string - The unique identifier of the deployment to which traffic is routed by this rule.
- Description string
- A user-provided description for this traffic routing rule.
- Rule
Id string - The identifier of this traffic routing rule.
- Traffic
Percentage int - Gets or sets the percentage of traffic allocated to this instance.
- Deployment
Id string - The unique identifier of the deployment to which traffic is routed by this rule.
- Description string
- A user-provided description for this traffic routing rule.
- Rule
Id string - The identifier of this traffic routing rule.
- Traffic
Percentage int - Gets or sets the percentage of traffic allocated to this instance.
- deployment_
id string - The unique identifier of the deployment to which traffic is routed by this rule.
- description string
- A user-provided description for this traffic routing rule.
- rule_
id string - The identifier of this traffic routing rule.
- traffic_
percentage number - Gets or sets the percentage of traffic allocated to this instance.
- deployment
Id String - The unique identifier of the deployment to which traffic is routed by this rule.
- description String
- A user-provided description for this traffic routing rule.
- rule
Id String - The identifier of this traffic routing rule.
- traffic
Percentage Integer - Gets or sets the percentage of traffic allocated to this instance.
- deployment
Id string - The unique identifier of the deployment to which traffic is routed by this rule.
- description string
- A user-provided description for this traffic routing rule.
- rule
Id string - The identifier of this traffic routing rule.
- traffic
Percentage number - Gets or sets the percentage of traffic allocated to this instance.
- deployment_
id str - The unique identifier of the deployment to which traffic is routed by this rule.
- description str
- A user-provided description for this traffic routing rule.
- rule_
id str - The identifier of this traffic routing rule.
- traffic_
percentage int - Gets or sets the percentage of traffic allocated to this instance.
- deployment
Id String - The unique identifier of the deployment to which traffic is routed by this rule.
- description String
- A user-provided description for this traffic routing rule.
- rule
Id String - The identifier of this traffic routing rule.
- traffic
Percentage Number - Gets or sets the percentage of traffic allocated to this instance.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Wednesday, Aug 5, 2026 by Pulumi