Class Probe

Manages a LoadBalancer Probe Resource.

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

Inheritance

System.Object

Resource

CustomResource

Probe

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Lb

Assembly: Pulumi.Azure.dll

Syntax

public class Probe : CustomResource

Constructors

Probe(String, ProbeArgs, CustomResourceOptions)

Create a Probe resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ProbeArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

IntervalInSeconds

The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.

Declaration

public Output<int?> IntervalInSeconds { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

LoadbalancerId

The ID of the LoadBalancer in which to create the NAT Rule.

Declaration

public Output<string> LoadbalancerId { get; }

Property Value

Type	Description
Output<System.String>

LoadBalancerRules

Declaration

public Output<ImmutableArray<string>> LoadBalancerRules { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Name

Specifies the name of the Probe.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NumberOfProbes

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.

Declaration

public Output<int?> NumberOfProbes { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Port

Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.

Declaration

public Output<int> Port { get; }

Property Value

Type	Description
Output<System.Int32>

Protocol

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.

Declaration

public Output<string> Protocol { get; }

Property Value

Type	Description
Output<System.String>

RequestPath

The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

Declaration

public Output<string> RequestPath { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the resource.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ProbeState, CustomResourceOptions)

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

Declaration

public static Probe Get(string name, Input<string> id, ProbeState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ProbeState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Probe