pulumi-azure-native-kotlin/com.pulumi.azurenative.network.kotlin/NetworkFunctions/getApplicationGatewayBackendHealthOnDemand

getApplicationGatewayBackendHealthOnDemand

suspend fun getApplicationGatewayBackendHealthOnDemand(argument: GetApplicationGatewayBackendHealthOnDemandPlainArgs): GetApplicationGatewayBackendHealthOnDemandResult

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Return

Result of on demand test probe.

Parameters

argument

null

suspend fun getApplicationGatewayBackendHealthOnDemand(applicationGatewayName: String, backendAddressPool: SubResource? = null, backendHttpSettings: SubResource? = null, expand: String? = null, host: String? = null, match: ApplicationGatewayProbeHealthResponseMatch? = null, path: String? = null, pickHostNameFromBackendHttpSettings: Boolean? = null, protocol: Either<String, ApplicationGatewayProtocol>? = null, resourceGroupName: String, timeout: Int? = null): GetApplicationGatewayBackendHealthOnDemandResult

Return

Result of on demand test probe.

Parameters

applicationGatewayName

The name of the application gateway.

backendAddressPool

Reference to backend pool of application gateway to which probe request will be sent.

backendHttpSettings

Reference to backend http setting of application gateway to be used for test probe.

expand

Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

host

Host name to send the probe to.

match

Criterion for classifying a healthy probe response.

path

Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

pickHostNameFromBackendHttpSettings

Whether the host header should be picked from the backend http settings. Default value is false.

protocol

The protocol used for the probe.

resourceGroupName

The name of the resource group.

timeout

The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

See also

.

suspend fun getApplicationGatewayBackendHealthOnDemand(argument: suspend GetApplicationGatewayBackendHealthOnDemandPlainArgsBuilder.() -> Unit): GetApplicationGatewayBackendHealthOnDemandResult

Return

Result of on demand test probe.

Parameters

argument

Builder for com.pulumi.azurenative.network.kotlin.inputs.GetApplicationGatewayBackendHealthOnDemandPlainArgs.

See also

.