New-Network Controller Load Balancer Probe

Module:
networkcontroller
This cmdlet adds/updates the health probes associated with a load balancer.

Syntax 

New-NetworkControllerLoadBalancerProbe
   -ConnectionUri <Uri>
   -LoadBalancerId <string>
   -Properties <LoadBalancerProbeProperties>
   -ResourceId <string>
   [-CertificateThumbPrint <string>]
   [-Credential <PSCredential>]
   [-Etag <string>]
   [-Force]
   [-ResourceMetadata <ResourceMetadata>]

Description

This cmdlet adds/updates the health probes associated with a load balancer. Health probes are used by the load balancer to determine the health state of the backend pool members.

Examples

Example 1

This example creates a new health probe named probe1 for a load balancer resource named lb1. This is a HTTP probe that queries to the RequestPath of "/health.htm". The query is performed every 5 seconds, as specified by the IntervalInSeconds property. The health probe must receive an HTTP response code of 200 for 8 consecutive queries for the probe to consider the backend IP to be healthy. If the backend IP is not healthy, the load balancer will not send traffic to the IP. 

$probe=New-Object Microsoft.Windows.NetworkController.LoadBalancerProbeProperties
$probe.protocol="HTTP"
$probe.port="80"
$probe.RequestPath="/health.htm"
$probe.IntervalInSeconds=5
$probe.NumberofProbes=8
New-NetworkControllerLoadBalancerProbe -ConnectionUri https://networkcontroller -LoadBalancerId lb1 -ResourceId Probe1 -Properties $probe

Required Parameters

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Type: Uri
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoadBalancerId

Specifies the load balancer where the health probe belongs

Type: string
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Properties

Following properties can be added/changed for a load balancer probe:

  • Protocol
  • Port
  • Request path that has to be probed
  • Probe interval (in seconds)
  • Number of retries after which a backend resource is deemed unhealthy
Type: LoadBalancerProbeProperties
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ResourceId

Specifies the unique ID of the health probe rule

Type: string
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Optional Parameters

-CertificateThumbPrint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate. This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

Type: string
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credential

Specifies a user credential that has permission to perform this action. The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Type: PSCredential
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Etag

Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

Type: string
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

Type: switch
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ResourceMetadata

This parameter contains metadata information for the client, such as the tenant ID, group ID, and resource name.

Type: ResourceMetadata
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Inputs

Following properties can be added/changed for a load balancer probe:

  • Protocol
  • Port
  • Request path that has to be probed
  • Probe interval (in seconds)
  • Number of retries after which a backend resource is deemed unhealthy