1. Packages
  2. Ibm Provider
  3. API Docs
  4. getDnsGlbPools
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getDnsGlbPools

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve the details of an existing IBM Cloud infrastructure private DNS Global Load Balancers (glb) pools as a read-only data source. For more information, see viewing Global Load Balancer events.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const dsPdnsGlbPools = ibm.getDnsGlbPools({
        instanceId: "resource_instance_guid",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    ds_pdns_glb_pools = ibm.get_dns_glb_pools(instance_id="resource_instance_guid")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetDnsGlbPools(ctx, &ibm.GetDnsGlbPoolsArgs{
    			InstanceId: "resource_instance_guid",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var dsPdnsGlbPools = Ibm.GetDnsGlbPools.Invoke(new()
        {
            InstanceId = "resource_instance_guid",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetDnsGlbPoolsArgs;
    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 dsPdnsGlbPools = IbmFunctions.getDnsGlbPools(GetDnsGlbPoolsArgs.builder()
                .instanceId("resource_instance_guid")
                .build());
    
        }
    }
    
    variables:
      dsPdnsGlbPools:
        fn::invoke:
          function: ibm:getDnsGlbPools
          arguments:
            instanceId: resource_instance_guid
    

    Using getDnsGlbPools

    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 getDnsGlbPools(args: GetDnsGlbPoolsArgs, opts?: InvokeOptions): Promise<GetDnsGlbPoolsResult>
    function getDnsGlbPoolsOutput(args: GetDnsGlbPoolsOutputArgs, opts?: InvokeOptions): Output<GetDnsGlbPoolsResult>
    def get_dns_glb_pools(id: Optional[str] = None,
                          instance_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDnsGlbPoolsResult
    def get_dns_glb_pools_output(id: Optional[pulumi.Input[str]] = None,
                          instance_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDnsGlbPoolsResult]
    func GetDnsGlbPools(ctx *Context, args *GetDnsGlbPoolsArgs, opts ...InvokeOption) (*GetDnsGlbPoolsResult, error)
    func GetDnsGlbPoolsOutput(ctx *Context, args *GetDnsGlbPoolsOutputArgs, opts ...InvokeOption) GetDnsGlbPoolsResultOutput

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

    public static class GetDnsGlbPools 
    {
        public static Task<GetDnsGlbPoolsResult> InvokeAsync(GetDnsGlbPoolsArgs args, InvokeOptions? opts = null)
        public static Output<GetDnsGlbPoolsResult> Invoke(GetDnsGlbPoolsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDnsGlbPoolsResult> getDnsGlbPools(GetDnsGlbPoolsArgs args, InvokeOptions options)
    public static Output<GetDnsGlbPoolsResult> getDnsGlbPools(GetDnsGlbPoolsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getDnsGlbPools:getDnsGlbPools
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The resource GUID of the private DNS service on which zones are created.
    Id string
    InstanceId string
    The resource GUID of the private DNS service on which zones are created.
    Id string
    instanceId String
    The resource GUID of the private DNS service on which zones are created.
    id String
    instanceId string
    The resource GUID of the private DNS service on which zones are created.
    id string
    instance_id str
    The resource GUID of the private DNS service on which zones are created.
    id str
    instanceId String
    The resource GUID of the private DNS service on which zones are created.
    id String

    getDnsGlbPools Result

    The following output properties are available:

    DnsGlbPools List<GetDnsGlbPoolsDnsGlbPool>
    (List) List of all private DNS Load balancer pools in the IBM Cloud infrastructure.
    Id string
    InstanceId string
    DnsGlbPools []GetDnsGlbPoolsDnsGlbPool
    (List) List of all private DNS Load balancer pools in the IBM Cloud infrastructure.
    Id string
    InstanceId string
    dnsGlbPools List<GetDnsGlbPoolsDnsGlbPool>
    (List) List of all private DNS Load balancer pools in the IBM Cloud infrastructure.
    id String
    instanceId String
    dnsGlbPools GetDnsGlbPoolsDnsGlbPool[]
    (List) List of all private DNS Load balancer pools in the IBM Cloud infrastructure.
    id string
    instanceId string
    dns_glb_pools Sequence[GetDnsGlbPoolsDnsGlbPool]
    (List) List of all private DNS Load balancer pools in the IBM Cloud infrastructure.
    id str
    instance_id str
    dnsGlbPools List<Property Map>
    (List) List of all private DNS Load balancer pools in the IBM Cloud infrastructure.
    id String
    instanceId String

    Supporting Types

    GetDnsGlbPoolsDnsGlbPool

    CreatedOn string
    (Timestamp) The time (created On) of the DNS glb pool.
    Description string
    (String) The description of the origin server.
    Enabled bool
    (String) Whether the origin server is enabled.
    Health string
    (String) Whether the health is true or false.
    HealthcheckRegion string
    (String) Health check region of VSIs. Allowable values are us-south,us-east, eu-gb, eu-du, au-syd, jp-tok.
    HealthcheckSubnets List<string>
    (String) Health check subnet CRN of VSIs.
    HealthyOriginsThreshold double
    (String) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls less than this number, the pool will be marked unhealthy and will failover to the next available pool.
    ModifiedOn string
    (Timestamp) The time (modified On) of the DNS glb pool.
    Monitor string
    (String) The ID of the Load Balancer monitor to be associated to this pool.
    Name string
    (String) The name of the DNS Load balancer pool.
    NotificationChannel string
    (String) The webhook URL as a notification channel.
    Origins List<GetDnsGlbPoolsDnsGlbPoolOrigin>
    (List) The list of origins within the pool. Traffic directed to the pool is balanced across all currently healthy origins, provided the pool itself is healthy.
    PoolId string
    (String) The pool ID.
    CreatedOn string
    (Timestamp) The time (created On) of the DNS glb pool.
    Description string
    (String) The description of the origin server.
    Enabled bool
    (String) Whether the origin server is enabled.
    Health string
    (String) Whether the health is true or false.
    HealthcheckRegion string
    (String) Health check region of VSIs. Allowable values are us-south,us-east, eu-gb, eu-du, au-syd, jp-tok.
    HealthcheckSubnets []string
    (String) Health check subnet CRN of VSIs.
    HealthyOriginsThreshold float64
    (String) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls less than this number, the pool will be marked unhealthy and will failover to the next available pool.
    ModifiedOn string
    (Timestamp) The time (modified On) of the DNS glb pool.
    Monitor string
    (String) The ID of the Load Balancer monitor to be associated to this pool.
    Name string
    (String) The name of the DNS Load balancer pool.
    NotificationChannel string
    (String) The webhook URL as a notification channel.
    Origins []GetDnsGlbPoolsDnsGlbPoolOrigin
    (List) The list of origins within the pool. Traffic directed to the pool is balanced across all currently healthy origins, provided the pool itself is healthy.
    PoolId string
    (String) The pool ID.
    createdOn String
    (Timestamp) The time (created On) of the DNS glb pool.
    description String
    (String) The description of the origin server.
    enabled Boolean
    (String) Whether the origin server is enabled.
    health String
    (String) Whether the health is true or false.
    healthcheckRegion String
    (String) Health check region of VSIs. Allowable values are us-south,us-east, eu-gb, eu-du, au-syd, jp-tok.
    healthcheckSubnets List<String>
    (String) Health check subnet CRN of VSIs.
    healthyOriginsThreshold Double
    (String) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls less than this number, the pool will be marked unhealthy and will failover to the next available pool.
    modifiedOn String
    (Timestamp) The time (modified On) of the DNS glb pool.
    monitor String
    (String) The ID of the Load Balancer monitor to be associated to this pool.
    name String
    (String) The name of the DNS Load balancer pool.
    notificationChannel String
    (String) The webhook URL as a notification channel.
    origins List<GetDnsGlbPoolsDnsGlbPoolOrigin>
    (List) The list of origins within the pool. Traffic directed to the pool is balanced across all currently healthy origins, provided the pool itself is healthy.
    poolId String
    (String) The pool ID.
    createdOn string
    (Timestamp) The time (created On) of the DNS glb pool.
    description string
    (String) The description of the origin server.
    enabled boolean
    (String) Whether the origin server is enabled.
    health string
    (String) Whether the health is true or false.
    healthcheckRegion string
    (String) Health check region of VSIs. Allowable values are us-south,us-east, eu-gb, eu-du, au-syd, jp-tok.
    healthcheckSubnets string[]
    (String) Health check subnet CRN of VSIs.
    healthyOriginsThreshold number
    (String) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls less than this number, the pool will be marked unhealthy and will failover to the next available pool.
    modifiedOn string
    (Timestamp) The time (modified On) of the DNS glb pool.
    monitor string
    (String) The ID of the Load Balancer monitor to be associated to this pool.
    name string
    (String) The name of the DNS Load balancer pool.
    notificationChannel string
    (String) The webhook URL as a notification channel.
    origins GetDnsGlbPoolsDnsGlbPoolOrigin[]
    (List) The list of origins within the pool. Traffic directed to the pool is balanced across all currently healthy origins, provided the pool itself is healthy.
    poolId string
    (String) The pool ID.
    created_on str
    (Timestamp) The time (created On) of the DNS glb pool.
    description str
    (String) The description of the origin server.
    enabled bool
    (String) Whether the origin server is enabled.
    health str
    (String) Whether the health is true or false.
    healthcheck_region str
    (String) Health check region of VSIs. Allowable values are us-south,us-east, eu-gb, eu-du, au-syd, jp-tok.
    healthcheck_subnets Sequence[str]
    (String) Health check subnet CRN of VSIs.
    healthy_origins_threshold float
    (String) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls less than this number, the pool will be marked unhealthy and will failover to the next available pool.
    modified_on str
    (Timestamp) The time (modified On) of the DNS glb pool.
    monitor str
    (String) The ID of the Load Balancer monitor to be associated to this pool.
    name str
    (String) The name of the DNS Load balancer pool.
    notification_channel str
    (String) The webhook URL as a notification channel.
    origins Sequence[GetDnsGlbPoolsDnsGlbPoolOrigin]
    (List) The list of origins within the pool. Traffic directed to the pool is balanced across all currently healthy origins, provided the pool itself is healthy.
    pool_id str
    (String) The pool ID.
    createdOn String
    (Timestamp) The time (created On) of the DNS glb pool.
    description String
    (String) The description of the origin server.
    enabled Boolean
    (String) Whether the origin server is enabled.
    health String
    (String) Whether the health is true or false.
    healthcheckRegion String
    (String) Health check region of VSIs. Allowable values are us-south,us-east, eu-gb, eu-du, au-syd, jp-tok.
    healthcheckSubnets List<String>
    (String) Health check subnet CRN of VSIs.
    healthyOriginsThreshold Number
    (String) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls less than this number, the pool will be marked unhealthy and will failover to the next available pool.
    modifiedOn String
    (Timestamp) The time (modified On) of the DNS glb pool.
    monitor String
    (String) The ID of the Load Balancer monitor to be associated to this pool.
    name String
    (String) The name of the DNS Load balancer pool.
    notificationChannel String
    (String) The webhook URL as a notification channel.
    origins List<Property Map>
    (List) The list of origins within the pool. Traffic directed to the pool is balanced across all currently healthy origins, provided the pool itself is healthy.
    poolId String
    (String) The pool ID.

    GetDnsGlbPoolsDnsGlbPoolOrigin

    Address string
    (String) The address of the origin server. It can be a hostname or an IP address.
    Description string
    (String) The description of the origin server.
    Enabled bool
    (String) Whether the origin server is enabled.
    Health bool
    (String) Whether the health is true or false.
    HealthFailureReason string
    (String) The reason for the health check failure.
    Name string
    (String) The name of the DNS Load balancer pool.
    Address string
    (String) The address of the origin server. It can be a hostname or an IP address.
    Description string
    (String) The description of the origin server.
    Enabled bool
    (String) Whether the origin server is enabled.
    Health bool
    (String) Whether the health is true or false.
    HealthFailureReason string
    (String) The reason for the health check failure.
    Name string
    (String) The name of the DNS Load balancer pool.
    address String
    (String) The address of the origin server. It can be a hostname or an IP address.
    description String
    (String) The description of the origin server.
    enabled Boolean
    (String) Whether the origin server is enabled.
    health Boolean
    (String) Whether the health is true or false.
    healthFailureReason String
    (String) The reason for the health check failure.
    name String
    (String) The name of the DNS Load balancer pool.
    address string
    (String) The address of the origin server. It can be a hostname or an IP address.
    description string
    (String) The description of the origin server.
    enabled boolean
    (String) Whether the origin server is enabled.
    health boolean
    (String) Whether the health is true or false.
    healthFailureReason string
    (String) The reason for the health check failure.
    name string
    (String) The name of the DNS Load balancer pool.
    address str
    (String) The address of the origin server. It can be a hostname or an IP address.
    description str
    (String) The description of the origin server.
    enabled bool
    (String) Whether the origin server is enabled.
    health bool
    (String) Whether the health is true or false.
    health_failure_reason str
    (String) The reason for the health check failure.
    name str
    (String) The name of the DNS Load balancer pool.
    address String
    (String) The address of the origin server. It can be a hostname or an IP address.
    description String
    (String) The description of the origin server.
    enabled Boolean
    (String) Whether the origin server is enabled.
    health Boolean
    (String) Whether the health is true or false.
    healthFailureReason String
    (String) The reason for the health check failure.
    name String
    (String) The name of the DNS Load balancer pool.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud