sdk - rework LRO and ProvisioningState pollers to match ARM spec for terminal statuses
#1221
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
release-once-merged
This was referenced Jul 15, 2025
mbfrahry
approved these changes
Jul 15, 2025
| status = string(result.Status) | ||
| } | ||
| if string(result.Properties.ProvisioningState) != "" { | ||
| // if the result has a provisioningState field, we should prioritise that | ||
| if statusIsTerminal(result.Properties.ProvisioningState) { | ||
| status = string(result.Properties.ProvisioningState) | ||
| } | ||
| if status == "" { |
There was a problem hiding this comment.
If the status is something like one of the removed checks Updating, it wouldn't pass the statusIsTerminal check and we'd hit this check and just say that Polling Succeeded when it might still be updating.
Am I reading this right and is that the route we want to go?
There was a problem hiding this comment.
Correct, the spec (I'll try and find the link) states that the ProvisioningState takes priority on provisioning operations. This behaviour isn't actually changing here, we've always prioritised this over result.Status, the mechanism that checks the value has just been updated to accommodate the shift to only acting on states that are actually terminal in terms of the operation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR reworks how the SDK deals with Long Running Operation polling by removing custom "Terminal" statuses from consideration. ARM allows arbitrary values in the
Statusfields, including custom values supplied by users. Since it is not possible to know all possible values in advance, this PR delegates the success/failure of an operation to the service returning one of the ARM specified Terminal Statuses in the LRO response. Any other values are considered "InProgress" for the purposes of Operation Status.This PR includes the changes in #1124 and supersedes it.