Azure static web app anonymous health check route

Question

I have an Azure static web app with the staticwebapp.config.json like so:

"routes": [
  {
    "route": "/*",
    "allowedRoles": ["authenticated"]
  }
]
"navigationFallback": {
  "rewrite": "index.html",
  "exclude": ["/static/media/*.{png,jpg,gif,svg}", "/static/css/*"]
}

This works and all routes need to go through auth. Now, I want to add an exception to the /health route to allow for health check services to see if my site is up and running. How can I do this? I tried adding a route like this:

"routes": [
  {
    "route": "/health",
    "allowedRoles": ["anonymous"]
  },
  {
    "route": "/*",
    "allowedRoles": ["authenticated"]
  }
]
"navigationFallback": {
  "rewrite": "index.html",
  "exclude": ["/static/media/*.{png,jpg,gif,svg}", "/static/css/*"]
}

But that does not work, /health route still requires authentication.

That is the code, Azure static web apps have a config file that is used to determine the authentication and access to routes. You can see the docs here - learn.microsoft.com/en-us/azure/static-web-apps/configuration but in classic MS style, they either do not provide for a solution for my problem or their documentation is sorely lacking. — Anand
– Anand, Commented Feb 22, 2024 at 14:45
What type of authentication you are looking for . You asked for health check? /health will work when we have code like / . Here is the example of routing. — P Sampath
– P Sampath, Commented Feb 22, 2024 at 16:00

Lauden · Accepted Answer · 2024-02-28 10:18:56Z

0

What do you have behind the /health ?

It may be the navigationFallback that is redirecting you to index.html which requires authentication.

You can define a fallback rule by adding a navigationFallback section. The following example returns /index.html for all static file requests that don't match a deployed file. official doc

To be sure, add /health to the excluded path:

"exclude": ["/static/media/*.{png,jpg,gif,svg}", "/static/css/*", "/health"]

It is not due to the order of routes in your config

Rule evaluation stops at the first match

answered Feb 28, 2024 at 10:18

Lauden

1972 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Anand Over a year ago

Tried this as well but the health route does not work

stemixrf · Accepted Answer · 2024-02-28 10:22:55Z

0

From the example given here, Configure SWA, this most closely matches your requirement..

{ "route": "/calendar*", "rewrite": "/calendar.html" }

so you may need the wildcard at the end as indicated by

Wildcard pattern

...

The calendar.html file can then use client-side routing to serve a different view for URL variations like /calendar/january/1, /calendar/2020, and /calendar/overview.

Note

A route pattern of /calendar/* matches all requests under the /calendar/ path. However, it won't match requests for the paths /calendar or /calendar.html. Use /calendar* to match all requests that begin with /calendar.

answered Feb 28, 2024 at 10:22

stemixrf

4745 silver badges12 bronze badges

1 Comment

Anand Over a year ago

I was really hoping this was the answer but I tried and it does not work

Collectives™ on Stack Overflow

Azure static web app anonymous health check route

2 Answers 2

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related