< Back

Set-AzureRmLoadBalancerProbeConfig

Tue Jan 29, 2019 9:58 pm

NAME Set-AzureRmLoadBalancerProbeConfig



SYNOPSIS

Sets the goal state for a probe configuration.





SYNTAX

Set-AzureRmLoadBalancerProbeConfig [-DefaultProfile <IAzureContextContainer>] -IntervalInSeconds <Int32> -LoadBalancer <PSLoadBalancer> -Name

<String> -Port <Int32> -ProbeCount <Int32> [-Protocol {Tcp | Http}] [-RequestPath <String>] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmLoadBalancerProbeConfig cmdlet sets the goal state for a probe configuration.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IntervalInSeconds <Int32>

Specifies the interval, in seconds, between probes to each instance of the load-balanced service.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LoadBalancer <PSLoadBalancer>

Specifies a load balancer. This cmdlet sets the goal state for a probe configuration for the load balancer that this parameter specifies.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

Specifies the name of the probe configuration that this cmdlet sets.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Port <Int32>

Specifies the port on which probes should connect to a load-balanced service.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProbeCount <Int32>

Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Protocol <String>

Specifies the protocol to use for the probing. The acceptable values for this parameter are: Tcp or Http.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RequestPath <String>

Specifies the path in the load-balanced service to probe to determine health.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

PSLoadBalancer

Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline





OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSLoadBalancer







NOTES









Example 1: Modify the probe configuration on a load balancer



PS C:\\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup"

PS C:\\> $slb | Add-AzureRmLoadBalancerProbeConfig -Name "NewProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -RequestPath

"healthcheck.aspx"

PS C:\\> $slb | Set-AzureRmLoadBalancerProbeConfig -Name "NewProbe" -Port 80 -IntervalInSeconds 15 -ProbeCount 2



The first command gets the loadbalancer named MyLoadBalancer, and then stores it in the $slb variable.



The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerProbeConfig, which adds a new probe

configuration to it.



The third command passes the load balancer to Set-AzureRmLoadBalancerProbeConfig , which sets the new configuration. Note that it is necessary to

specify several of the same parameters that were specified in the previous command because they are required by the current cmdlet.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... robeconfig

Add-AzureRmLoadBalancerProbeConfig

Get-AzureRmLoadBalancer

Get-AzureRmLoadBalancerProbeConfig

New-AzureRmLoadBalancerProbeConfig

Remove-AzureRmLoadBalancerProbeConfig