App Settings Required or Not is Unclear

[andrewholler]

It is unclear whether the app settings are required for the app service health check feature to work or not. Will app service health checks work with just the "healthCheckPath" web config setting specified? Does WEBSITE_HEALTHCHECK_MAXPINGFAILURES need to be set for this feature to work or will it default if the app setting is not set?

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 20c42a13-f6cb-1e60-0438-f7f32b86a336
• Version Independent ID: 79e7dd15-24aa-2e6d-cee7-7714e1940c11
• Content: Monitor the health of App Service instances - Azure App Service
• Content Source: articles/app-service/monitor-instances-health-check.md
• Service: app-service
• GitHub Login: @msangapu-msft
• Microsoft Alias: msangapu

[SnehaAgrawal-MSFT]

@aholler2 Thanks for the feedback! We are currently investigating and will update you shortly.

[SnehaAgrawal-MSFT]

@aholler2 Thanks for asking question! To elaborate If you simply want to enable Health check follow below steps:

1. Browse to the Azure portal and select your App Service app.
2. Under Monitoring, select Health check.
3. Select Enable and provide a valid URL path on your application, such as /health or /api/health.
4. by clicking save Health check feature is now enabled.

But additionally if you also want to configure the Health check options then you need to set app setting like WEBSITE_HEALTHCHECK_MAXPINGFAILURES ; WEBSITE_HEALTHCHECK_MAXUNHEALTHYWORKERPERCENT as described here

[andrewholler]

I am still unclear on whether or not the app settings are required. Does your reply mean WEBSITE_HEALTHCHECK_MAXPINGFAILURES is not required to be set then? Does it have a default value like WEBSITE_HEALTHCHECK_MAXUNHEALTHYWORKERPERCENT (default is 50)? We want to enable health check on app services by default and would prefer to not touch the app settings.

[RyanHill-MSFT]

Hi @aholler2 the app setting is not required to enable health check.

$resourceGroupName = "resourcegroupname"
$appName = "webappname"
$webApp = Get-AzWebApp -ResourceGroupName $resourceGroupName -Name $appName -ErrorAction Stop

# enable healthcheck feature. Update healthcheckpath
$webApp.SiteConfig.healthCheckPath = "/healthcheckpath"

# Saving new configuration
$webApp = Set-AzWebApp -WebApp $webApp -ErrorAction Stop