1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyGatewayConnection
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware

nsxt.getPolicyGatewayConnection

Explore with Pulumi AI

nsxt logo
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware

    This data source provides information about Gateway Connection on NSX.

    This data source is applicable to NSX Policy Manager.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const test = nsxt.getPolicyGatewayConnection({
        displayName: "test",
        tier0Path: data.nsxt_policy_tier0_gateway.path,
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    test = nsxt.get_policy_gateway_connection(display_name="test",
        tier0_path=data["nsxt_policy_tier0_gateway"]["path"])
    
    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.LookupPolicyGatewayConnection(ctx, &nsxt.LookupPolicyGatewayConnectionArgs{
    			DisplayName: "test",
    			Tier0Path:   pulumi.StringRef(data.Nsxt_policy_tier0_gateway.Path),
    		}, 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 test = Nsxt.GetPolicyGatewayConnection.Invoke(new()
        {
            DisplayName = "test",
            Tier0Path = data.Nsxt_policy_tier0_gateway.Path,
        });
    
    });
    
    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.GetPolicyGatewayConnectionArgs;
    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 test = NsxtFunctions.getPolicyGatewayConnection(GetPolicyGatewayConnectionArgs.builder()
                .displayName("test")
                .tier0Path(data.nsxt_policy_tier0_gateway().path())
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: nsxt:getPolicyGatewayConnection
          arguments:
            displayName: test
            tier0Path: ${data.nsxt_policy_tier0_gateway.path}
    

    Using getPolicyGatewayConnection

    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 getPolicyGatewayConnection(args: GetPolicyGatewayConnectionArgs, opts?: InvokeOptions): Promise<GetPolicyGatewayConnectionResult>
    function getPolicyGatewayConnectionOutput(args: GetPolicyGatewayConnectionOutputArgs, opts?: InvokeOptions): Output<GetPolicyGatewayConnectionResult>
    def get_policy_gateway_connection(description: Optional[str] = None,
                                      display_name: Optional[str] = None,
                                      id: Optional[str] = None,
                                      tier0_path: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetPolicyGatewayConnectionResult
    def get_policy_gateway_connection_output(description: Optional[pulumi.Input[str]] = None,
                                      display_name: Optional[pulumi.Input[str]] = None,
                                      id: Optional[pulumi.Input[str]] = None,
                                      tier0_path: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetPolicyGatewayConnectionResult]
    func LookupPolicyGatewayConnection(ctx *Context, args *LookupPolicyGatewayConnectionArgs, opts ...InvokeOption) (*LookupPolicyGatewayConnectionResult, error)
    func LookupPolicyGatewayConnectionOutput(ctx *Context, args *LookupPolicyGatewayConnectionOutputArgs, opts ...InvokeOption) LookupPolicyGatewayConnectionResultOutput

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

    public static class GetPolicyGatewayConnection 
    {
        public static Task<GetPolicyGatewayConnectionResult> InvokeAsync(GetPolicyGatewayConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyGatewayConnectionResult> Invoke(GetPolicyGatewayConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyGatewayConnectionResult> getPolicyGatewayConnection(GetPolicyGatewayConnectionArgs args, InvokeOptions options)
    public static Output<GetPolicyGatewayConnectionResult> getPolicyGatewayConnection(GetPolicyGatewayConnectionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyGatewayConnection:getPolicyGatewayConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DisplayName string
    The Display Name prefix of the transit gateway to retrieve.
    Description string
    The description of the resource.
    Id string
    The ID of transit gateway to retrieve.
    Tier0Path string
    Path of Tier0 for this connection
    DisplayName string
    The Display Name prefix of the transit gateway to retrieve.
    Description string
    The description of the resource.
    Id string
    The ID of transit gateway to retrieve.
    Tier0Path string
    Path of Tier0 for this connection
    displayName String
    The Display Name prefix of the transit gateway to retrieve.
    description String
    The description of the resource.
    id String
    The ID of transit gateway to retrieve.
    tier0Path String
    Path of Tier0 for this connection
    displayName string
    The Display Name prefix of the transit gateway to retrieve.
    description string
    The description of the resource.
    id string
    The ID of transit gateway to retrieve.
    tier0Path string
    Path of Tier0 for this connection
    display_name str
    The Display Name prefix of the transit gateway to retrieve.
    description str
    The description of the resource.
    id str
    The ID of transit gateway to retrieve.
    tier0_path str
    Path of Tier0 for this connection
    displayName String
    The Display Name prefix of the transit gateway to retrieve.
    description String
    The description of the resource.
    id String
    The ID of transit gateway to retrieve.
    tier0Path String
    Path of Tier0 for this connection

    getPolicyGatewayConnection Result

    The following output properties are available:

    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Description string
    The description of the resource.
    Tier0Path string
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Description string
    The description of the resource.
    Tier0Path string
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    description String
    The description of the resource.
    tier0Path String
    displayName string
    id string
    path string
    The NSX path of the policy resource.
    description string
    The description of the resource.
    tier0Path string
    display_name str
    id str
    path str
    The NSX path of the policy resource.
    description str
    The description of the resource.
    tier0_path str
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    description String
    The description of the resource.
    tier0Path String

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware