Probe

Manages a LoadBalancer Probe Resource.

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

Create a Probe Resource

new Probe(name: string, args: ProbeArgs, opts?: CustomResourceOptions);

def Probe(resource_name, opts=None, interval_in_seconds=None, loadbalancer_id=None, name=None, number_of_probes=None, port=None, protocol=None, request_path=None, resource_group_name=None, __props__=None);

func NewProbe(ctx *Context, name string, args ProbeArgs, opts ...ResourceOption) (*Probe, error)

public Probe(string name, ProbeArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Probe Resource Properties

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

Inputs

The Probe resource accepts the following input properties:

LoadbalancerId string: The ID of the LoadBalancer in which to create the NAT Rule.
Port int: Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
ResourceGroupName string: The name of the resource group in which to create the resource.
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.
NumberOfProbes int: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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.
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.
RequestPath string: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

LoadbalancerId string: The ID of the LoadBalancer in which to create the NAT Rule.
Port int: Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
ResourceGroupName string: The name of the resource group in which to create the resource.
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.
NumberOfProbes int: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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.
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.
RequestPath string: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

loadbalancerId string: The ID of the LoadBalancer in which to create the NAT Rule.
port number: Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
resourceGroupName string: The name of the resource group in which to create the resource.
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.
numberOfProbes number: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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.
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.
requestPath string: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

loadbalancer_id str: The ID of the LoadBalancer in which to create the NAT Rule.
port float: Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
resource_group_name str: The name of the resource group in which to create the resource.
interval_in_seconds float: 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.
number_of_probes float: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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.
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.
request_path str: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. 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 string[]

id str: The provider-assigned unique ID for this managed resource.
load_balancer_rules List[str]

Look up an 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

static get(resource_name, id, opts=None, interval_in_seconds=None, load_balancer_rules=None, loadbalancer_id=None, name=None, number_of_probes=None, port=None, protocol=None, request_path=None, resource_group_name=None, __props__=None);

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)

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.

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 NAT Rule.
Name string: Specifies the name of the Probe.
NumberOfProbes int: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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.
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.
RequestPath string: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.
ResourceGroupName string: The name of the resource group in which to create the resource.

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 NAT Rule.
Name string: Specifies the name of the Probe.
NumberOfProbes int: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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.
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.
RequestPath string: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.
ResourceGroupName string: The name of the resource group in which to create the resource.

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 NAT Rule.
name string: Specifies the name of the Probe.
numberOfProbes number: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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.
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.
requestPath string: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.
resourceGroupName string: The name of the resource group in which to create the resource.

interval_in_seconds float: 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 List[str]
loadbalancer_id str: The ID of the LoadBalancer in which to create the NAT Rule.
name str: Specifies the name of the Probe.
number_of_probes float: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 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 float: Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
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.
request_path str: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.
resource_group_name str: The name of the resource group in which to create the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud