Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. lb
  5. Probe

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.lb.Probe

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a LoadBalancer Probe Resource.

    NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "LoadBalancerRG",
    location: "West Europe",
});
const examplePublicIp = new azure.network.PublicIp("example", {
    name: "PublicIPForLB",
    location: example.location,
    resourceGroupName: example.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("example", {
    name: "TestLoadBalancer",
    location: example.location,
    resourceGroupName: example.name,
    frontendIpConfigurations: [{
        name: "PublicIPAddress",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleProbe = new azure.lb.Probe("example", {
    loadbalancerId: exampleLoadBalancer.id,
    name: "ssh-running-probe",
    port: 22,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="LoadBalancerRG",
    location="West Europe")
example_public_ip = azure.network.PublicIp("example",
    name="PublicIPForLB",
    location=example.location,
    resource_group_name=example.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("example",
    name="TestLoadBalancer",
    location=example.location,
    resource_group_name=example.name,
    frontend_ip_configurations=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_probe = azure.lb.Probe("example",
    loadbalancer_id=example_load_balancer.id,
    name="ssh-running-probe",
    port=22)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/lb"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("LoadBalancerRG"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		examplePublicIp, err := network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
			Name:              pulumi.String("PublicIPForLB"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			AllocationMethod:  pulumi.String("Static"),
		})
		if err != nil {
			return err
		}
		exampleLoadBalancer, err := lb.NewLoadBalancer(ctx, "example", &lb.LoadBalancerArgs{
			Name:              pulumi.String("TestLoadBalancer"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			FrontendIpConfigurations: lb.LoadBalancerFrontendIpConfigurationArray{
				&lb.LoadBalancerFrontendIpConfigurationArgs{
					Name:              pulumi.String("PublicIPAddress"),
					PublicIpAddressId: examplePublicIp.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = lb.NewProbe(ctx, "example", &lb.ProbeArgs{
			LoadbalancerId: exampleLoadBalancer.ID(),
			Name:           pulumi.String("ssh-running-probe"),
			Port:           pulumi.Int(22),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "LoadBalancerRG",
        Location = "West Europe",
    });

    var examplePublicIp = new Azure.Network.PublicIp("example", new()
    {
        Name = "PublicIPForLB",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AllocationMethod = "Static",
    });

    var exampleLoadBalancer = new Azure.Lb.LoadBalancer("example", new()
    {
        Name = "TestLoadBalancer",
        Location = example.Location,
        ResourceGroupName = example.Name,
        FrontendIpConfigurations = new[]
        {
            new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
            {
                Name = "PublicIPAddress",
                PublicIpAddressId = examplePublicIp.Id,
            },
        },
    });

    var exampleProbe = new Azure.Lb.Probe("example", new()
    {
        LoadbalancerId = exampleLoadBalancer.Id,
        Name = "ssh-running-probe",
        Port = 22,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.lb.LoadBalancer;
import com.pulumi.azure.lb.LoadBalancerArgs;
import com.pulumi.azure.lb.inputs.LoadBalancerFrontendIpConfigurationArgs;
import com.pulumi.azure.lb.Probe;
import com.pulumi.azure.lb.ProbeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("LoadBalancerRG")
            .location("West Europe")
            .build());

        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
            .name("PublicIPForLB")
            .location(example.location())
            .resourceGroupName(example.name())
            .allocationMethod("Static")
            .build());

        var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()
            .name("TestLoadBalancer")
            .location(example.location())
            .resourceGroupName(example.name())
            .frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
                .name("PublicIPAddress")
                .publicIpAddressId(examplePublicIp.id())
                .build())
            .build());

        var exampleProbe = new Probe("exampleProbe", ProbeArgs.builder()
            .loadbalancerId(exampleLoadBalancer.id())
            .name("ssh-running-probe")
            .port(22)
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: LoadBalancerRG
      location: West Europe
  examplePublicIp:
    type: azure:network:PublicIp
    name: example
    properties:
      name: PublicIPForLB
      location: ${example.location}
      resourceGroupName: ${example.name}
      allocationMethod: Static
  exampleLoadBalancer:
    type: azure:lb:LoadBalancer
    name: example
    properties:
      name: TestLoadBalancer
      location: ${example.location}
      resourceGroupName: ${example.name}
      frontendIpConfigurations:
        - name: PublicIPAddress
          publicIpAddressId: ${examplePublicIp.id}
  exampleProbe:
    type: azure:lb:Probe
    name: example
    properties:
      loadbalancerId: ${exampleLoadBalancer.id}
      name: ssh-running-probe
      port: 22

    Create Probe Resource

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

    Constructor syntax

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

@overload
def Probe(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          loadbalancer_id: Optional[str] = None,
          port: Optional[int] = None,
          interval_in_seconds: Optional[int] = None,
          name: Optional[str] = None,
          number_of_probes: Optional[int] = None,
          probe_threshold: Optional[int] = None,
          protocol: Optional[str] = None,
          request_path: Optional[str] = None)
    func NewProbe(ctx *Context, name string, args ProbeArgs, opts ...ResourceOption) (*Probe, error)
    public Probe(string name, ProbeArgs args, CustomResourceOptions? opts = null)
    public Probe(String name, ProbeArgs args)
public Probe(String name, ProbeArgs args, CustomResourceOptions options)

    type: azure:lb:Probe
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 ProbeArgs
    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 ProbeArgs
    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 ProbeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProbeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProbeArgs
    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 probeResource = new Azure.Lb.Probe("probeResource", new()
{
    LoadbalancerId = "string",
    Port = 0,
    IntervalInSeconds = 0,
    Name = "string",
    NumberOfProbes = 0,
    ProbeThreshold = 0,
    Protocol = "string",
    RequestPath = "string",
});

    example, err := lb.NewProbe(ctx, "probeResource", &lb.ProbeArgs{
	LoadbalancerId:    pulumi.String("string"),
	Port:              pulumi.Int(0),
	IntervalInSeconds: pulumi.Int(0),
	Name:              pulumi.String("string"),
	NumberOfProbes:    pulumi.Int(0),
	ProbeThreshold:    pulumi.Int(0),
	Protocol:          pulumi.String("string"),
	RequestPath:       pulumi.String("string"),
})

    var probeResource = new Probe("probeResource", ProbeArgs.builder()
    .loadbalancerId("string")
    .port(0)
    .intervalInSeconds(0)
    .name("string")
    .numberOfProbes(0)
    .probeThreshold(0)
    .protocol("string")
    .requestPath("string")
    .build());

    probe_resource = azure.lb.Probe("probeResource",
    loadbalancer_id="string",
    port=0,
    interval_in_seconds=0,
    name="string",
    number_of_probes=0,
    probe_threshold=0,
    protocol="string",
    request_path="string")

    const probeResource = new azure.lb.Probe("probeResource", {
    loadbalancerId: "string",
    port: 0,
    intervalInSeconds: 0,
    name: "string",
    numberOfProbes: 0,
    probeThreshold: 0,
    protocol: "string",
    requestPath: "string",
});

    type: azure:lb:Probe
properties:
    intervalInSeconds: 0
    loadbalancerId: string
    name: string
    numberOfProbes: 0
    port: 0
    probeThreshold: 0
    protocol: string
    requestPath: string

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

    LoadbalancerId string
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    Port int
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    IntervalInSeconds int
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    Name string
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    NumberOfProbes int
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    ProbeThreshold int
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    Protocol string
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    RequestPath string
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    LoadbalancerId string
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    Port int
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    IntervalInSeconds int
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    Name string
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    NumberOfProbes int
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    ProbeThreshold int
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    Protocol string
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    RequestPath string
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    loadbalancerId String
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    port Integer
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    intervalInSeconds Integer
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    name String
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    numberOfProbes Integer
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    probeThreshold Integer
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol String
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    requestPath String
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    loadbalancerId string
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    port number
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    intervalInSeconds number
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    name string
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    numberOfProbes number
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    probeThreshold number
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol string
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    requestPath string
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    loadbalancer_id str
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    port int
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    interval_in_seconds int
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    name str
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    number_of_probes int
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    probe_threshold int
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol str
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    request_path str
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    loadbalancerId String
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    port Number
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    intervalInSeconds Number
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    name String
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    numberOfProbes Number
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    probeThreshold Number
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol String
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    requestPath String
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerRules List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerRules []string
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerRules List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerRules string[]
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_rules Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerRules List<String>

    Look up Existing Probe Resource

    Get an existing Probe 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?: ProbeState, opts?: CustomResourceOptions): Probe
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        interval_in_seconds: Optional[int] = None,
        load_balancer_rules: Optional[Sequence[str]] = None,
        loadbalancer_id: Optional[str] = None,
        name: Optional[str] = None,
        number_of_probes: Optional[int] = None,
        port: Optional[int] = None,
        probe_threshold: Optional[int] = None,
        protocol: Optional[str] = None,
        request_path: Optional[str] = None) -> Probe
    func GetProbe(ctx *Context, name string, id IDInput, state *ProbeState, opts ...ResourceOption) (*Probe, error)
    public static Probe Get(string name, Input<string> id, ProbeState? state, CustomResourceOptions? opts = null)
    public static Probe get(String name, Output<String> id, ProbeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    IntervalInSeconds int
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    LoadBalancerRules List<string>
    LoadbalancerId string
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    NumberOfProbes int
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    Port int
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    ProbeThreshold int
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    Protocol string
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    RequestPath string
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    IntervalInSeconds int
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    LoadBalancerRules []string
    LoadbalancerId string
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    NumberOfProbes int
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    Port int
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    ProbeThreshold int
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    Protocol string
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    RequestPath string
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    intervalInSeconds Integer
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    loadBalancerRules List<String>
    loadbalancerId String
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    numberOfProbes Integer
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    port Integer
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    probeThreshold Integer
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol String
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    requestPath String
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    intervalInSeconds number
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    loadBalancerRules string[]
    loadbalancerId string
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    numberOfProbes number
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    port number
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    probeThreshold number
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol string
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    requestPath string
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    interval_in_seconds int
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    load_balancer_rules Sequence[str]
    loadbalancer_id str
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    number_of_probes int
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    port int
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    probe_threshold int
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol str
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    request_path str
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.
    intervalInSeconds Number
    The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
    loadBalancerRules List<String>
    loadbalancerId String
    The ID of the LoadBalancer in which to create the Probe. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Probe. Changing this forces a new resource to be created.
    numberOfProbes Number
    The number of failed probe attempts after which the backend endpoint is removed from rotation. Default to 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
    port Number
    Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
    probeThreshold Number
    The number of consecutive successful or failed probes that allow or deny traffic to this endpoint. Possible values range from 1 to 100. The default value is 1.
    protocol String
    Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 OK response from the specified URI is required for the probe to be successful. Defaults to Tcp.
    requestPath String
    The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http or Https. Otherwise, it is not allowed.

    Import

    Load Balancer Probes can be imported using the resource id, e.g.

    $ pulumi import azure:lb/probe:Probe example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure