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

nsxt.PolicyLbPassiveMonitorProfile

Explore with Pulumi AI

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

    Create PolicyLbPassiveMonitorProfile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PolicyLbPassiveMonitorProfile(name: string, args: PolicyLbPassiveMonitorProfileArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyLbPassiveMonitorProfile(resource_name: str,
                                      args: PolicyLbPassiveMonitorProfileArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyLbPassiveMonitorProfile(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      display_name: Optional[str] = None,
                                      description: Optional[str] = None,
                                      max_fails: Optional[float] = None,
                                      nsx_id: Optional[str] = None,
                                      policy_lb_passive_monitor_profile_id: Optional[str] = None,
                                      tags: Optional[Sequence[PolicyLbPassiveMonitorProfileTagArgs]] = None,
                                      timeout: Optional[float] = None)
    func NewPolicyLbPassiveMonitorProfile(ctx *Context, name string, args PolicyLbPassiveMonitorProfileArgs, opts ...ResourceOption) (*PolicyLbPassiveMonitorProfile, error)
    public PolicyLbPassiveMonitorProfile(string name, PolicyLbPassiveMonitorProfileArgs args, CustomResourceOptions? opts = null)
    public PolicyLbPassiveMonitorProfile(String name, PolicyLbPassiveMonitorProfileArgs args)
    public PolicyLbPassiveMonitorProfile(String name, PolicyLbPassiveMonitorProfileArgs args, CustomResourceOptions options)
    
    type: nsxt:PolicyLbPassiveMonitorProfile
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PolicyLbPassiveMonitorProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PolicyLbPassiveMonitorProfileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PolicyLbPassiveMonitorProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyLbPassiveMonitorProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyLbPassiveMonitorProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var policyLbPassiveMonitorProfileResource = new Nsxt.PolicyLbPassiveMonitorProfile("policyLbPassiveMonitorProfileResource", new()
    {
        DisplayName = "string",
        Description = "string",
        MaxFails = 0,
        NsxId = "string",
        PolicyLbPassiveMonitorProfileId = "string",
        Tags = new[]
        {
            new Nsxt.Inputs.PolicyLbPassiveMonitorProfileTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
        Timeout = 0,
    });
    
    example, err := nsxt.NewPolicyLbPassiveMonitorProfile(ctx, "policyLbPassiveMonitorProfileResource", &nsxt.PolicyLbPassiveMonitorProfileArgs{
    	DisplayName:                     pulumi.String("string"),
    	Description:                     pulumi.String("string"),
    	MaxFails:                        pulumi.Float64(0),
    	NsxId:                           pulumi.String("string"),
    	PolicyLbPassiveMonitorProfileId: pulumi.String("string"),
    	Tags: nsxt.PolicyLbPassiveMonitorProfileTagArray{
    		&nsxt.PolicyLbPassiveMonitorProfileTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    	Timeout: pulumi.Float64(0),
    })
    
    var policyLbPassiveMonitorProfileResource = new PolicyLbPassiveMonitorProfile("policyLbPassiveMonitorProfileResource", PolicyLbPassiveMonitorProfileArgs.builder()
        .displayName("string")
        .description("string")
        .maxFails(0)
        .nsxId("string")
        .policyLbPassiveMonitorProfileId("string")
        .tags(PolicyLbPassiveMonitorProfileTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .timeout(0)
        .build());
    
    policy_lb_passive_monitor_profile_resource = nsxt.PolicyLbPassiveMonitorProfile("policyLbPassiveMonitorProfileResource",
        display_name="string",
        description="string",
        max_fails=0,
        nsx_id="string",
        policy_lb_passive_monitor_profile_id="string",
        tags=[{
            "scope": "string",
            "tag": "string",
        }],
        timeout=0)
    
    const policyLbPassiveMonitorProfileResource = new nsxt.PolicyLbPassiveMonitorProfile("policyLbPassiveMonitorProfileResource", {
        displayName: "string",
        description: "string",
        maxFails: 0,
        nsxId: "string",
        policyLbPassiveMonitorProfileId: "string",
        tags: [{
            scope: "string",
            tag: "string",
        }],
        timeout: 0,
    });
    
    type: nsxt:PolicyLbPassiveMonitorProfile
    properties:
        description: string
        displayName: string
        maxFails: 0
        nsxId: string
        policyLbPassiveMonitorProfileId: string
        tags:
            - scope: string
              tag: string
        timeout: 0
    

    PolicyLbPassiveMonitorProfile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PolicyLbPassiveMonitorProfile resource accepts the following input properties:

    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    MaxFails double
    Number of consecutive failures before a member is considered temporarily unavailable.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbPassiveMonitorProfileId string
    ID of the resource.
    Tags List<PolicyLbPassiveMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    After this timeout period, the member is tried again for a new connection to see if it is available.
    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    MaxFails float64
    Number of consecutive failures before a member is considered temporarily unavailable.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbPassiveMonitorProfileId string
    ID of the resource.
    Tags []PolicyLbPassiveMonitorProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    After this timeout period, the member is tried again for a new connection to see if it is available.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    maxFails Double
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbPassiveMonitorProfileId String
    ID of the resource.
    tags List<PolicyLbPassiveMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    After this timeout period, the member is tried again for a new connection to see if it is available.
    displayName string
    Display name of the resource.
    description string
    Description of the resource.
    maxFails number
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbPassiveMonitorProfileId string
    ID of the resource.
    tags PolicyLbPassiveMonitorProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    After this timeout period, the member is tried again for a new connection to see if it is available.
    display_name str
    Display name of the resource.
    description str
    Description of the resource.
    max_fails float
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_lb_passive_monitor_profile_id str
    ID of the resource.
    tags Sequence[PolicyLbPassiveMonitorProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    After this timeout period, the member is tried again for a new connection to see if it is available.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    maxFails Number
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbPassiveMonitorProfileId String
    ID of the resource.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    After this timeout period, the member is tried again for a new connection to see if it is available.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyLbPassiveMonitorProfile resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyLbPassiveMonitorProfile Resource

    Get an existing PolicyLbPassiveMonitorProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PolicyLbPassiveMonitorProfileState, opts?: CustomResourceOptions): PolicyLbPassiveMonitorProfile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            max_fails: Optional[float] = None,
            nsx_id: Optional[str] = None,
            path: Optional[str] = None,
            policy_lb_passive_monitor_profile_id: Optional[str] = None,
            revision: Optional[float] = None,
            tags: Optional[Sequence[PolicyLbPassiveMonitorProfileTagArgs]] = None,
            timeout: Optional[float] = None) -> PolicyLbPassiveMonitorProfile
    func GetPolicyLbPassiveMonitorProfile(ctx *Context, name string, id IDInput, state *PolicyLbPassiveMonitorProfileState, opts ...ResourceOption) (*PolicyLbPassiveMonitorProfile, error)
    public static PolicyLbPassiveMonitorProfile Get(string name, Input<string> id, PolicyLbPassiveMonitorProfileState? state, CustomResourceOptions? opts = null)
    public static PolicyLbPassiveMonitorProfile get(String name, Output<String> id, PolicyLbPassiveMonitorProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyLbPassiveMonitorProfile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    MaxFails double
    Number of consecutive failures before a member is considered temporarily unavailable.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyLbPassiveMonitorProfileId string
    ID of the resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyLbPassiveMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    After this timeout period, the member is tried again for a new connection to see if it is available.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    MaxFails float64
    Number of consecutive failures before a member is considered temporarily unavailable.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyLbPassiveMonitorProfileId string
    ID of the resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyLbPassiveMonitorProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    After this timeout period, the member is tried again for a new connection to see if it is available.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    maxFails Double
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyLbPassiveMonitorProfileId String
    ID of the resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyLbPassiveMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    After this timeout period, the member is tried again for a new connection to see if it is available.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    maxFails number
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX path of the policy resource.
    policyLbPassiveMonitorProfileId string
    ID of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyLbPassiveMonitorProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    After this timeout period, the member is tried again for a new connection to see if it is available.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    max_fails float
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX path of the policy resource.
    policy_lb_passive_monitor_profile_id str
    ID of the resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyLbPassiveMonitorProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    After this timeout period, the member is tried again for a new connection to see if it is available.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    maxFails Number
    Number of consecutive failures before a member is considered temporarily unavailable.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyLbPassiveMonitorProfileId String
    ID of the resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    After this timeout period, the member is tried again for a new connection to see if it is available.

    Supporting Types

    PolicyLbPassiveMonitorProfileTag, PolicyLbPassiveMonitorProfileTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this 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.8.1 published on Wednesday, Apr 30, 2025 by vmware