1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. app
  6. getAgentsConnector
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.25.0
published on Wednesday, Aug 5, 2026 by Pulumi
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.
Viewing docs for Azure Native v3.25.0
published on Wednesday, Aug 5, 2026 by Pulumi

    Get the properties of an Agent Connector

    Uses Azure REST API version 2026-01-01.

    Using getAgentsConnector

    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 getAgentsConnector(args: GetAgentsConnectorArgs, opts?: InvokeOptions): Promise<GetAgentsConnectorResult>
    function getAgentsConnectorOutput(args: GetAgentsConnectorOutputArgs, opts?: InvokeOptions): Output<GetAgentsConnectorResult>
    def get_agents_connector(agent_name: Optional[str] = None,
                             connector_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAgentsConnectorResult
    def get_agents_connector_output(agent_name: pulumi.Input[Optional[str]] = None,
                             connector_name: pulumi.Input[Optional[str]] = None,
                             resource_group_name: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAgentsConnectorResult]
    func LookupAgentsConnector(ctx *Context, args *LookupAgentsConnectorArgs, opts ...InvokeOption) (*LookupAgentsConnectorResult, error)
    func LookupAgentsConnectorOutput(ctx *Context, args *LookupAgentsConnectorOutputArgs, opts ...InvokeOption) LookupAgentsConnectorResultOutput

    > Note: This function is named LookupAgentsConnector in the Go SDK.

    public static class GetAgentsConnector 
    {
        public static Task<GetAgentsConnectorResult> InvokeAsync(GetAgentsConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentsConnectorResult> Invoke(GetAgentsConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAgentsConnectorResult> getAgentsConnector(GetAgentsConnectorArgs args, InvokeOptions options)
    public static Output<GetAgentsConnectorResult> getAgentsConnector(GetAgentsConnectorArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:app:getAgentsConnector
      arguments:
        # arguments dictionary
    data "azure-native_app_get_agents_connector" "name" {
        # arguments
    }

    The following arguments are supported:

    AgentName string
    The name of the Agent
    ConnectorName string
    The name of the AgentConnector
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AgentName string
    The name of the Agent
    ConnectorName string
    The name of the AgentConnector
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    agent_name string
    The name of the Agent
    connector_name string
    The name of the AgentConnector
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    agentName String
    The name of the Agent
    connectorName String
    The name of the AgentConnector
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    agentName string
    The name of the Agent
    connectorName string
    The name of the AgentConnector
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    agent_name str
    The name of the Agent
    connector_name str
    The name of the AgentConnector
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    agentName String
    The name of the Agent
    connectorName String
    The name of the AgentConnector
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getAgentsConnector 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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.App.Outputs.AgentConnectorPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.App.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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties AgentConnectorPropertiesResponse
    The resource-specific properties for this resource.
    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 string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties object
    The resource-specific properties for this resource.
    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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties AgentConnectorPropertiesResponse
    The resource-specific properties for this resource.
    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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties AgentConnectorPropertiesResponse
    The resource-specific properties for this resource.
    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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties AgentConnectorPropertiesResponse
    The resource-specific properties for this resource.
    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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    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

    AgentConnectorPropertiesResponse

    DeploymentError string
    Deployment error message if provisioning failed
    ProvisioningState string
    Provisioning state of the connector
    Source string
    Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited
    DataConnectorType string
    The type of the data connector
    DataSource string
    Data source connection string or endpoint
    Endpoint string
    Endpoint of the connector
    ExtendedProperties object
    Additional properties for the data connector which can be used to store custom key-value pairs
    Identity string
    Identity used to access the data source
    DeploymentError string
    Deployment error message if provisioning failed
    ProvisioningState string
    Provisioning state of the connector
    Source string
    Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited
    DataConnectorType string
    The type of the data connector
    DataSource string
    Data source connection string or endpoint
    Endpoint string
    Endpoint of the connector
    ExtendedProperties interface{}
    Additional properties for the data connector which can be used to store custom key-value pairs
    Identity string
    Identity used to access the data source
    deployment_error string
    Deployment error message if provisioning failed
    provisioning_state string
    Provisioning state of the connector
    source string
    Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited
    data_connector_type string
    The type of the data connector
    data_source string
    Data source connection string or endpoint
    endpoint string
    Endpoint of the connector
    extended_properties any
    Additional properties for the data connector which can be used to store custom key-value pairs
    identity string
    Identity used to access the data source
    deploymentError String
    Deployment error message if provisioning failed
    provisioningState String
    Provisioning state of the connector
    source String
    Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited
    dataConnectorType String
    The type of the data connector
    dataSource String
    Data source connection string or endpoint
    endpoint String
    Endpoint of the connector
    extendedProperties Object
    Additional properties for the data connector which can be used to store custom key-value pairs
    identity String
    Identity used to access the data source
    deploymentError string
    Deployment error message if provisioning failed
    provisioningState string
    Provisioning state of the connector
    source string
    Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited
    dataConnectorType string
    The type of the data connector
    dataSource string
    Data source connection string or endpoint
    endpoint string
    Endpoint of the connector
    extendedProperties any
    Additional properties for the data connector which can be used to store custom key-value pairs
    identity string
    Identity used to access the data source
    deployment_error str
    Deployment error message if provisioning failed
    provisioning_state str
    Provisioning state of the connector
    source str
    Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited
    data_connector_type str
    The type of the data connector
    data_source str
    Data source connection string or endpoint
    endpoint str
    Endpoint of the connector
    extended_properties Any
    Additional properties for the data connector which can be used to store custom key-value pairs
    identity str
    Identity used to access the data source
    deploymentError String
    Deployment error message if provisioning failed
    provisioningState String
    Provisioning state of the connector
    source String
    Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited
    dataConnectorType String
    The type of the data connector
    dataSource String
    Data source connection string or endpoint
    endpoint String
    Endpoint of the connector
    extendedProperties Any
    Additional properties for the data connector which can be used to store custom key-value pairs
    identity String
    Identity used to access the data source

    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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.

    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.
    Viewing docs for Azure Native v3.25.0
    published on Wednesday, Aug 5, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial