1. Packages
  2. Azure Native
  3. API Docs
  4. cognitiveservices
  5. getAgentDeployment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.cognitiveservices.getAgentDeployment

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Agent Deployment resource

    Uses Azure REST API version 2025-10-01-preview.

    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: Optional[pulumi.Input[str]] = None,
                         app_name: Optional[pulumi.Input[str]] = None,
                         deployment_name: Optional[pulumi.Input[str]] = None,
                         project_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[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 dictionary

    The following arguments are supported:

    AccountName string
    The name of Cognitive Services account.
    AppName string
    The name of the application associated with the Cognitive Services Account
    DeploymentName string
    The name of the deployment associated with the Cognitive Services Account
    ProjectName string
    The name of Cognitive Services account's project.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    The name of Cognitive Services account.
    AppName string
    The name of the application associated with the Cognitive Services Account
    DeploymentName string
    The name of the deployment associated with the Cognitive Services Account
    ProjectName string
    The name of Cognitive Services account's project.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of Cognitive Services account.
    appName String
    The name of the application associated with the Cognitive Services Account
    deploymentName String
    The name of the deployment associated with the Cognitive Services Account
    projectName String
    The name of Cognitive Services account's project.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    The name of Cognitive Services account.
    appName string
    The name of the application associated with the Cognitive Services Account
    deploymentName string
    The name of the deployment associated with the Cognitive Services Account
    projectName string
    The name of Cognitive Services account's project.
    resourceGroupName string
    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_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of Cognitive Services account.
    appName String
    The name of the application associated with the Cognitive Services Account
    deploymentName String
    The name of the deployment associated with the Cognitive Services Account
    projectName String
    The name of Cognitive Services account's project.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getAgentDeployment Result

    The following output properties are available:

    AzureApiVersion string
    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.AzureNative.CognitiveServices.Outputs.HostedAgentDeploymentResponse | Pulumi.AzureNative.CognitiveServices.Outputs.ManagedAgentDeploymentResponse
    [Required] Additional attributes of the entity.
    SystemData Pulumi.AzureNative.CognitiveServices.Outputs.SystemDataResponse
    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"
    AzureApiVersion string
    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 HostedAgentDeploymentResponse | ManagedAgentDeploymentResponse
    [Required] Additional attributes of the entity.
    SystemData SystemDataResponse
    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"
    azureApiVersion String
    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 HostedAgentDeploymentResponse | ManagedAgentDeploymentResponse
    [Required] Additional attributes of the entity.
    systemData SystemDataResponse
    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"
    azureApiVersion string
    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 HostedAgentDeploymentResponse | ManagedAgentDeploymentResponse
    [Required] Additional attributes of the entity.
    systemData SystemDataResponse
    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_version str
    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 HostedAgentDeploymentResponse | ManagedAgentDeploymentResponse
    [Required] Additional attributes of the entity.
    system_data SystemDataResponse
    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"
    azureApiVersion String
    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.
    systemData 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

    Protocol string
    The protocol used by the agent/exposed by a deployment.
    Version string
    The version of the protocol.
    Protocol string
    The protocol used by the agent/exposed by a deployment.
    Version string
    The version of the protocol.
    protocol String
    The protocol used by the agent/exposed by a deployment.
    version String
    The version of the protocol.
    protocol string
    The protocol used by the agent/exposed by a deployment.
    version string
    The version of the protocol.
    protocol str
    The protocol used by the agent/exposed by a deployment.
    version str
    The version of the protocol.
    protocol String
    The protocol used by the agent/exposed by a deployment.
    version String
    The version of the protocol.

    HostedAgentDeploymentResponse

    ProvisioningState string
    Gets or sets the provisioning state of the agent deployment.
    Agents List<Pulumi.AzureNative.CognitiveServices.Inputs.VersionedAgentReferenceResponse>
    Returns a flat list of agent:version deployed in this deployment.
    DeploymentId string
    Gets or sets the unique identifier of the deployment.
    Description string
    The asset description text.
    DisplayName string
    Gets or sets the display name of the deployment.
    MaxReplicas int
    Gets or sets the maximum number of replicas for this hosted deployment.
    MinReplicas int
    Gets or sets the minimum number of replicas for this hosted deployment.
    Protocols List<Pulumi.AzureNative.CognitiveServices.Inputs.AgentProtocolVersionResponse>
    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).
    Tags Dictionary<string, string>
    Tag dictionary. Tags can be added, removed, and updated.
    ProvisioningState string
    Gets or sets the provisioning state of the agent deployment.
    Agents []VersionedAgentReferenceResponse
    Returns a flat list of agent:version deployed in this deployment.
    DeploymentId string
    Gets or sets the unique identifier of the deployment.
    Description string
    The asset description text.
    DisplayName string
    Gets or sets the display name of the deployment.
    MaxReplicas int
    Gets or sets the maximum number of replicas for this hosted deployment.
    MinReplicas int
    Gets or sets the minimum number of replicas for this hosted deployment.
    Protocols []AgentProtocolVersionResponse
    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).
    Tags map[string]string
    Tag dictionary. Tags can be added, removed, and updated.
    provisioningState String
    Gets or sets the provisioning state of the agent deployment.
    agents List<VersionedAgentReferenceResponse>
    Returns a flat list of agent:version deployed in this deployment.
    deploymentId String
    Gets or sets the unique identifier of the deployment.
    description String
    The asset description text.
    displayName String
    Gets or sets the display name of the deployment.
    maxReplicas Integer
    Gets or sets the maximum number of replicas for this hosted deployment.
    minReplicas Integer
    Gets or sets the minimum number of replicas for this hosted deployment.
    protocols List<AgentProtocolVersionResponse>
    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).
    tags Map<String,String>
    Tag dictionary. Tags can be added, removed, and updated.
    provisioningState string
    Gets or sets the provisioning state of the agent deployment.
    agents VersionedAgentReferenceResponse[]
    Returns a flat list of agent:version deployed in this deployment.
    deploymentId string
    Gets or sets the unique identifier of the deployment.
    description string
    The asset description text.
    displayName string
    Gets or sets the display name of the deployment.
    maxReplicas number
    Gets or sets the maximum number of replicas for this hosted deployment.
    minReplicas number
    Gets or sets the minimum number of replicas for this hosted deployment.
    protocols AgentProtocolVersionResponse[]
    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).
    tags {[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[VersionedAgentReferenceResponse]
    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[AgentProtocolVersionResponse]
    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).
    tags Mapping[str, str]
    Tag dictionary. Tags can be added, removed, and updated.
    provisioningState 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.
    deploymentId String
    Gets or sets the unique identifier of the deployment.
    description String
    The asset description text.
    displayName String
    Gets or sets the display name of the deployment.
    maxReplicas Number
    Gets or sets the maximum number of replicas for this hosted deployment.
    minReplicas 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).
    tags Map<String>
    Tag dictionary. Tags can be added, removed, and updated.

    ManagedAgentDeploymentResponse

    ProvisioningState string
    Gets or sets the provisioning state of the agent deployment.
    Agents List<Pulumi.AzureNative.CognitiveServices.Inputs.VersionedAgentReferenceResponse>
    Returns a flat list of agent:version deployed in this deployment.
    DeploymentId string
    Gets or sets the unique identifier of the deployment.
    Description string
    The asset description text.
    DisplayName string
    Gets or sets the display name of the deployment.
    Protocols List<Pulumi.AzureNative.CognitiveServices.Inputs.AgentProtocolVersionResponse>
    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).
    Tags Dictionary<string, string>
    Tag dictionary. Tags can be added, removed, and updated.
    ProvisioningState string
    Gets or sets the provisioning state of the agent deployment.
    Agents []VersionedAgentReferenceResponse
    Returns a flat list of agent:version deployed in this deployment.
    DeploymentId string
    Gets or sets the unique identifier of the deployment.
    Description string
    The asset description text.
    DisplayName string
    Gets or sets the display name of the deployment.
    Protocols []AgentProtocolVersionResponse
    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).
    Tags map[string]string
    Tag dictionary. Tags can be added, removed, and updated.
    provisioningState String
    Gets or sets the provisioning state of the agent deployment.
    agents List<VersionedAgentReferenceResponse>
    Returns a flat list of agent:version deployed in this deployment.
    deploymentId String
    Gets or sets the unique identifier of the deployment.
    description String
    The asset description text.
    displayName String
    Gets or sets the display name of the deployment.
    protocols List<AgentProtocolVersionResponse>
    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).
    tags Map<String,String>
    Tag dictionary. Tags can be added, removed, and updated.
    provisioningState string
    Gets or sets the provisioning state of the agent deployment.
    agents VersionedAgentReferenceResponse[]
    Returns a flat list of agent:version deployed in this deployment.
    deploymentId string
    Gets or sets the unique identifier of the deployment.
    description string
    The asset description text.
    displayName string
    Gets or sets the display name of the deployment.
    protocols AgentProtocolVersionResponse[]
    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).
    tags {[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[VersionedAgentReferenceResponse]
    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[AgentProtocolVersionResponse]
    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).
    tags Mapping[str, str]
    Tag dictionary. Tags can be added, removed, and updated.
    provisioningState 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.
    deploymentId String
    Gets or sets the unique identifier of the deployment.
    description String
    The asset description text.
    displayName 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).
    tags Map<String>
    Tag dictionary. Tags can be added, removed, and updated.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    VersionedAgentReferenceResponse

    AgentId string
    Gets the agent's unique identifier within the organization (subscription).
    AgentName string
    Gets the agent's name (unique within the project/app).
    AgentVersion string
    Gets the agent's version (unique for each agent lineage).
    AgentId string
    Gets the agent's unique identifier within the organization (subscription).
    AgentName string
    Gets the agent's name (unique within the project/app).
    AgentVersion string
    Gets the agent's version (unique for each agent lineage).
    agentId String
    Gets the agent's unique identifier within the organization (subscription).
    agentName String
    Gets the agent's name (unique within the project/app).
    agentVersion String
    Gets the agent's version (unique for each agent lineage).
    agentId string
    Gets the agent's unique identifier within the organization (subscription).
    agentName string
    Gets the agent's name (unique within the project/app).
    agentVersion 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).
    agentId String
    Gets the agent's unique identifier within the organization (subscription).
    agentName String
    Gets the agent's name (unique within the project/app).
    agentVersion String
    Gets the agent's version (unique for each agent lineage).

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Meet Neo: Your AI Platform Teammate