1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicySite
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.getPolicySite

Explore with Pulumi AI

nsxt logo
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

    This data source provides information about Site (or Location) configured on NSX Global Manager.

    This data source is applicable to NSX Global Manager only.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const paris = nsxt.getPolicySite({
        displayName: "Paris",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    paris = nsxt.get_policy_site(display_name="Paris")
    
    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.LookupPolicySite(ctx, &nsxt.LookupPolicySiteArgs{
    			DisplayName: pulumi.StringRef("Paris"),
    		}, 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 paris = Nsxt.GetPolicySite.Invoke(new()
        {
            DisplayName = "Paris",
        });
    
    });
    
    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.GetPolicySiteArgs;
    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 paris = NsxtFunctions.getPolicySite(GetPolicySiteArgs.builder()
                .displayName("Paris")
                .build());
    
        }
    }
    
    variables:
      paris:
        fn::invoke:
          function: nsxt:getPolicySite
          arguments:
            displayName: Paris
    

    Using getPolicySite

    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 getPolicySite(args: GetPolicySiteArgs, opts?: InvokeOptions): Promise<GetPolicySiteResult>
    function getPolicySiteOutput(args: GetPolicySiteOutputArgs, opts?: InvokeOptions): Output<GetPolicySiteResult>
    def get_policy_site(description: Optional[str] = None,
                        display_name: Optional[str] = None,
                        id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPolicySiteResult
    def get_policy_site_output(description: Optional[pulumi.Input[str]] = None,
                        display_name: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPolicySiteResult]
    func LookupPolicySite(ctx *Context, args *LookupPolicySiteArgs, opts ...InvokeOption) (*LookupPolicySiteResult, error)
    func LookupPolicySiteOutput(ctx *Context, args *LookupPolicySiteOutputArgs, opts ...InvokeOption) LookupPolicySiteResultOutput

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

    public static class GetPolicySite 
    {
        public static Task<GetPolicySiteResult> InvokeAsync(GetPolicySiteArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicySiteResult> Invoke(GetPolicySiteInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicySiteResult> getPolicySite(GetPolicySiteArgs args, InvokeOptions options)
    public static Output<GetPolicySiteResult> getPolicySite(GetPolicySiteArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicySite:getPolicySite
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Site to retrieve.
    Id string
    The ID of Site to retrieve.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Site to retrieve.
    Id string
    The ID of Site to retrieve.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Site to retrieve.
    id String
    The ID of Site to retrieve.
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of the Site to retrieve.
    id string
    The ID of Site to retrieve.
    description str
    The description of the resource.
    display_name str
    The Display Name prefix of the Site to retrieve.
    id str
    The ID of Site to retrieve.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Site to retrieve.
    id String
    The ID of Site to retrieve.

    getPolicySite 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. This attribute can serve as site_path field of nsxt.PolicyTransportZone data source.
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource. This attribute can serve as site_path field of nsxt.PolicyTransportZone data source.
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource. This attribute can serve as site_path field of nsxt.PolicyTransportZone data source.
    description string
    The description of the resource.
    displayName string
    id string
    path string
    The NSX path of the policy resource. This attribute can serve as site_path field of nsxt.PolicyTransportZone data source.
    description str
    The description of the resource.
    display_name str
    id str
    path str
    The NSX path of the policy resource. This attribute can serve as site_path field of nsxt.PolicyTransportZone data source.
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource. This attribute can serve as site_path field of nsxt.PolicyTransportZone data source.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware