docs: remove obsolete retry options - #3420
Conversation
|
Azure Pipelines: Successfully started running 1 pipeline(s). There may be pipelines that require an authorized user to comment /azp run to run. |
|
Thank you for your contribution nightcityblade! We will review the pull request and get back to you soon. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Azure MCP CLI command reference to remove documentation for the previously “global” --retry-* options and to adjust a few command-specific notes (AppLens, AKS, Cloud Architect) so they no longer imply those retry options are generally available.
Changes:
- Removed the
--retry-max-retries,--retry-delay,--retry-max-delay,--retry-mode, and--retry-network-timeoutrows from the “Global Options” table. - Updated AppLens / AKS / Cloud Architect notes to drop references to
--retry-*support.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| | `--subscription` | No | Environment variable `AZURE_SUBSCRIPTION_ID` | Azure subscription ID for target resources | | ||
| | `--tenant-id` | No | - | Azure tenant ID for authentication | | ||
| | `--auth-method` | No | 'credential' | Authentication method ('credential', 'key', 'connectionString') | |
There was a problem hiding this comment.
Fixed in c6e2a41. The global option is now documented as --tenant, and the remaining subscription-list example and Cloud Architect exclusion note were aligned with that actual flag name. The spelling check passes.
| The following options are available for most commands: | ||
|
|
||
| | Option | Required | Default | Description | | ||
| |-----------|----------|---------|-------------| | ||
| | `--subscription` | No | Environment variable `AZURE_SUBSCRIPTION_ID` | Azure subscription ID for target resources | |
There was a problem hiding this comment.
Addressed in c6e2a41. Removing retry options from the global table is still appropriate because tool commands no longer support them, but the three core commands that retain RetryPolicyOptions are now documented in their own sections: subscription list, group list, and group resource list. The spelling check passes.
|
nightcityblade please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
What does this PR do?
Removes the obsolete global
--retry-*options from the Azure MCP command reference now thatRetryPolicyOptionshas been removed from all tool commands.It also updates the AppLens, AKS, and Cloud Architect notes so they no longer imply that the removed global retry options are generally available.
GitHub issue number?
Fixes #3418
Pre-merge Checklist
dotnet build servers/Azure.Mcp.Server/and the spelling check pass.servers/Azure.Mcp.Server/README.mdand/orservers/Fabric.Mcp.Server/README.mddocumentation — N/A.README.mdchanges running the script./eng/scripts/Process-PackageReadMe.ps1. See Package README — N/A.ToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test prompts — N/A.consolidated-tools.json— N/A.breaking-changelabel — N/A.servers/Azure.Mcp.Server/docs/azmcp-commands.md— this is the only changed file../eng/scripts/Update-AzCommandsMetadata.ps1to update tool metadata inazmcp-commands.md(required for CI) — N/A; no tool metadata changed.servers/Azure.Mcp.Server/docs/e2eTestPrompts.md— N/A.crypto mining, spam, data exfiltration, etc.)/azp run mcp - pullrequest - liveto run Live Test Pipeline — N/A; documentation-only change, no live Azure behavior affected.