Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyLbHttpsMonitorProfile
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyLbHttpsMonitorProfile

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyLbHttpsMonitorProfile Resource

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

    Constructor syntax

    new PolicyLbHttpsMonitorProfile(name: string, args: PolicyLbHttpsMonitorProfileArgs, opts?: CustomResourceOptions);
    @overload
def PolicyLbHttpsMonitorProfile(resource_name: str,
                                args: PolicyLbHttpsMonitorProfileArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def PolicyLbHttpsMonitorProfile(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                display_name: Optional[str] = None,
                                request_headers: Optional[Sequence[PolicyLbHttpsMonitorProfileRequestHeaderArgs]] = None,
                                request_url: Optional[str] = None,
                                interval: Optional[float] = None,
                                monitor_port: Optional[float] = None,
                                nsx_id: Optional[str] = None,
                                policy_lb_https_monitor_profile_id: Optional[str] = None,
                                request_body: Optional[str] = None,
                                description: Optional[str] = None,
                                fall_count: Optional[float] = None,
                                request_version: Optional[str] = None,
                                request_method: Optional[str] = None,
                                response_body: Optional[str] = None,
                                response_status_codes: Optional[Sequence[float]] = None,
                                rise_count: Optional[float] = None,
                                server_ssl: Optional[PolicyLbHttpsMonitorProfileServerSslArgs] = None,
                                tags: Optional[Sequence[PolicyLbHttpsMonitorProfileTagArgs]] = None,
                                timeout: Optional[float] = None)
    func NewPolicyLbHttpsMonitorProfile(ctx *Context, name string, args PolicyLbHttpsMonitorProfileArgs, opts ...ResourceOption) (*PolicyLbHttpsMonitorProfile, error)
    public PolicyLbHttpsMonitorProfile(string name, PolicyLbHttpsMonitorProfileArgs args, CustomResourceOptions? opts = null)
    public PolicyLbHttpsMonitorProfile(String name, PolicyLbHttpsMonitorProfileArgs args)
public PolicyLbHttpsMonitorProfile(String name, PolicyLbHttpsMonitorProfileArgs args, CustomResourceOptions options)

    type: nsxt:PolicyLbHttpsMonitorProfile
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 PolicyLbHttpsMonitorProfileArgs
    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 PolicyLbHttpsMonitorProfileArgs
    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 PolicyLbHttpsMonitorProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyLbHttpsMonitorProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyLbHttpsMonitorProfileArgs
    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 policyLbHttpsMonitorProfileResource = new Nsxt.PolicyLbHttpsMonitorProfile("policyLbHttpsMonitorProfileResource", new()
{
    DisplayName = "string",
    RequestHeaders = new[]
    {
        new Nsxt.Inputs.PolicyLbHttpsMonitorProfileRequestHeaderArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    RequestUrl = "string",
    Interval = 0,
    MonitorPort = 0,
    NsxId = "string",
    PolicyLbHttpsMonitorProfileId = "string",
    RequestBody = "string",
    Description = "string",
    FallCount = 0,
    RequestVersion = "string",
    RequestMethod = "string",
    ResponseBody = "string",
    ResponseStatusCodes = new[]
    {
        0,
    },
    RiseCount = 0,
    ServerSsl = new Nsxt.Inputs.PolicyLbHttpsMonitorProfileServerSslArgs
    {
        CertificateChainDepth = 0,
        ClientCertificatePath = "string",
        ServerAuth = "string",
        ServerAuthCaPaths = new[]
        {
            "string",
        },
        ServerAuthCrlPaths = new[]
        {
            "string",
        },
        SslProfilePath = "string",
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyLbHttpsMonitorProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Timeout = 0,
});

    example, err := nsxt.NewPolicyLbHttpsMonitorProfile(ctx, "policyLbHttpsMonitorProfileResource", &nsxt.PolicyLbHttpsMonitorProfileArgs{
	DisplayName: pulumi.String("string"),
	RequestHeaders: nsxt.PolicyLbHttpsMonitorProfileRequestHeaderArray{
		&nsxt.PolicyLbHttpsMonitorProfileRequestHeaderArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	RequestUrl:                    pulumi.String("string"),
	Interval:                      pulumi.Float64(0),
	MonitorPort:                   pulumi.Float64(0),
	NsxId:                         pulumi.String("string"),
	PolicyLbHttpsMonitorProfileId: pulumi.String("string"),
	RequestBody:                   pulumi.String("string"),
	Description:                   pulumi.String("string"),
	FallCount:                     pulumi.Float64(0),
	RequestVersion:                pulumi.String("string"),
	RequestMethod:                 pulumi.String("string"),
	ResponseBody:                  pulumi.String("string"),
	ResponseStatusCodes: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	RiseCount: pulumi.Float64(0),
	ServerSsl: &nsxt.PolicyLbHttpsMonitorProfileServerSslArgs{
		CertificateChainDepth: pulumi.Float64(0),
		ClientCertificatePath: pulumi.String("string"),
		ServerAuth:            pulumi.String("string"),
		ServerAuthCaPaths: pulumi.StringArray{
			pulumi.String("string"),
		},
		ServerAuthCrlPaths: pulumi.StringArray{
			pulumi.String("string"),
		},
		SslProfilePath: pulumi.String("string"),
	},
	Tags: nsxt.PolicyLbHttpsMonitorProfileTagArray{
		&nsxt.PolicyLbHttpsMonitorProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Timeout: pulumi.Float64(0),
})

    var policyLbHttpsMonitorProfileResource = new PolicyLbHttpsMonitorProfile("policyLbHttpsMonitorProfileResource", PolicyLbHttpsMonitorProfileArgs.builder()
    .displayName("string")
    .requestHeaders(PolicyLbHttpsMonitorProfileRequestHeaderArgs.builder()
        .name("string")
        .value("string")
        .build())
    .requestUrl("string")
    .interval(0)
    .monitorPort(0)
    .nsxId("string")
    .policyLbHttpsMonitorProfileId("string")
    .requestBody("string")
    .description("string")
    .fallCount(0)
    .requestVersion("string")
    .requestMethod("string")
    .responseBody("string")
    .responseStatusCodes(0)
    .riseCount(0)
    .serverSsl(PolicyLbHttpsMonitorProfileServerSslArgs.builder()
        .certificateChainDepth(0)
        .clientCertificatePath("string")
        .serverAuth("string")
        .serverAuthCaPaths("string")
        .serverAuthCrlPaths("string")
        .sslProfilePath("string")
        .build())
    .tags(PolicyLbHttpsMonitorProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .timeout(0)
    .build());

    policy_lb_https_monitor_profile_resource = nsxt.PolicyLbHttpsMonitorProfile("policyLbHttpsMonitorProfileResource",
    display_name="string",
    request_headers=[{
        "name": "string",
        "value": "string",
    }],
    request_url="string",
    interval=0,
    monitor_port=0,
    nsx_id="string",
    policy_lb_https_monitor_profile_id="string",
    request_body="string",
    description="string",
    fall_count=0,
    request_version="string",
    request_method="string",
    response_body="string",
    response_status_codes=[0],
    rise_count=0,
    server_ssl={
        "certificate_chain_depth": 0,
        "client_certificate_path": "string",
        "server_auth": "string",
        "server_auth_ca_paths": ["string"],
        "server_auth_crl_paths": ["string"],
        "ssl_profile_path": "string",
    },
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    timeout=0)

    const policyLbHttpsMonitorProfileResource = new nsxt.PolicyLbHttpsMonitorProfile("policyLbHttpsMonitorProfileResource", {
    displayName: "string",
    requestHeaders: [{
        name: "string",
        value: "string",
    }],
    requestUrl: "string",
    interval: 0,
    monitorPort: 0,
    nsxId: "string",
    policyLbHttpsMonitorProfileId: "string",
    requestBody: "string",
    description: "string",
    fallCount: 0,
    requestVersion: "string",
    requestMethod: "string",
    responseBody: "string",
    responseStatusCodes: [0],
    riseCount: 0,
    serverSsl: {
        certificateChainDepth: 0,
        clientCertificatePath: "string",
        serverAuth: "string",
        serverAuthCaPaths: ["string"],
        serverAuthCrlPaths: ["string"],
        sslProfilePath: "string",
    },
    tags: [{
        scope: "string",
        tag: "string",
    }],
    timeout: 0,
});

    type: nsxt:PolicyLbHttpsMonitorProfile
properties:
    description: string
    displayName: string
    fallCount: 0
    interval: 0
    monitorPort: 0
    nsxId: string
    policyLbHttpsMonitorProfileId: string
    requestBody: string
    requestHeaders:
        - name: string
          value: string
    requestMethod: string
    requestUrl: string
    requestVersion: string
    responseBody: string
    responseStatusCodes:
        - 0
    riseCount: 0
    serverSsl:
        certificateChainDepth: 0
        clientCertificatePath: string
        serverAuth: string
        serverAuthCaPaths:
            - string
        serverAuthCrlPaths:
            - string
        sslProfilePath: string
    tags:
        - scope: string
          tag: string
    timeout: 0

    PolicyLbHttpsMonitorProfile 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 PolicyLbHttpsMonitorProfile 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.
    PolicyLbHttpsMonitorProfileId 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<PolicyLbHttpsMonitorProfileRequestHeader>
    Array of HTTP request headers.
    RequestMethod string
    The health check method for HTTP monitor type.
    RequestUrl string
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    RequestVersion string
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    ServerSsl PolicyLbHttpsMonitorProfileServerSsl
    Tags List<PolicyLbHttpsMonitorProfileTag>
    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.
    PolicyLbHttpsMonitorProfileId 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 []PolicyLbHttpsMonitorProfileRequestHeaderArgs
    Array of HTTP request headers.
    RequestMethod string
    The health check method for HTTP monitor type.
    RequestUrl string
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    RequestVersion string
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    ServerSsl PolicyLbHttpsMonitorProfileServerSslArgs
    Tags []PolicyLbHttpsMonitorProfileTagArgs
    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.
    policyLbHttpsMonitorProfileId 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<PolicyLbHttpsMonitorProfileRequestHeader>
    Array of HTTP request headers.
    requestMethod String
    The health check method for HTTP monitor type.
    requestUrl String
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    requestVersion String
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    serverSsl PolicyLbHttpsMonitorProfileServerSsl
    tags List<PolicyLbHttpsMonitorProfileTag>
    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.
    policyLbHttpsMonitorProfileId 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 PolicyLbHttpsMonitorProfileRequestHeader[]
    Array of HTTP request headers.
    requestMethod string
    The health check method for HTTP monitor type.
    requestUrl string
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    requestVersion string
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    serverSsl PolicyLbHttpsMonitorProfileServerSsl
    tags PolicyLbHttpsMonitorProfileTag[]
    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_https_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[PolicyLbHttpsMonitorProfileRequestHeaderArgs]
    Array of HTTP request headers.
    request_method str
    The health check method for HTTP monitor type.
    request_url str
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    request_version str
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    server_ssl PolicyLbHttpsMonitorProfileServerSslArgs
    tags Sequence[PolicyLbHttpsMonitorProfileTagArgs]
    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.
    policyLbHttpsMonitorProfileId 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
    The health check method for HTTP monitor type.
    requestUrl String
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    requestVersion String
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    serverSsl Property Map
    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 PolicyLbHttpsMonitorProfile 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 PolicyLbHttpsMonitorProfile Resource

    Get an existing PolicyLbHttpsMonitorProfile 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?: PolicyLbHttpsMonitorProfileState, opts?: CustomResourceOptions): PolicyLbHttpsMonitorProfile
    @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_https_monitor_profile_id: Optional[str] = None,
        request_body: Optional[str] = None,
        request_headers: Optional[Sequence[PolicyLbHttpsMonitorProfileRequestHeaderArgs]] = 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,
        server_ssl: Optional[PolicyLbHttpsMonitorProfileServerSslArgs] = None,
        tags: Optional[Sequence[PolicyLbHttpsMonitorProfileTagArgs]] = None,
        timeout: Optional[float] = None) -> PolicyLbHttpsMonitorProfile
    func GetPolicyLbHttpsMonitorProfile(ctx *Context, name string, id IDInput, state *PolicyLbHttpsMonitorProfileState, opts ...ResourceOption) (*PolicyLbHttpsMonitorProfile, error)
    public static PolicyLbHttpsMonitorProfile Get(string name, Input<string> id, PolicyLbHttpsMonitorProfileState? state, CustomResourceOptions? opts = null)
    public static PolicyLbHttpsMonitorProfile get(String name, Output<String> id, PolicyLbHttpsMonitorProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyLbHttpsMonitorProfile    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.
    PolicyLbHttpsMonitorProfileId 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<PolicyLbHttpsMonitorProfileRequestHeader>
    Array of HTTP request headers.
    RequestMethod string
    The health check method for HTTP monitor type.
    RequestUrl string
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    RequestVersion string
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    ServerSsl PolicyLbHttpsMonitorProfileServerSsl
    Tags List<PolicyLbHttpsMonitorProfileTag>
    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.
    PolicyLbHttpsMonitorProfileId 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 []PolicyLbHttpsMonitorProfileRequestHeaderArgs
    Array of HTTP request headers.
    RequestMethod string
    The health check method for HTTP monitor type.
    RequestUrl string
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    RequestVersion string
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    ServerSsl PolicyLbHttpsMonitorProfileServerSslArgs
    Tags []PolicyLbHttpsMonitorProfileTagArgs
    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.
    policyLbHttpsMonitorProfileId 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<PolicyLbHttpsMonitorProfileRequestHeader>
    Array of HTTP request headers.
    requestMethod String
    The health check method for HTTP monitor type.
    requestUrl String
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    requestVersion String
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    serverSsl PolicyLbHttpsMonitorProfileServerSsl
    tags List<PolicyLbHttpsMonitorProfileTag>
    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.
    policyLbHttpsMonitorProfileId 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 PolicyLbHttpsMonitorProfileRequestHeader[]
    Array of HTTP request headers.
    requestMethod string
    The health check method for HTTP monitor type.
    requestUrl string
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    requestVersion string
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    serverSsl PolicyLbHttpsMonitorProfileServerSsl
    tags PolicyLbHttpsMonitorProfileTag[]
    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_https_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[PolicyLbHttpsMonitorProfileRequestHeaderArgs]
    Array of HTTP request headers.
    request_method str
    The health check method for HTTP monitor type.
    request_url str
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    request_version str
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    server_ssl PolicyLbHttpsMonitorProfileServerSslArgs
    tags Sequence[PolicyLbHttpsMonitorProfileTagArgs]
    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.
    policyLbHttpsMonitorProfileId 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
    The health check method for HTTP monitor type.
    requestUrl String
    For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
    requestVersion String
    HTTP request version. Possible values are: HTTP_VERSION_1_0, HTTP_VERSION_1_1.
    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.
    serverSsl Property Map
    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

    PolicyLbHttpsMonitorProfileRequestHeader, PolicyLbHttpsMonitorProfileRequestHeaderArgs

    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

    PolicyLbHttpsMonitorProfileServerSsl, PolicyLbHttpsMonitorProfileServerSslArgs

    CertificateChainDepth double
    Authentication depth is used to set the verification depth in the server certificates chain.
    ClientCertificatePath string
    To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding
    ServerAuth string
    Server authentication mode. Possible values are: REQUIRED, IGNORE, AUTO_APPLY.
    ServerAuthCaPaths List<string>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    ServerAuthCrlPaths List<string>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    SslProfilePath string
    Server SSL profile defines reusable, application-independent server side SSL properties.
    CertificateChainDepth float64
    Authentication depth is used to set the verification depth in the server certificates chain.
    ClientCertificatePath string
    To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding
    ServerAuth string
    Server authentication mode. Possible values are: REQUIRED, IGNORE, AUTO_APPLY.
    ServerAuthCaPaths []string
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    ServerAuthCrlPaths []string
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    SslProfilePath string
    Server SSL profile defines reusable, application-independent server side SSL properties.
    certificateChainDepth Double
    Authentication depth is used to set the verification depth in the server certificates chain.
    clientCertificatePath String
    To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding
    serverAuth String
    Server authentication mode. Possible values are: REQUIRED, IGNORE, AUTO_APPLY.
    serverAuthCaPaths List<String>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlPaths List<String>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    sslProfilePath String
    Server SSL profile defines reusable, application-independent server side SSL properties.
    certificateChainDepth number
    Authentication depth is used to set the verification depth in the server certificates chain.
    clientCertificatePath string
    To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding
    serverAuth string
    Server authentication mode. Possible values are: REQUIRED, IGNORE, AUTO_APPLY.
    serverAuthCaPaths string[]
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlPaths string[]
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    sslProfilePath string
    Server SSL profile defines reusable, application-independent server side SSL properties.
    certificate_chain_depth float
    Authentication depth is used to set the verification depth in the server certificates chain.
    client_certificate_path str
    To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding
    server_auth str
    Server authentication mode. Possible values are: REQUIRED, IGNORE, AUTO_APPLY.
    server_auth_ca_paths Sequence[str]
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    server_auth_crl_paths Sequence[str]
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    ssl_profile_path str
    Server SSL profile defines reusable, application-independent server side SSL properties.
    certificateChainDepth Number
    Authentication depth is used to set the verification depth in the server certificates chain.
    clientCertificatePath String
    To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding
    serverAuth String
    Server authentication mode. Possible values are: REQUIRED, IGNORE, AUTO_APPLY.
    serverAuthCaPaths List<String>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlPaths List<String>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    sslProfilePath String
    Server SSL profile defines reusable, application-independent server side SSL properties.

    PolicyLbHttpsMonitorProfileTag, PolicyLbHttpsMonitorProfileTagArgs

    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
    vmware/terraform-provider-nsxt