azurerm_application_gateway - support for rewriting urls with the url block

[dhensby]

Fixes #7565

This is my first pass at trying to get URLConfiguration support into terraform (see https://docs.microsoft.com/en-us/rest/api/application-gateway/applicationgateways/get#applicationgatewayurlconfiguration).

This will allow the rewriting of URLs in application gateway.

To-dos:

• Should we validate that at least one of url_configuration.url_path or url_configuration.url_query is supplied?
• Update docs
• tests??

---

example usage:

resource "azurerm_application_gateway" "gateway" {
  ...
  rewrite_rule_set {
    name = local.rewrite_rule_set_name

    rewrite_rule {
      name          = local.rewrite_rule_name
      rule_sequence = 1

      condition {
        variable = "var_uri_path"
        pattern  = ".*article/(.*)/(.*)"
      }

      url {
        path         = "/article.aspx"
        query_string = "id={var_uri_path_1}&title={var_uri_path_2}"
      }
    }
  }
  ...
}

Test data based on example here https://docs.microsoft.com/en-us/azure/application-gateway/rewrite-url-portal

[dhensby]

I have compiled and tested this locally and successfully deployed a url_rewrite against an app gateway.

[jackofallops]

Hi @dhensby - Could you revert any changes to CHANGELOG.md - This file is updated by maintainers when we actually merge and should not be part of a PR content.

Thanks!

[katbyte]

Thanks for the PR @dhensby - overall looks great, but i have some questions i've left inline to address before merge

[katbyte]

Thanks @dhensby - LGTM 👍

[ghost]

This has been released in version 2.54.0 of the provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. As an example:

provider "azurerm" {
    version = "~> 2.54.0"
}
# ... other configuration ...

[ido-re]

Thanks for this very important update,
I think there is a minor bug in the result (below)
when using
url {
path =foo
}

the result is "Both URL path and URL query string" and not "URL path" (screenshot below)

[dhensby]

I think this is just how the front end in the portal is showing it.

That option isn't actually part of the rest API, it's just how the portal shows the interface.

[ido-re]

@dhensby - after tests, the query strings are not working when it set to "Both URL path and URL query string" and not to "URL path" only.
In my tf module, the path is set to "path" only and not both "path" and "query_string" (below)

url {
path =foo
}

[dhensby]

@ido-tr I don't really understand what you're saying.

I've gone through to double check this all works as expected and I don't see any issues:

Both path and query_string set:

  rewrite_rule_set {
    name = "test-rewrite-ruleset"

    rewrite_rule {
      name          = "test-rewrite-rule"
      rule_sequence = 1

      condition {
        variable = "var_uri_path"
        pattern  = ".*article/(.*)/(.*)"
      }

      url {
        path         = "/article.aspx"
        query_string = "id={var_uri_path_1}&title={var_uri_path_2}"
      }
    }
  }

In the portal:

Just query_string:

  rewrite_rule_set {
    name = "test-rewrite-ruleset"

    rewrite_rule {
      name          = "test-rewrite-rule"
      rule_sequence = 1

      condition {
        variable = "var_uri_path"
        pattern  = ".*article/(.*)/(.*)"
      }

      url {
        query_string = "id={var_uri_path_1}&title={var_uri_path_2}"
      }
    }
  }

In the portal:

Just path:

  rewrite_rule_set {
    name = "test-rewrite-ruleset"

    rewrite_rule {
      name          = "test-rewrite-rule"
      rule_sequence = 1

      condition {
        variable = "var_uri_path"
        pattern  = ".*article/(.*)/(.*)"
      }

      url {
        path         = "/article.aspx"
      }
    }
  }

In the portal:

All those are working as expected; can you provide me an example that doesn't work?

[dhensby]

Having inspected the state file, I think I see the problem. When no value is provided the state file shows that there is a value of "" (an empty string), which probably means the query_string is essentially being replaced by the rewrite rule.

I'm not entirely sure why this is the case, but I'll do some investigation as to why empty strings are going through when no value is provided.

[dhensby]

OK - this is where my lack of Go/terraform knowledge is letting me down - I can't see why empty values are being passed when values are missing.

It appears it may not be possible to distinguish a missing value vs empty string for TypeString, in which case we have a bit of a problem...

@katbyte any thoughts on this?

[ido-re]

@dhensby - this is exactly my point

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!