appservice - check for deployment service availability before zip deployment

[ezhong-msft]

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

When an appsetting update is made, this causes the app recycle. On the most basic B1 sku plan, I've observed this takes 4-5 mins which exceeds the 4 minute timeout for the zip deployment. Added a simple poll to the deployment service to check availability before starting the zip deployment as recommended by service team (this is similar to what is done in AzCLI).

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• (n/a) I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevant documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

https://hashicorp.teamcity.com/buildConfiguration/TF_AzureRM_AZURERM_SERVICE_PUBLIC_APPSERVICE/421133?buildTab=tests

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

• azurerm_linux_function_app - check for deployment service availability before zip deployment [azurerm_linux_web_app - Zip application deployment failure due to container restart with application setting update in same terraform apply operation #30014]
• azurerm_linux_web_app - check for deployment service availability before zip deployment [azurerm_linux_web_app - Zip application deployment failure due to container restart with application setting update in same terraform apply operation #30014]
• azurerm_windows_function_app - check for deployment service availability before zip deployment [azurerm_linux_web_app - Zip application deployment failure due to container restart with application setting update in same terraform apply operation #30014]
• azurerm_windows_web_app - check for deployment service availability before zip deployment [azurerm_linux_web_app - Zip application deployment failure due to container restart with application setting update in same terraform apply operation #30014]

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Fixes #30014

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the provider.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

[gerrytan]

Internal Microsoft review: recommended to add debug log on the polling refresh so we have data to investigate future support cases. Other than this the PR looks good and ready for Hashicorp review. Nice work!

[catriona-m]

Hi @ezhong-msft thanks for submitting this. Although there are some existing usages of WaitForStateContext still in the provider, going forward we prefer to use custom pollers instead. Could we rework this pr to use a custom poller? Here is an example of an existing poller for reference. Thanks!

[ezhong-msft]

@catriona-m Thanks for the review, updated and will keep that in mind for the future.
New test run with change
https://hashicorp.teamcity.com/buildConfiguration/TF_AzureRM_AZURERM_SERVICE_PUBLIC_APPSERVICE/421133?buildTab=tests

[catriona-m]

Thanks for updating this @ezhong-msft - LGTM!

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.