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

nsxt.getPolicyEdgeHighAvailabilityProfile

Explore with Pulumi AI

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

    This data source provides information about policy Edge high availability profile configured 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 edgeHaProfile = nsxt.getPolicyEdgeHighAvailabilityProfile({
        displayName: "edge_ha_profile1",
        sitePath: data.nsxt_policy_site.paris.path,
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    edge_ha_profile = nsxt.get_policy_edge_high_availability_profile(display_name="edge_ha_profile1",
        site_path=data["nsxt_policy_site"]["paris"]["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.LookupPolicyEdgeHighAvailabilityProfile(ctx, &nsxt.LookupPolicyEdgeHighAvailabilityProfileArgs{
    			DisplayName: pulumi.StringRef("edge_ha_profile1"),
    			SitePath:    pulumi.StringRef(data.Nsxt_policy_site.Paris.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 edgeHaProfile = Nsxt.GetPolicyEdgeHighAvailabilityProfile.Invoke(new()
        {
            DisplayName = "edge_ha_profile1",
            SitePath = data.Nsxt_policy_site.Paris.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.GetPolicyEdgeHighAvailabilityProfileArgs;
    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 edgeHaProfile = NsxtFunctions.getPolicyEdgeHighAvailabilityProfile(GetPolicyEdgeHighAvailabilityProfileArgs.builder()
                .displayName("edge_ha_profile1")
                .sitePath(data.nsxt_policy_site().paris().path())
                .build());
    
        }
    }
    
    variables:
      edgeHaProfile:
        fn::invoke:
          function: nsxt:getPolicyEdgeHighAvailabilityProfile
          arguments:
            displayName: edge_ha_profile1
            sitePath: ${data.nsxt_policy_site.paris.path}
    

    Using getPolicyEdgeHighAvailabilityProfile

    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 getPolicyEdgeHighAvailabilityProfile(args: GetPolicyEdgeHighAvailabilityProfileArgs, opts?: InvokeOptions): Promise<GetPolicyEdgeHighAvailabilityProfileResult>
    function getPolicyEdgeHighAvailabilityProfileOutput(args: GetPolicyEdgeHighAvailabilityProfileOutputArgs, opts?: InvokeOptions): Output<GetPolicyEdgeHighAvailabilityProfileResult>
    def get_policy_edge_high_availability_profile(description: Optional[str] = None,
                                                  display_name: Optional[str] = None,
                                                  id: Optional[str] = None,
                                                  site_path: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetPolicyEdgeHighAvailabilityProfileResult
    def get_policy_edge_high_availability_profile_output(description: Optional[pulumi.Input[str]] = None,
                                                  display_name: Optional[pulumi.Input[str]] = None,
                                                  id: Optional[pulumi.Input[str]] = None,
                                                  site_path: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetPolicyEdgeHighAvailabilityProfileResult]
    func LookupPolicyEdgeHighAvailabilityProfile(ctx *Context, args *LookupPolicyEdgeHighAvailabilityProfileArgs, opts ...InvokeOption) (*LookupPolicyEdgeHighAvailabilityProfileResult, error)
    func LookupPolicyEdgeHighAvailabilityProfileOutput(ctx *Context, args *LookupPolicyEdgeHighAvailabilityProfileOutputArgs, opts ...InvokeOption) LookupPolicyEdgeHighAvailabilityProfileResultOutput

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

    public static class GetPolicyEdgeHighAvailabilityProfile 
    {
        public static Task<GetPolicyEdgeHighAvailabilityProfileResult> InvokeAsync(GetPolicyEdgeHighAvailabilityProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyEdgeHighAvailabilityProfileResult> Invoke(GetPolicyEdgeHighAvailabilityProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyEdgeHighAvailabilityProfileResult> getPolicyEdgeHighAvailabilityProfile(GetPolicyEdgeHighAvailabilityProfileArgs args, InvokeOptions options)
    public static Output<GetPolicyEdgeHighAvailabilityProfileResult> getPolicyEdgeHighAvailabilityProfile(GetPolicyEdgeHighAvailabilityProfileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyEdgeHighAvailabilityProfile:getPolicyEdgeHighAvailabilityProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Edge high availability profile to retrieve.
    Id string
    The ID of policy Edge high availability profile to retrieve.
    SitePath string
    The path of the site which the Edge high availability profile belongs to.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Edge high availability profile to retrieve.
    Id string
    The ID of policy Edge high availability profile to retrieve.
    SitePath string
    The path of the site which the Edge high availability profile belongs to.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Edge high availability profile to retrieve.
    id String
    The ID of policy Edge high availability profile to retrieve.
    sitePath String
    The path of the site which the Edge high availability profile belongs to.
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of the Edge high availability profile to retrieve.
    id string
    The ID of policy Edge high availability profile to retrieve.
    sitePath string
    The path of the site which the Edge high availability profile belongs to.
    description str
    The description of the resource.
    display_name str
    The Display Name prefix of the Edge high availability profile to retrieve.
    id str
    The ID of policy Edge high availability profile to retrieve.
    site_path str
    The path of the site which the Edge high availability profile belongs to.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Edge high availability profile to retrieve.
    id String
    The ID of policy Edge high availability profile to retrieve.
    sitePath String
    The path of the site which the Edge high availability profile belongs to.

    getPolicyEdgeHighAvailabilityProfile Result

    The following output properties are available:

    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    UniqueId string
    A unique identifier assigned by the system.
    SitePath string
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    UniqueId string
    A unique identifier assigned by the system.
    SitePath string
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    uniqueId String
    A unique identifier assigned by the system.
    sitePath String
    description string
    The description of the resource.
    displayName string
    id string
    path string
    The NSX path of the policy resource.
    uniqueId string
    A unique identifier assigned by the system.
    sitePath string
    description str
    The description of the resource.
    display_name str
    id str
    path str
    The NSX path of the policy resource.
    unique_id str
    A unique identifier assigned by the system.
    site_path str
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    uniqueId String
    A unique identifier assigned by the system.
    sitePath 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