ApplicationGatewayResource.BackendHealthOnDemandAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand
- Operation Id: ApplicationGateways_BackendHealthOnDemand
- Default Api Version: 2024-03-01
- Resource: ApplicationGatewayResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.ApplicationGatewayBackendHealthOnDemand>> BackendHealthOnDemandAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Network.Models.ApplicationGatewayOnDemandProbe probeRequest, string expand = default, System.Threading.CancellationToken cancellationToken = default);abstract member BackendHealthOnDemandAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.ApplicationGatewayOnDemandProbe * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.ApplicationGatewayBackendHealthOnDemand>>
override this.BackendHealthOnDemandAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.ApplicationGatewayOnDemandProbe * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.ApplicationGatewayBackendHealthOnDemand>>Public Overridable Function BackendHealthOnDemandAsync (waitUntil As WaitUntil, probeRequest As ApplicationGatewayOnDemandProbe, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of ApplicationGatewayBackendHealthOnDemand))Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- probeRequest
- ApplicationGatewayOnDemandProbe
Request body for on-demand test probe operation.
- expand
- String
Expands BackendAddressPool and BackendHttpSettings referenced in backend health.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
probeRequest is null.
