1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyShare
nsxt 3.10.0 published on Wednesday, Sep 10, 2025 by vmware

nsxt.getPolicyShare

Explore with Pulumi AI

nsxt logo
nsxt 3.10.0 published on Wednesday, Sep 10, 2025 by vmware

    This data source provides information about a Share 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 share = nsxt.getPolicyShare({
        displayName: "share1",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    share = nsxt.get_policy_share(display_name="share1")
    
    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.LookupPolicyShare(ctx, &nsxt.LookupPolicyShareArgs{
    			DisplayName: "share1",
    		}, 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 share = Nsxt.GetPolicyShare.Invoke(new()
        {
            DisplayName = "share1",
        });
    
    });
    
    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.GetPolicyShareArgs;
    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 share = NsxtFunctions.getPolicyShare(GetPolicyShareArgs.builder()
                .displayName("share1")
                .build());
    
        }
    }
    
    variables:
      share:
        fn::invoke:
          function: nsxt:getPolicyShare
          arguments:
            displayName: share1
    

    Using getPolicyShare

    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 getPolicyShare(args: GetPolicyShareArgs, opts?: InvokeOptions): Promise<GetPolicyShareResult>
    function getPolicyShareOutput(args: GetPolicyShareOutputArgs, opts?: InvokeOptions): Output<GetPolicyShareResult>
    def get_policy_share(description: Optional[str] = None,
                         display_name: Optional[str] = None,
                         id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPolicyShareResult
    def get_policy_share_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[GetPolicyShareResult]
    func LookupPolicyShare(ctx *Context, args *LookupPolicyShareArgs, opts ...InvokeOption) (*LookupPolicyShareResult, error)
    func LookupPolicyShareOutput(ctx *Context, args *LookupPolicyShareOutputArgs, opts ...InvokeOption) LookupPolicyShareResultOutput

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

    public static class GetPolicyShare 
    {
        public static Task<GetPolicyShareResult> InvokeAsync(GetPolicyShareArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyShareResult> Invoke(GetPolicyShareInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyShareResult> getPolicyShare(GetPolicyShareArgs args, InvokeOptions options)
    public static Output<GetPolicyShareResult> getPolicyShare(GetPolicyShareArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyShare:getPolicyShare
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getPolicyShare 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.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Description string
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    description String
    The description of the resource.
    displayName string
    id string
    path string
    The NSX path of the policy resource.
    description string
    The description of the resource.
    display_name str
    id str
    path str
    The NSX path of the policy resource.
    description str
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    description String
    The description of the resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.10.0 published on Wednesday, Sep 10, 2025 by vmware