Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVirtualEndpointGateways
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsVirtualEndpointGateways

Explore with Pulumi AI

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

    Retrieve information of an existing IBM Cloud infrastructure virtual endpoint gateways as a read-only data source. For more information, about the VPC endpoint gateways, see creating an endpoint gateway.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

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

    import pulumi

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Example Usage

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

const example = ibm.getIsVirtualEndpointGateways({});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_virtual_endpoint_gateways()

    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.GetIsVirtualEndpointGateways(ctx, &ibm.GetIsVirtualEndpointGatewaysArgs{}, 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 example = Ibm.GetIsVirtualEndpointGateways.Invoke();

});

    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.GetIsVirtualEndpointGatewaysArgs;
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 example = IbmFunctions.getIsVirtualEndpointGateways();

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsVirtualEndpointGateways
      arguments: {}

    Using getIsVirtualEndpointGateways

    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 getIsVirtualEndpointGateways(args: GetIsVirtualEndpointGatewaysArgs, opts?: InvokeOptions): Promise<GetIsVirtualEndpointGatewaysResult>
function getIsVirtualEndpointGatewaysOutput(args: GetIsVirtualEndpointGatewaysOutputArgs, opts?: InvokeOptions): Output<GetIsVirtualEndpointGatewaysResult>
    def get_is_virtual_endpoint_gateways(id: Optional[str] = None,
                                     name: Optional[str] = None,
                                     resource_group: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetIsVirtualEndpointGatewaysResult
def get_is_virtual_endpoint_gateways_output(id: Optional[pulumi.Input[str]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     resource_group: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetIsVirtualEndpointGatewaysResult]
    func GetIsVirtualEndpointGateways(ctx *Context, args *GetIsVirtualEndpointGatewaysArgs, opts ...InvokeOption) (*GetIsVirtualEndpointGatewaysResult, error)
func GetIsVirtualEndpointGatewaysOutput(ctx *Context, args *GetIsVirtualEndpointGatewaysOutputArgs, opts ...InvokeOption) GetIsVirtualEndpointGatewaysResultOutput

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

    public static class GetIsVirtualEndpointGateways 
{
    public static Task<GetIsVirtualEndpointGatewaysResult> InvokeAsync(GetIsVirtualEndpointGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVirtualEndpointGatewaysResult> Invoke(GetIsVirtualEndpointGatewaysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsVirtualEndpointGatewaysResult> getIsVirtualEndpointGateways(GetIsVirtualEndpointGatewaysArgs args, InvokeOptions options)
public static Output<GetIsVirtualEndpointGatewaysResult> getIsVirtualEndpointGateways(GetIsVirtualEndpointGatewaysArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsVirtualEndpointGateways:getIsVirtualEndpointGateways
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The endpoint gateway ID.
    Name string
    The name of the endpoint gateway
    ResourceGroup string
    The ID of the Resource group this endpoint gateway belongs to
    Id string
    (String) The endpoint gateway ID.
    Name string
    The name of the endpoint gateway
    ResourceGroup string
    The ID of the Resource group this endpoint gateway belongs to
    id String
    (String) The endpoint gateway ID.
    name String
    The name of the endpoint gateway
    resourceGroup String
    The ID of the Resource group this endpoint gateway belongs to
    id string
    (String) The endpoint gateway ID.
    name string
    The name of the endpoint gateway
    resourceGroup string
    The ID of the Resource group this endpoint gateway belongs to
    id str
    (String) The endpoint gateway ID.
    name str
    The name of the endpoint gateway
    resource_group str
    The ID of the Resource group this endpoint gateway belongs to
    id String
    (String) The endpoint gateway ID.
    name String
    The name of the endpoint gateway
    resourceGroup String
    The ID of the Resource group this endpoint gateway belongs to

    getIsVirtualEndpointGateways Result

    The following output properties are available:

    Id string
    (String) The endpoint gateway ID.
    VirtualEndpointGateways List<GetIsVirtualEndpointGatewaysVirtualEndpointGateway>
    (List) List of Endpoint Gateways in the IBM Cloud infrastructure region.
    Name string
    (String) The endpoint gateway target name.
    ResourceGroup string
    (String) The unique identifier for the resource group.
    Id string
    (String) The endpoint gateway ID.
    VirtualEndpointGateways []GetIsVirtualEndpointGatewaysVirtualEndpointGateway
    (List) List of Endpoint Gateways in the IBM Cloud infrastructure region.
    Name string
    (String) The endpoint gateway target name.
    ResourceGroup string
    (String) The unique identifier for the resource group.
    id String
    (String) The endpoint gateway ID.
    virtualEndpointGateways List<GetIsVirtualEndpointGatewaysVirtualEndpointGateway>
    (List) List of Endpoint Gateways in the IBM Cloud infrastructure region.
    name String
    (String) The endpoint gateway target name.
    resourceGroup String
    (String) The unique identifier for the resource group.
    id string
    (String) The endpoint gateway ID.
    virtualEndpointGateways GetIsVirtualEndpointGatewaysVirtualEndpointGateway[]
    (List) List of Endpoint Gateways in the IBM Cloud infrastructure region.
    name string
    (String) The endpoint gateway target name.
    resourceGroup string
    (String) The unique identifier for the resource group.
    id str
    (String) The endpoint gateway ID.
    virtual_endpoint_gateways Sequence[GetIsVirtualEndpointGatewaysVirtualEndpointGateway]
    (List) List of Endpoint Gateways in the IBM Cloud infrastructure region.
    name str
    (String) The endpoint gateway target name.
    resource_group str
    (String) The unique identifier for the resource group.
    id String
    (String) The endpoint gateway ID.
    virtualEndpointGateways List<Property Map>
    (List) List of Endpoint Gateways in the IBM Cloud infrastructure region.
    name String
    (String) The endpoint gateway target name.
    resourceGroup String
    (String) The unique identifier for the resource group.

    Supporting Types

    GetIsVirtualEndpointGatewaysVirtualEndpointGateway

    AccessTags List<string>
    (List) Access management tags associated for the virtual endpoint gateway.
    AllowDnsResolutionBinding bool
    (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway.
    Crn string
    (String) The endpoint gateway target CRN.
    HealthState string
    (String) The endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
    Id string
    (String) The endpoint gateway ID.
    Ips List<GetIsVirtualEndpointGatewaysVirtualEndpointGatewayIp>
    (List) The collection of reserved IPs bound to an endpoint gateway.
    LifecycleReasons List<GetIsVirtualEndpointGatewaysVirtualEndpointGatewayLifecycleReason>
    LifecycleState string
    (String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
    Name string
    The name of the endpoint gateway
    ResourceGroup string
    The ID of the Resource group this endpoint gateway belongs to
    ResourceType string
    (String) The endpoint gateway target resource type.
    SecurityGroups List<string>
    (List) - The security groups to use for this endpoint gateway.
    ServiceEndpoints List<string>
    (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
    Tags List<string>
    Targets List<GetIsVirtualEndpointGatewaysVirtualEndpointGatewayTarget>
    (List) The endpoint gateway target services.
    Vpc string
    (String) The VPC ID.
    AccessTags []string
    (List) Access management tags associated for the virtual endpoint gateway.
    AllowDnsResolutionBinding bool
    (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway.
    Crn string
    (String) The endpoint gateway target CRN.
    HealthState string
    (String) The endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
    Id string
    (String) The endpoint gateway ID.
    Ips []GetIsVirtualEndpointGatewaysVirtualEndpointGatewayIp
    (List) The collection of reserved IPs bound to an endpoint gateway.
    LifecycleReasons []GetIsVirtualEndpointGatewaysVirtualEndpointGatewayLifecycleReason
    LifecycleState string
    (String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
    Name string
    The name of the endpoint gateway
    ResourceGroup string
    The ID of the Resource group this endpoint gateway belongs to
    ResourceType string
    (String) The endpoint gateway target resource type.
    SecurityGroups []string
    (List) - The security groups to use for this endpoint gateway.
    ServiceEndpoints []string
    (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
    Tags []string
    Targets []GetIsVirtualEndpointGatewaysVirtualEndpointGatewayTarget
    (List) The endpoint gateway target services.
    Vpc string
    (String) The VPC ID.
    accessTags List<String>
    (List) Access management tags associated for the virtual endpoint gateway.
    allowDnsResolutionBinding Boolean
    (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway.
    crn String
    (String) The endpoint gateway target CRN.
    healthState String
    (String) The endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
    id String
    (String) The endpoint gateway ID.
    ips List<GetIsVirtualEndpointGatewaysVirtualEndpointGatewayIp>
    (List) The collection of reserved IPs bound to an endpoint gateway.
    lifecycleReasons List<GetIsVirtualEndpointGatewaysVirtualEndpointGatewayLifecycleReason>
    lifecycleState String
    (String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
    name String
    The name of the endpoint gateway
    resourceGroup String
    The ID of the Resource group this endpoint gateway belongs to
    resourceType String
    (String) The endpoint gateway target resource type.
    securityGroups List<String>
    (List) - The security groups to use for this endpoint gateway.
    serviceEndpoints List<String>
    (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
    tags List<String>
    targets List<GetIsVirtualEndpointGatewaysVirtualEndpointGatewayTarget>
    (List) The endpoint gateway target services.
    vpc String
    (String) The VPC ID.
    accessTags string[]
    (List) Access management tags associated for the virtual endpoint gateway.
    allowDnsResolutionBinding boolean
    (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
    createdAt string
    (Timestamp) The created date and time of the endpoint gateway.
    crn string
    (String) The endpoint gateway target CRN.
    healthState string
    (String) The endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
    id string
    (String) The endpoint gateway ID.
    ips GetIsVirtualEndpointGatewaysVirtualEndpointGatewayIp[]
    (List) The collection of reserved IPs bound to an endpoint gateway.
    lifecycleReasons GetIsVirtualEndpointGatewaysVirtualEndpointGatewayLifecycleReason[]
    lifecycleState string
    (String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
    name string
    The name of the endpoint gateway
    resourceGroup string
    The ID of the Resource group this endpoint gateway belongs to
    resourceType string
    (String) The endpoint gateway target resource type.
    securityGroups string[]
    (List) - The security groups to use for this endpoint gateway.
    serviceEndpoints string[]
    (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
    tags string[]
    targets GetIsVirtualEndpointGatewaysVirtualEndpointGatewayTarget[]
    (List) The endpoint gateway target services.
    vpc string
    (String) The VPC ID.
    access_tags Sequence[str]
    (List) Access management tags associated for the virtual endpoint gateway.
    allow_dns_resolution_binding bool
    (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
    created_at str
    (Timestamp) The created date and time of the endpoint gateway.
    crn str
    (String) The endpoint gateway target CRN.
    health_state str
    (String) The endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
    id str
    (String) The endpoint gateway ID.
    ips Sequence[GetIsVirtualEndpointGatewaysVirtualEndpointGatewayIp]
    (List) The collection of reserved IPs bound to an endpoint gateway.
    lifecycle_reasons Sequence[GetIsVirtualEndpointGatewaysVirtualEndpointGatewayLifecycleReason]
    lifecycle_state str
    (String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
    name str
    The name of the endpoint gateway
    resource_group str
    The ID of the Resource group this endpoint gateway belongs to
    resource_type str
    (String) The endpoint gateway target resource type.
    security_groups Sequence[str]
    (List) - The security groups to use for this endpoint gateway.
    service_endpoints Sequence[str]
    (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
    tags Sequence[str]
    targets Sequence[GetIsVirtualEndpointGatewaysVirtualEndpointGatewayTarget]
    (List) The endpoint gateway target services.
    vpc str
    (String) The VPC ID.
    accessTags List<String>
    (List) Access management tags associated for the virtual endpoint gateway.
    allowDnsResolutionBinding Boolean
    (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway.
    crn String
    (String) The endpoint gateway target CRN.
    healthState String
    (String) The endpoint gateway health state. ok: Healthy, degraded: Suffering from compromised performance, capacity, or connectivity, faulted: Completely unreachable, inoperative, or entirely incapacitated, inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state.
    id String
    (String) The endpoint gateway ID.
    ips List<Property Map>
    (List) The collection of reserved IPs bound to an endpoint gateway.
    lifecycleReasons List<Property Map>
    lifecycleState String
    (String) The endpoint gateway lifecycle state, supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
    name String
    The name of the endpoint gateway
    resourceGroup String
    The ID of the Resource group this endpoint gateway belongs to
    resourceType String
    (String) The endpoint gateway target resource type.
    securityGroups List<String>
    (List) - The security groups to use for this endpoint gateway.
    serviceEndpoints List<String>
    (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
    tags List<String>
    targets List<Property Map>
    (List) The endpoint gateway target services.
    vpc String
    (String) The VPC ID.

    GetIsVirtualEndpointGatewaysVirtualEndpointGatewayIp

    Id string
    (String) The unique identifier for the reserved IP.
    Name string
    The name of the endpoint gateway
    ResourceType string
    (String) The endpoint gateway IP resource type or the subnet reserved IP.
    Id string
    (String) The unique identifier for the reserved IP.
    Name string
    The name of the endpoint gateway
    ResourceType string
    (String) The endpoint gateway IP resource type or the subnet reserved IP.
    id String
    (String) The unique identifier for the reserved IP.
    name String
    The name of the endpoint gateway
    resourceType String
    (String) The endpoint gateway IP resource type or the subnet reserved IP.
    id string
    (String) The unique identifier for the reserved IP.
    name string
    The name of the endpoint gateway
    resourceType string
    (String) The endpoint gateway IP resource type or the subnet reserved IP.
    id str
    (String) The unique identifier for the reserved IP.
    name str
    The name of the endpoint gateway
    resource_type str
    (String) The endpoint gateway IP resource type or the subnet reserved IP.
    id String
    (String) The unique identifier for the reserved IP.
    name String
    The name of the endpoint gateway
    resourceType String
    (String) The endpoint gateway IP resource type or the subnet reserved IP.

    GetIsVirtualEndpointGatewaysVirtualEndpointGatewayLifecycleReason

    Code string
    Message string
    MoreInfo string
    Code string
    Message string
    MoreInfo string
    code String
    message String
    moreInfo String
    code string
    message string
    moreInfo string
    code String
    message String
    moreInfo String

    GetIsVirtualEndpointGatewaysVirtualEndpointGatewayTarget

    Crn string
    (String) The endpoint gateway target CRN.
    Name string
    The name of the endpoint gateway
    ResourceType string
    (String) The endpoint gateway target resource type.
    Crn string
    (String) The endpoint gateway target CRN.
    Name string
    The name of the endpoint gateway
    ResourceType string
    (String) The endpoint gateway target resource type.
    crn String
    (String) The endpoint gateway target CRN.
    name String
    The name of the endpoint gateway
    resourceType String
    (String) The endpoint gateway target resource type.
    crn string
    (String) The endpoint gateway target CRN.
    name string
    The name of the endpoint gateway
    resourceType string
    (String) The endpoint gateway target resource type.
    crn str
    (String) The endpoint gateway target CRN.
    name str
    The name of the endpoint gateway
    resource_type str
    (String) The endpoint gateway target resource type.
    crn String
    (String) The endpoint gateway target CRN.
    name String
    The name of the endpoint gateway
    resourceType String
    (String) The endpoint gateway target resource type.

    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
    ibm-cloud/terraform-provider-ibm