1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyLbMonitor
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.getPolicyLbMonitor

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    This data source provides information about Policy Load Balancer Monitor 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 test = nsxt.getPolicyLbMonitor({
        displayName: "my-tcp-monitor",
        type: "TCP",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    test = nsxt.get_policy_lb_monitor(display_name="my-tcp-monitor",
        type="TCP")
    
    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.GetPolicyLbMonitor(ctx, &nsxt.GetPolicyLbMonitorArgs{
    			DisplayName: pulumi.StringRef("my-tcp-monitor"),
    			Type:        pulumi.StringRef("TCP"),
    		}, 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.GetPolicyLbMonitor.Invoke(new()
        {
            DisplayName = "my-tcp-monitor",
            Type = "TCP",
        });
    
    });
    
    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.GetPolicyLbMonitorArgs;
    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.getPolicyLbMonitor(GetPolicyLbMonitorArgs.builder()
                .displayName("my-tcp-monitor")
                .type("TCP")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: nsxt:getPolicyLbMonitor
          arguments:
            displayName: my-tcp-monitor
            type: TCP
    

    Using getPolicyLbMonitor

    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 getPolicyLbMonitor(args: GetPolicyLbMonitorArgs, opts?: InvokeOptions): Promise<GetPolicyLbMonitorResult>
    function getPolicyLbMonitorOutput(args: GetPolicyLbMonitorOutputArgs, opts?: InvokeOptions): Output<GetPolicyLbMonitorResult>
    def get_policy_lb_monitor(description: Optional[str] = None,
                              display_name: Optional[str] = None,
                              id: Optional[str] = None,
                              type: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPolicyLbMonitorResult
    def get_policy_lb_monitor_output(description: Optional[pulumi.Input[str]] = None,
                              display_name: Optional[pulumi.Input[str]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              type: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPolicyLbMonitorResult]
    func GetPolicyLbMonitor(ctx *Context, args *GetPolicyLbMonitorArgs, opts ...InvokeOption) (*GetPolicyLbMonitorResult, error)
    func GetPolicyLbMonitorOutput(ctx *Context, args *GetPolicyLbMonitorOutputArgs, opts ...InvokeOption) GetPolicyLbMonitorResultOutput

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

    public static class GetPolicyLbMonitor 
    {
        public static Task<GetPolicyLbMonitorResult> InvokeAsync(GetPolicyLbMonitorArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyLbMonitorResult> Invoke(GetPolicyLbMonitorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyLbMonitorResult> getPolicyLbMonitor(GetPolicyLbMonitorArgs args, InvokeOptions options)
    public static Output<GetPolicyLbMonitorResult> getPolicyLbMonitor(GetPolicyLbMonitorArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyLbMonitor:getPolicyLbMonitor
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of Monitor to retrieve.
    Id string
    The ID of Monitor to retrieve.
    Type string
    Type of Monitor to retrieve, one of HTTP, HTTPS, TCP, UDP, ICMP, PASSIVE, ANY.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of Monitor to retrieve.
    Id string
    The ID of Monitor to retrieve.
    Type string
    Type of Monitor to retrieve, one of HTTP, HTTPS, TCP, UDP, ICMP, PASSIVE, ANY.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of Monitor to retrieve.
    id String
    The ID of Monitor to retrieve.
    type String
    Type of Monitor to retrieve, one of HTTP, HTTPS, TCP, UDP, ICMP, PASSIVE, ANY.
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of Monitor to retrieve.
    id string
    The ID of Monitor to retrieve.
    type string
    Type of Monitor to retrieve, one of HTTP, HTTPS, TCP, UDP, ICMP, PASSIVE, ANY.
    description str
    The description of the resource.
    display_name str
    The Display Name prefix of Monitor to retrieve.
    id str
    The ID of Monitor to retrieve.
    type str
    Type of Monitor to retrieve, one of HTTP, HTTPS, TCP, UDP, ICMP, PASSIVE, ANY.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of Monitor to retrieve.
    id String
    The ID of Monitor to retrieve.
    type String
    Type of Monitor to retrieve, one of HTTP, HTTPS, TCP, UDP, ICMP, PASSIVE, ANY.

    getPolicyLbMonitor 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.
    Type string
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Type string
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    type String
    description string
    The description of the resource.
    displayName string
    id string
    path string
    The NSX path of the policy resource.
    type string
    description str
    The description of the resource.
    display_name str
    id str
    path str
    The NSX path of the policy resource.
    type str
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    type 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.8.1 published on Wednesday, Apr 30, 2025 by vmware