1. Packages
  2. F5bigip Provider
  3. API Docs
  4. ltm
  5. getPool
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

f5bigip.ltm.getPool

Explore with Pulumi AI

f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

Use this data source (f5bigip.ltm.Pool) to get the ltm monitor details available on BIG-IP

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";

const pool_Example = f5bigip.ltm.getPool({
    name: "example-pool",
    partition: "Common",
});
Copy
import pulumi
import pulumi_f5bigip as f5bigip

pool__example = f5bigip.ltm.get_pool(name="example-pool",
    partition="Common")
Copy
package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ltm.LookupPool(ctx, &ltm.LookupPoolArgs{
			Name:      "example-pool",
			Partition: "Common",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var pool_Example = F5BigIP.Ltm.GetPool.Invoke(new()
    {
        Name = "example-pool",
        Partition = "Common",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.ltm.LtmFunctions;
import com.pulumi.f5bigip.ltm.inputs.GetPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var pool-Example = LtmFunctions.getPool(GetPoolArgs.builder()
            .name("example-pool")
            .partition("Common")
            .build());

    }
}
Copy
variables:
  pool-Example:
    fn::invoke:
      function: f5bigip:ltm:getPool
      arguments:
        name: example-pool
        partition: Common
Copy

Using getPool

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 getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
Copy
def get_pool(name: Optional[str] = None,
             partition: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(name: Optional[pulumi.Input[str]] = None,
             partition: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
Copy
func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput
Copy

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

public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
public static Output<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: f5bigip:ltm/getPool:getPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Name of the ltm monitor
Partition This property is required. string
partition of the ltm monitor
Name This property is required. string
Name of the ltm monitor
Partition This property is required. string
partition of the ltm monitor
name This property is required. String
Name of the ltm monitor
partition This property is required. String
partition of the ltm monitor
name This property is required. string
Name of the ltm monitor
partition This property is required. string
partition of the ltm monitor
name This property is required. str
Name of the ltm monitor
partition This property is required. str
partition of the ltm monitor
name This property is required. String
Name of the ltm monitor
partition This property is required. String
partition of the ltm monitor

getPool Result

The following output properties are available:

FullPath string
Full path to the pool.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Partition string
FullPath string
Full path to the pool.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Partition string
fullPath String
Full path to the pool.
id String
The provider-assigned unique ID for this managed resource.
name String
partition String
fullPath string
Full path to the pool.
id string
The provider-assigned unique ID for this managed resource.
name string
partition string
full_path str
Full path to the pool.
id str
The provider-assigned unique ID for this managed resource.
name str
partition str
fullPath String
Full path to the pool.
id String
The provider-assigned unique ID for this managed resource.
name String
partition String

Package Details

Repository
f5 BIG-IP pulumi/pulumi-f5bigip
License
Apache-2.0
Notes
This Pulumi package is based on the bigip Terraform Provider.
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi