1. Packages
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. getPolicyTier1Gateways
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware

    This data source provides list of Tier-1s configured on NSX.

    This data source is applicable to NSX Policy Manager, NSX Global Manager and VMC.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const all = nsxt.getPolicyTier1Gateways({});
    export const nsxtPolicyTier1GatewaysResult = all.then(all => all.items);
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    all = nsxt.get_policy_tier1_gateways()
    pulumi.export("nsxtPolicyTier1GatewaysResult", all.items)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		all, err := nsxt.GetPolicyTier1Gateways(ctx, &nsxt.GetPolicyTier1GatewaysArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("nsxtPolicyTier1GatewaysResult", all.Items)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Nsxt.GetPolicyTier1Gateways.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["nsxtPolicyTier1GatewaysResult"] = all.Apply(getPolicyTier1GatewaysResult => getPolicyTier1GatewaysResult.Items),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetPolicyTier1GatewaysArgs;
    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 all = NsxtFunctions.getPolicyTier1Gateways(GetPolicyTier1GatewaysArgs.builder()
                .build());
    
            ctx.export("nsxtPolicyTier1GatewaysResult", all.items());
        }
    }
    
    variables:
      all:
        fn::invoke:
          function: nsxt:getPolicyTier1Gateways
          arguments: {}
    outputs:
      nsxtPolicyTier1GatewaysResult: ${all.items}
    
    Example coming soon!
    

    Using Regex

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const all = nsxt.getPolicyTier1Gateways({
        displayName: ".*",
    });
    export const nsxtPolicyTier1GatewaysResult = all.then(all => all.items);
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    all = nsxt.get_policy_tier1_gateways(display_name=".*")
    pulumi.export("nsxtPolicyTier1GatewaysResult", all.items)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		all, err := nsxt.GetPolicyTier1Gateways(ctx, &nsxt.GetPolicyTier1GatewaysArgs{
    			DisplayName: pulumi.StringRef(".*"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("nsxtPolicyTier1GatewaysResult", all.Items)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Nsxt.GetPolicyTier1Gateways.Invoke(new()
        {
            DisplayName = ".*",
        });
    
        return new Dictionary<string, object?>
        {
            ["nsxtPolicyTier1GatewaysResult"] = all.Apply(getPolicyTier1GatewaysResult => getPolicyTier1GatewaysResult.Items),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetPolicyTier1GatewaysArgs;
    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 all = NsxtFunctions.getPolicyTier1Gateways(GetPolicyTier1GatewaysArgs.builder()
                .displayName(".*")
                .build());
    
            ctx.export("nsxtPolicyTier1GatewaysResult", all.items());
        }
    }
    
    variables:
      all:
        fn::invoke:
          function: nsxt:getPolicyTier1Gateways
          arguments:
            displayName: .*
    outputs:
      nsxtPolicyTier1GatewaysResult: ${all.items}
    
    Example coming soon!
    

    Multi-Tenancy

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const all = nsxt.getPolicyProject({});
    const allGetPolicyTier1Gateways = nsxt.getPolicyTier1Gateways({
        context: {
            projectId: demoproj.id,
        },
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    all = nsxt.get_policy_project()
    all_get_policy_tier1_gateways = nsxt.get_policy_tier1_gateways(context={
        "project_id": demoproj["id"],
    })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nsxt.LookupPolicyProject(ctx, &nsxt.LookupPolicyProjectArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = nsxt.GetPolicyTier1Gateways(ctx, &nsxt.GetPolicyTier1GatewaysArgs{
    			Context: nsxt.GetPolicyTier1GatewaysContext{
    				ProjectId: pulumi.StringRef(demoproj.Id),
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Nsxt.GetPolicyProject.Invoke();
    
        var allGetPolicyTier1Gateways = Nsxt.GetPolicyTier1Gateways.Invoke(new()
        {
            Context = new Nsxt.Inputs.GetPolicyTier1GatewaysContextInputArgs
            {
                ProjectId = demoproj.Id,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetPolicyProjectArgs;
    import com.pulumi.nsxt.inputs.GetPolicyTier1GatewaysArgs;
    import com.pulumi.nsxt.inputs.GetPolicyTier1GatewaysContextArgs;
    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 all = NsxtFunctions.getPolicyProject(GetPolicyProjectArgs.builder()
                .build());
    
            final var allGetPolicyTier1Gateways = NsxtFunctions.getPolicyTier1Gateways(GetPolicyTier1GatewaysArgs.builder()
                .context(GetPolicyTier1GatewaysContextArgs.builder()
                    .projectId(demoproj.id())
                    .build())
                .build());
    
        }
    }
    
    variables:
      all:
        fn::invoke:
          function: nsxt:getPolicyProject
          arguments: {}
      allGetPolicyTier1Gateways:
        fn::invoke:
          function: nsxt:getPolicyTier1Gateways
          arguments:
            context:
              projectId: ${demoproj.id}
    
    Example coming soon!
    

    Global Infra

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const all = nsxt.getPolicyTier1Gateways({
        context: {
            fromGlobal: true,
        },
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    all = nsxt.get_policy_tier1_gateways(context={
        "from_global": True,
    })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nsxt.GetPolicyTier1Gateways(ctx, &nsxt.GetPolicyTier1GatewaysArgs{
    			Context: nsxt.GetPolicyTier1GatewaysContext{
    				FromGlobal: pulumi.BoolRef(true),
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Nsxt.GetPolicyTier1Gateways.Invoke(new()
        {
            Context = new Nsxt.Inputs.GetPolicyTier1GatewaysContextInputArgs
            {
                FromGlobal = true,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetPolicyTier1GatewaysArgs;
    import com.pulumi.nsxt.inputs.GetPolicyTier1GatewaysContextArgs;
    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 all = NsxtFunctions.getPolicyTier1Gateways(GetPolicyTier1GatewaysArgs.builder()
                .context(GetPolicyTier1GatewaysContextArgs.builder()
                    .fromGlobal(true)
                    .build())
                .build());
    
        }
    }
    
    variables:
      all:
        fn::invoke:
          function: nsxt:getPolicyTier1Gateways
          arguments:
            context:
              fromGlobal: true
    
    Example coming soon!
    

    Using getPolicyTier1Gateways

    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 getPolicyTier1Gateways(args: GetPolicyTier1GatewaysArgs, opts?: InvokeOptions): Promise<GetPolicyTier1GatewaysResult>
    function getPolicyTier1GatewaysOutput(args: GetPolicyTier1GatewaysOutputArgs, opts?: InvokeOptions): Output<GetPolicyTier1GatewaysResult>
    def get_policy_tier1_gateways(context: Optional[GetPolicyTier1GatewaysContext] = None,
                                  display_name: Optional[str] = None,
                                  id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetPolicyTier1GatewaysResult
    def get_policy_tier1_gateways_output(context: pulumi.Input[Optional[GetPolicyTier1GatewaysContextArgs]] = None,
                                  display_name: pulumi.Input[Optional[str]] = None,
                                  id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetPolicyTier1GatewaysResult]
    func GetPolicyTier1Gateways(ctx *Context, args *GetPolicyTier1GatewaysArgs, opts ...InvokeOption) (*GetPolicyTier1GatewaysResult, error)
    func GetPolicyTier1GatewaysOutput(ctx *Context, args *GetPolicyTier1GatewaysOutputArgs, opts ...InvokeOption) GetPolicyTier1GatewaysResultOutput

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

    public static class GetPolicyTier1Gateways 
    {
        public static Task<GetPolicyTier1GatewaysResult> InvokeAsync(GetPolicyTier1GatewaysArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyTier1GatewaysResult> Invoke(GetPolicyTier1GatewaysInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyTier1GatewaysResult> getPolicyTier1Gateways(GetPolicyTier1GatewaysArgs args, InvokeOptions options)
    public static Output<GetPolicyTier1GatewaysResult> getPolicyTier1Gateways(GetPolicyTier1GatewaysArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyTier1Gateways:getPolicyTier1Gateways
      arguments:
        # arguments dictionary
    data "nsxt_getpolicytier1gateways" "name" {
        # arguments
    }

    The following arguments are supported:

    Context GetPolicyTier1GatewaysContext
    The context which the object belongs to
    DisplayName string
    Display name for the Tier1. Supports regular expressions.
    Id string
    Context GetPolicyTier1GatewaysContext
    The context which the object belongs to
    DisplayName string
    Display name for the Tier1. Supports regular expressions.
    Id string
    context object
    The context which the object belongs to
    display_name string
    Display name for the Tier1. Supports regular expressions.
    id string
    context GetPolicyTier1GatewaysContext
    The context which the object belongs to
    displayName String
    Display name for the Tier1. Supports regular expressions.
    id String
    context GetPolicyTier1GatewaysContext
    The context which the object belongs to
    displayName string
    Display name for the Tier1. Supports regular expressions.
    id string
    context GetPolicyTier1GatewaysContext
    The context which the object belongs to
    display_name str
    Display name for the Tier1. Supports regular expressions.
    id str
    context Property Map
    The context which the object belongs to
    displayName String
    Display name for the Tier1. Supports regular expressions.
    id String

    getPolicyTier1Gateways Result

    The following output properties are available:

    Id string
    Items Dictionary<string, string>
    Map of IDs by Display Name.
    Context GetPolicyTier1GatewaysContext
    DisplayName string
    Id string
    Items map[string]string
    Map of IDs by Display Name.
    Context GetPolicyTier1GatewaysContext
    DisplayName string
    id string
    items map(string)
    Map of IDs by Display Name.
    context object
    display_name string
    id String
    items Map<String,String>
    Map of IDs by Display Name.
    context GetPolicyTier1GatewaysContext
    displayName String
    id string
    items {[key: string]: string}
    Map of IDs by Display Name.
    context GetPolicyTier1GatewaysContext
    displayName string
    id str
    items Mapping[str, str]
    Map of IDs by Display Name.
    context GetPolicyTier1GatewaysContext
    display_name str
    id String
    items Map<String>
    Map of IDs by Display Name.
    context Property Map
    displayName String

    Supporting Types

    GetPolicyTier1GatewaysContext

    FromGlobal bool
    Set to True if the data source will need to search Tier-1 gateway created in a global manager instance (/global-infra)
    ProjectId string
    The ID of the project which the object belongs to
    FromGlobal bool
    Set to True if the data source will need to search Tier-1 gateway created in a global manager instance (/global-infra)
    ProjectId string
    The ID of the project which the object belongs to
    from_global bool
    Set to True if the data source will need to search Tier-1 gateway created in a global manager instance (/global-infra)
    project_id string
    The ID of the project which the object belongs to
    fromGlobal Boolean
    Set to True if the data source will need to search Tier-1 gateway created in a global manager instance (/global-infra)
    projectId String
    The ID of the project which the object belongs to
    fromGlobal boolean
    Set to True if the data source will need to search Tier-1 gateway created in a global manager instance (/global-infra)
    projectId string
    The ID of the project which the object belongs to
    from_global bool
    Set to True if the data source will need to search Tier-1 gateway created in a global manager instance (/global-infra)
    project_id str
    The ID of the project which the object belongs to
    fromGlobal Boolean
    Set to True if the data source will need to search Tier-1 gateway created in a global manager instance (/global-infra)
    projectId String
    The ID of the project which the object belongs to

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    Viewing docs for nsxt 3.12.0
    published on Monday, May 18, 2026 by vmware

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial