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

nsxt.PolicyLbHttpMonitorProfile

Explore with Pulumi AI

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

    Create PolicyLbHttpMonitorProfile Resource

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

    Constructor syntax

    new PolicyLbHttpMonitorProfile(name: string, args: PolicyLbHttpMonitorProfileArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyLbHttpMonitorProfile(resource_name: str,
                                   args: PolicyLbHttpMonitorProfileArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyLbHttpMonitorProfile(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   display_name: Optional[str] = None,
                                   request_headers: Optional[Sequence[PolicyLbHttpMonitorProfileRequestHeaderArgs]] = None,
                                   request_url: Optional[str] = None,
                                   interval: Optional[float] = None,
                                   monitor_port: Optional[float] = None,
                                   nsx_id: Optional[str] = None,
                                   policy_lb_http_monitor_profile_id: Optional[str] = None,
                                   fall_count: Optional[float] = None,
                                   request_body: Optional[str] = None,
                                   request_method: Optional[str] = None,
                                   description: Optional[str] = None,
                                   request_version: Optional[str] = None,
                                   response_body: Optional[str] = None,
                                   response_status_codes: Optional[Sequence[float]] = None,
                                   rise_count: Optional[float] = None,
                                   tags: Optional[Sequence[PolicyLbHttpMonitorProfileTagArgs]] = None,
                                   timeout: Optional[float] = None)
    func NewPolicyLbHttpMonitorProfile(ctx *Context, name string, args PolicyLbHttpMonitorProfileArgs, opts ...ResourceOption) (*PolicyLbHttpMonitorProfile, error)
    public PolicyLbHttpMonitorProfile(string name, PolicyLbHttpMonitorProfileArgs args, CustomResourceOptions? opts = null)
    public PolicyLbHttpMonitorProfile(String name, PolicyLbHttpMonitorProfileArgs args)
    public PolicyLbHttpMonitorProfile(String name, PolicyLbHttpMonitorProfileArgs args, CustomResourceOptions options)
    
    type: nsxt:PolicyLbHttpMonitorProfile
    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 PolicyLbHttpMonitorProfileArgs
    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 PolicyLbHttpMonitorProfileArgs
    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 PolicyLbHttpMonitorProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyLbHttpMonitorProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyLbHttpMonitorProfileArgs
    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 policyLbHttpMonitorProfileResource = new Nsxt.PolicyLbHttpMonitorProfile("policyLbHttpMonitorProfileResource", new()
    {
        DisplayName = "string",
        RequestHeaders = new[]
        {
            new Nsxt.Inputs.PolicyLbHttpMonitorProfileRequestHeaderArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        RequestUrl = "string",
        Interval = 0,
        MonitorPort = 0,
        NsxId = "string",
        PolicyLbHttpMonitorProfileId = "string",
        FallCount = 0,
        RequestBody = "string",
        RequestMethod = "string",
        Description = "string",
        RequestVersion = "string",
        ResponseBody = "string",
        ResponseStatusCodes = new[]
        {
            0,
        },
        RiseCount = 0,
        Tags = new[]
        {
            new Nsxt.Inputs.PolicyLbHttpMonitorProfileTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
        Timeout = 0,
    });
    
    example, err := nsxt.NewPolicyLbHttpMonitorProfile(ctx, "policyLbHttpMonitorProfileResource", &nsxt.PolicyLbHttpMonitorProfileArgs{
    	DisplayName: pulumi.String("string"),
    	RequestHeaders: nsxt.PolicyLbHttpMonitorProfileRequestHeaderArray{
    		&nsxt.PolicyLbHttpMonitorProfileRequestHeaderArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	RequestUrl:                   pulumi.String("string"),
    	Interval:                     pulumi.Float64(0),
    	MonitorPort:                  pulumi.Float64(0),
    	NsxId:                        pulumi.String("string"),
    	PolicyLbHttpMonitorProfileId: pulumi.String("string"),
    	FallCount:                    pulumi.Float64(0),
    	RequestBody:                  pulumi.String("string"),
    	RequestMethod:                pulumi.String("string"),
    	Description:                  pulumi.String("string"),
    	RequestVersion:               pulumi.String("string"),
    	ResponseBody:                 pulumi.String("string"),
    	ResponseStatusCodes: pulumi.Float64Array{
    		pulumi.Float64(0),
    	},
    	RiseCount: pulumi.Float64(0),
    	Tags: nsxt.PolicyLbHttpMonitorProfileTagArray{
    		&nsxt.PolicyLbHttpMonitorProfileTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    	Timeout: pulumi.Float64(0),
    })
    
    var policyLbHttpMonitorProfileResource = new PolicyLbHttpMonitorProfile("policyLbHttpMonitorProfileResource", PolicyLbHttpMonitorProfileArgs.builder()
        .displayName("string")
        .requestHeaders(PolicyLbHttpMonitorProfileRequestHeaderArgs.builder()
            .name("string")
            .value("string")
            .build())
        .requestUrl("string")
        .interval(0)
        .monitorPort(0)
        .nsxId("string")
        .policyLbHttpMonitorProfileId("string")
        .fallCount(0)
        .requestBody("string")
        .requestMethod("string")
        .description("string")
        .requestVersion("string")
        .responseBody("string")
        .responseStatusCodes(0)
        .riseCount(0)
        .tags(PolicyLbHttpMonitorProfileTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .timeout(0)
        .build());
    
    policy_lb_http_monitor_profile_resource = nsxt.PolicyLbHttpMonitorProfile("policyLbHttpMonitorProfileResource",
        display_name="string",
        request_headers=[{
            "name": "string",
            "value": "string",
        }],
        request_url="string",
        interval=0,
        monitor_port=0,
        nsx_id="string",
        policy_lb_http_monitor_profile_id="string",
        fall_count=0,
        request_body="string",
        request_method="string",
        description="string",
        request_version="string",
        response_body="string",
        response_status_codes=[0],
        rise_count=0,
        tags=[{
            "scope": "string",
            "tag": "string",
        }],
        timeout=0)
    
    const policyLbHttpMonitorProfileResource = new nsxt.PolicyLbHttpMonitorProfile("policyLbHttpMonitorProfileResource", {
        displayName: "string",
        requestHeaders: [{
            name: "string",
            value: "string",
        }],
        requestUrl: "string",
        interval: 0,
        monitorPort: 0,
        nsxId: "string",
        policyLbHttpMonitorProfileId: "string",
        fallCount: 0,
        requestBody: "string",
        requestMethod: "string",
        description: "string",
        requestVersion: "string",
        responseBody: "string",
        responseStatusCodes: [0],
        riseCount: 0,
        tags: [{
            scope: "string",
            tag: "string",
        }],
        timeout: 0,
    });
    
    type: nsxt:PolicyLbHttpMonitorProfile
    properties:
        description: string
        displayName: string
        fallCount: 0
        interval: 0
        monitorPort: 0
        nsxId: string
        policyLbHttpMonitorProfileId: string
        requestBody: string
        requestHeaders:
            - name: string
              value: string
        requestMethod: string
        requestUrl: string
        requestVersion: string
        responseBody: string
        responseStatusCodes:
            - 0
        riseCount: 0
        tags:
            - scope: string
              tag: string
        timeout: 0
    

    PolicyLbHttpMonitorProfile 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 PolicyLbHttpMonitorProfile resource accepts the following input properties:

    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    FallCount double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    MonitorPort double
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbHttpMonitorProfileId string
    ID of the resource.
    RequestBody string
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders List<PolicyLbHttpMonitorProfileRequestHeader>
    Array of HTTP request headers.
    RequestMethod string
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    RequestUrl string
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    RequestVersion string
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    ResponseBody string
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    ResponseStatusCodes List<double>
    The HTTP response status code should be a valid HTTP status code.
    RiseCount double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags List<PolicyLbHttpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    FallCount float64
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval float64
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    MonitorPort float64
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbHttpMonitorProfileId string
    ID of the resource.
    RequestBody string
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders []PolicyLbHttpMonitorProfileRequestHeaderArgs
    Array of HTTP request headers.
    RequestMethod string
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    RequestUrl string
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    RequestVersion string
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    ResponseBody string
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    ResponseStatusCodes []float64
    The HTTP response status code should be a valid HTTP status code.
    RiseCount float64
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags []PolicyLbHttpMonitorProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    fallCount Double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitorPort Double
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbHttpMonitorProfileId String
    ID of the resource.
    requestBody String
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<PolicyLbHttpMonitorProfileRequestHeader>
    Array of HTTP request headers.
    requestMethod String
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    requestUrl String
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    requestVersion String
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    responseBody String
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    responseStatusCodes List<Double>
    The HTTP response status code should be a valid HTTP status code.
    riseCount Double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<PolicyLbHttpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    displayName string
    Display name of the resource.
    description string
    Description of the resource.
    fallCount number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitorPort number
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbHttpMonitorProfileId string
    ID of the resource.
    requestBody string
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders PolicyLbHttpMonitorProfileRequestHeader[]
    Array of HTTP request headers.
    requestMethod string
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    requestUrl string
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    requestVersion string
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    responseBody string
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    responseStatusCodes number[]
    The HTTP response status code should be a valid HTTP status code.
    riseCount number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags PolicyLbHttpMonitorProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    display_name str
    Display name of the resource.
    description str
    Description of the resource.
    fall_count float
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval float
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitor_port float
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_lb_http_monitor_profile_id str
    ID of the resource.
    request_body str
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    request_headers Sequence[PolicyLbHttpMonitorProfileRequestHeaderArgs]
    Array of HTTP request headers.
    request_method str
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    request_url str
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    request_version str
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    response_body str
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    response_status_codes Sequence[float]
    The HTTP response status code should be a valid HTTP status code.
    rise_count float
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags Sequence[PolicyLbHttpMonitorProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    fallCount Number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitorPort Number
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbHttpMonitorProfileId String
    ID of the resource.
    requestBody String
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<Property Map>
    Array of HTTP request headers.
    requestMethod String
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    requestUrl String
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    requestVersion String
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    responseBody String
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    responseStatusCodes List<Number>
    The HTTP response status code should be a valid HTTP status code.
    riseCount Number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyLbHttpMonitorProfile 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 PolicyLbHttpMonitorProfile Resource

    Get an existing PolicyLbHttpMonitorProfile 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?: PolicyLbHttpMonitorProfileState, opts?: CustomResourceOptions): PolicyLbHttpMonitorProfile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            fall_count: Optional[float] = None,
            interval: Optional[float] = None,
            monitor_port: Optional[float] = None,
            nsx_id: Optional[str] = None,
            path: Optional[str] = None,
            policy_lb_http_monitor_profile_id: Optional[str] = None,
            request_body: Optional[str] = None,
            request_headers: Optional[Sequence[PolicyLbHttpMonitorProfileRequestHeaderArgs]] = None,
            request_method: Optional[str] = None,
            request_url: Optional[str] = None,
            request_version: Optional[str] = None,
            response_body: Optional[str] = None,
            response_status_codes: Optional[Sequence[float]] = None,
            revision: Optional[float] = None,
            rise_count: Optional[float] = None,
            tags: Optional[Sequence[PolicyLbHttpMonitorProfileTagArgs]] = None,
            timeout: Optional[float] = None) -> PolicyLbHttpMonitorProfile
    func GetPolicyLbHttpMonitorProfile(ctx *Context, name string, id IDInput, state *PolicyLbHttpMonitorProfileState, opts ...ResourceOption) (*PolicyLbHttpMonitorProfile, error)
    public static PolicyLbHttpMonitorProfile Get(string name, Input<string> id, PolicyLbHttpMonitorProfileState? state, CustomResourceOptions? opts = null)
    public static PolicyLbHttpMonitorProfile get(String name, Output<String> id, PolicyLbHttpMonitorProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyLbHttpMonitorProfile    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.
    FallCount double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    MonitorPort double
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    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.
    PolicyLbHttpMonitorProfileId string
    ID of the resource.
    RequestBody string
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders List<PolicyLbHttpMonitorProfileRequestHeader>
    Array of HTTP request headers.
    RequestMethod string
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    RequestUrl string
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    RequestVersion string
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    ResponseBody string
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    ResponseStatusCodes List<double>
    The HTTP response status code should be a valid HTTP status code.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RiseCount double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags List<PolicyLbHttpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    FallCount float64
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval float64
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    MonitorPort float64
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    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.
    PolicyLbHttpMonitorProfileId string
    ID of the resource.
    RequestBody string
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders []PolicyLbHttpMonitorProfileRequestHeaderArgs
    Array of HTTP request headers.
    RequestMethod string
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    RequestUrl string
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    RequestVersion string
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    ResponseBody string
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    ResponseStatusCodes []float64
    The HTTP response status code should be a valid HTTP status code.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RiseCount float64
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags []PolicyLbHttpMonitorProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    fallCount Double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitorPort Double
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    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.
    policyLbHttpMonitorProfileId String
    ID of the resource.
    requestBody String
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<PolicyLbHttpMonitorProfileRequestHeader>
    Array of HTTP request headers.
    requestMethod String
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    requestUrl String
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    requestVersion String
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    responseBody String
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    responseStatusCodes List<Double>
    The HTTP response status code should be a valid HTTP status code.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    riseCount Double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<PolicyLbHttpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    fallCount number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitorPort number
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    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.
    policyLbHttpMonitorProfileId string
    ID of the resource.
    requestBody string
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders PolicyLbHttpMonitorProfileRequestHeader[]
    Array of HTTP request headers.
    requestMethod string
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    requestUrl string
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    requestVersion string
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    responseBody string
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    responseStatusCodes number[]
    The HTTP response status code should be a valid HTTP status code.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    riseCount number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags PolicyLbHttpMonitorProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    fall_count float
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval float
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitor_port float
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    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_http_monitor_profile_id str
    ID of the resource.
    request_body str
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    request_headers Sequence[PolicyLbHttpMonitorProfileRequestHeaderArgs]
    Array of HTTP request headers.
    request_method str
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    request_url str
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    request_version str
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    response_body str
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    response_status_codes Sequence[float]
    The HTTP response status code should be a valid HTTP status code.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    rise_count float
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags Sequence[PolicyLbHttpMonitorProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    fallCount Number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    monitorPort Number
    Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.
    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.
    policyLbHttpMonitorProfileId String
    ID of the resource.
    requestBody String
    String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<Property Map>
    Array of HTTP request headers.
    requestMethod String
    Possible values are: GET, OPTIONS, POST, HEAD, PUT.
    requestUrl String
    For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
    requestVersion String
    Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP request version.
    responseBody String
    If HTTP response body match string (regular expressions not supported) is specified then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
    responseStatusCodes List<Number>
    The HTTP response status code should be a valid HTTP status code.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    riseCount Number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

    Supporting Types

    PolicyLbHttpMonitorProfileRequestHeader, PolicyLbHttpMonitorProfileRequestHeaderArgs

    Name string
    Header name
    Value string
    Header value
    Name string
    Header name
    Value string
    Header value
    name String
    Header name
    value String
    Header value
    name string
    Header name
    value string
    Header value
    name str
    Header name
    value str
    Header value
    name String
    Header name
    value String
    Header value

    PolicyLbHttpMonitorProfileTag, PolicyLbHttpMonitorProfileTagArgs

    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