Track 3 Tier 1: API how-tos (GetResourceReservations, UndeployApps, RemoveEntitiesFromTopology) + resolution diagnostics - #19
Merged
Conversation
Adds usage guides for three previously-undocumented CloudShell Automation API methods (GetResourceReservations, UndeployApps, RemoveEntitiesFromTopology) and a troubleshooting section on reading the resolution-failure 'View Details' diagnostic. Grounded in the server code and integration test scenarios. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
nahumtimerman
added a commit
that referenced
this pull request
Sep 10, 2026
…inputs, category validation (#24) Documents the three behavior-changing items that landed on 2026.1 after the 2026.1.0.52 pass (#18) and were not covered by #19-#22. Python 3 upgraded to 3.13.15 x64 (Trunk CS 189988/189997/189999, backported in CS 190003). This is the WINDOWS bundled slot only - the Docker ES image still builds Python 3.9.9, and so do the Linux VA and the from-script ES, so every page states the platform split rather than a blanket "CloudShell now uses 3.13". Python 2.7.18 is untouched. Also corrects setting-up-dev-env.md, which #23 had just updated to say the bundled version is 3.9.9 - true when it merged on Sep 6, wrong when the upgrade landed on Sep 8. Global inputs kept on save as blueprint, with the new KeepResourceGlobalInputsOnSaveAsBlueprint key (CS 189903/189905/189914). Default is true, which is a behavior change on upgrade: inputs that fronted a resource requirement used to be dropped and are now visible in the Reserve dialog and the blueprint editor. Documented as a customer-visible key on the Server (AppSettingVisibility.Customer, read by ServiceConfigSettingsLoader). Blueprint import now fails on a category missing from the target domain instead of silently dropping the association (CS 189942). The ExportBlueprint/ImportBlueprint page from #22 already stated this, so it needed no correction - only the release notes did. Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fills the highest-priority documentation gaps from the how-to coverage audit: three shipped CloudShell Automation API methods that had no usage documentation, plus the abstract-resolution failure diagnostics that shipped undocumented.
New articles (
devguide/available-cs-api/useful-cs-api-examples/)GetResourceReservations(resourceFullPath, includeHistorical, maxResults); active/pending/completed, pagination (TotalCountvs page), Python example.UndeployApps(resourcesFullPath[]); destroys the cloud-provider VM but keeps the resource (vs delete), bulk-teardown pattern.RemoveEntitiesFromTopology(topologyName, entityIds[]); removes services/abstract resources (+ attached routes) from a blueprint.Updated
Grounding & validation
RestGetResourceReservationsScenarios,RemoveEntitiesFromTopologyScenarios), then adversarially re-checked. NotablyUndeployAppstakes onlyresourcesFullPath[](no reservation id).npm run buildpasses (only the 3 pre-existingabstract-resources.mdbroken links remain). Addedundeploy/Undeploying/undeploys+ pagination terms to.wordlist.txt.🤖 Generated with Claude Code