1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. getWebAgent
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.10.1 published on Friday, Nov 7, 2025 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.
Azure Native v3.10.1 published on Friday, Nov 7, 2025 by Pulumi

    Gets a web agent with the specified name within a resource group.

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

    Using getWebAgent

    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 getWebAgent(args: GetWebAgentArgs, opts?: InvokeOptions): Promise<GetWebAgentResult>
    function getWebAgentOutput(args: GetWebAgentOutputArgs, opts?: InvokeOptions): Output<GetWebAgentResult>
    def get_web_agent(resource_group_name: Optional[str] = None,
                      web_agent_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetWebAgentResult
    def get_web_agent_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                      web_agent_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetWebAgentResult]
    func LookupWebAgent(ctx *Context, args *LookupWebAgentArgs, opts ...InvokeOption) (*LookupWebAgentResult, error)
    func LookupWebAgentOutput(ctx *Context, args *LookupWebAgentOutputArgs, opts ...InvokeOption) LookupWebAgentResultOutput

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

    public static class GetWebAgent 
    {
        public static Task<GetWebAgentResult> InvokeAsync(GetWebAgentArgs args, InvokeOptions? opts = null)
        public static Output<GetWebAgentResult> Invoke(GetWebAgentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebAgentResult> getWebAgent(GetWebAgentArgs args, InvokeOptions options)
    public static Output<GetWebAgentResult> getWebAgent(GetWebAgentArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:cdn:getWebAgent
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WebAgentName string
    The name of the web agent.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WebAgentName string
    The name of the web agent.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    webAgentName String
    The name of the web agent.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    webAgentName string
    The name of the web agent.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    web_agent_name str
    The name of the web agent.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    webAgentName String
    The name of the web agent.

    getWebAgent 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}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProfileAgentLinks List<Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse>
    References to agent links in CDN profiles.
    ProvisioningState string
    Provisioning status of the web agent.
    SystemData Pulumi.AzureNative.Cdn.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"
    Description string
    Optional textual description of the agent.
    Paths List<Pulumi.AzureNative.Cdn.Outputs.AgentPathResponse>
    List of paths associated with the web agent.
    SystemPrompt string
    System prompt for the web agent.
    Tags Dictionary<string, string>
    Resource tags.
    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}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProfileAgentLinks []ResourceReferenceResponse
    References to agent links in CDN profiles.
    ProvisioningState string
    Provisioning status of the web agent.
    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"
    Description string
    Optional textual description of the agent.
    Paths []AgentPathResponse
    List of paths associated with the web agent.
    SystemPrompt string
    System prompt for the web agent.
    Tags map[string]string
    Resource tags.
    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}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    profileAgentLinks List<ResourceReferenceResponse>
    References to agent links in CDN profiles.
    provisioningState String
    Provisioning status of the web agent.
    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"
    description String
    Optional textual description of the agent.
    paths List<AgentPathResponse>
    List of paths associated with the web agent.
    systemPrompt String
    System prompt for the web agent.
    tags Map<String,String>
    Resource tags.
    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}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    profileAgentLinks ResourceReferenceResponse[]
    References to agent links in CDN profiles.
    provisioningState string
    Provisioning status of the web agent.
    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"
    description string
    Optional textual description of the agent.
    paths AgentPathResponse[]
    List of paths associated with the web agent.
    systemPrompt string
    System prompt for the web agent.
    tags {[key: string]: string}
    Resource tags.
    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}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    profile_agent_links Sequence[ResourceReferenceResponse]
    References to agent links in CDN profiles.
    provisioning_state str
    Provisioning status of the web agent.
    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"
    description str
    Optional textual description of the agent.
    paths Sequence[AgentPathResponse]
    List of paths associated with the web agent.
    system_prompt str
    System prompt for the web agent.
    tags Mapping[str, str]
    Resource tags.
    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}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    profileAgentLinks List<Property Map>
    References to agent links in CDN profiles.
    provisioningState String
    Provisioning status of the web agent.
    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"
    description String
    Optional textual description of the agent.
    paths List<Property Map>
    List of paths associated with the web agent.
    systemPrompt String
    System prompt for the web agent.
    tags Map<String>
    Resource tags.

    Supporting Types

    AgentPathResponse

    Path string
    The actual path value.
    Type string
    The type of the path.
    Path string
    The actual path value.
    Type string
    The type of the path.
    path String
    The actual path value.
    type String
    The type of the path.
    path string
    The actual path value.
    type string
    The type of the path.
    path str
    The actual path value.
    type str
    The type of the path.
    path String
    The actual path value.
    type String
    The type of the path.

    ResourceReferenceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    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.

    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.10.1 published on Friday, Nov 7, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate