Document Azure:CredentialProcessTimeoutSeconds option#737
Document Azure:CredentialProcessTimeoutSeconds option#737
Conversation
Documents the new Azure:CredentialProcessTimeoutSeconds configuration option introduced in microsoft/aspire#16175. The option lets users override the credential subprocess timeout (range 5-600) when az login validation is slow due to antivirus, network latency, etc. - deployment/azure/index.mdx: adds the option to the Shared Azure settings table and the CI/CD settings table. - integrations/cloud/azure/local-provisioning.mdx: adds the option to the configuration table and a new 'Credential process timeout' section under Authentication. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
eerhardt
requested review from
IEvangelist,
davidfowl and
maddymontaquila
as code owners
There was a problem hiding this comment.
Pull request overview
Documents the Azure:CredentialProcessTimeoutSeconds configuration option for Azure credential subprocess timeouts, so users can mitigate slow credential validation in local and CI/CD environments.
Changes:
- Adds
Azure:CredentialProcessTimeoutSecondsto the configuration options table and introduces a new “Credential process timeout” subsection in local provisioning docs. - Adds
Azure:CredentialProcessTimeoutSeconds/Azure__CredentialProcessTimeoutSecondsto the “Shared Azure settings” and “CI/CD settings” tables for Azure deployment docs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/integrations/cloud/azure/local-provisioning.mdx | Documents the new timeout setting for local provisioning and describes how/when to use it. |
| src/frontend/src/content/docs/deployment/azure/index.mdx | Surfaces the new setting in shared Azure and CI/CD configuration tables for aspire deploy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Most local credential sources (Azure CLI, Azure PowerShell, Visual Studio, Azure Developer CLI, and the development `Default` chain) acquire tokens by invoking a subprocess. On machines where these tools are slow to respond — for example, due to antivirus scanning or network latency — credential validation can time out before authentication completes. | ||
|
|
||
| Use `Azure:CredentialProcessTimeoutSeconds` to override the credential subprocess timeout. The value must be between **5** and **600** seconds. When unset, the Azure SDK's default timeout is used. | ||
|
|
||
| ```json title="appsettings.Development.json" | ||
| { | ||
| "Azure": { | ||
| "CredentialProcessTimeoutSeconds": 120 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| This setting applies to the `AzureCli`, `AzurePowerShell`, `VisualStudio`, and `AzureDeveloperCli` credential sources, and to the development credential chain used when `CredentialSource` isn't explicitly set. It has no effect on `InteractiveBrowser`, which doesn't shell out to a subprocess. |
There was a problem hiding this comment.
The new section lists which CredentialSource values this setting applies to, but it omits VisualStudioCode even though it’s listed as a supported Azure:CredentialSource value just above. This makes it unclear whether Azure:CredentialProcessTimeoutSeconds affects VS Code auth; please either include VisualStudioCode in the applicability list or explicitly call out that it’s not affected (and adjust the earlier “Most local credential sources … invoke a subprocess” wording accordingly).
| | `Azure:SubscriptionId` | `Azure__SubscriptionId` | Target Azure subscription | | ||
| | `Azure:Location` | `Azure__Location` | Default Azure region for provisioned resources | | ||
| | `Azure:ResourceGroup` | `Azure__ResourceGroup` | Resource group to create or reuse | | ||
| | `Azure:CredentialProcessTimeoutSeconds` | `Azure__CredentialProcessTimeoutSeconds` | Override the credential subprocess timeout (5–600 seconds) when `az login` validation is slow | |
There was a problem hiding this comment.
The setting description ties this timeout specifically to az login validation, but this table is meant to cover shared settings after authentication and the page also describes non-Azure-CLI auth flows (GitHub Actions OIDC, Azure DevOps service connections). Consider rephrasing the purpose to be credential-source-agnostic (e.g., “credential subprocess operations” / “Azure CLI or other process-based credentials”) so it doesn’t read as Azure CLI-specific in contexts where az login isn’t used.
| | `Azure:CredentialProcessTimeoutSeconds` | `Azure__CredentialProcessTimeoutSeconds` | Override the credential subprocess timeout (5–600 seconds) when `az login` validation is slow | | |
| | `Azure:CredentialProcessTimeoutSeconds` | `Azure__CredentialProcessTimeoutSeconds` | Override the credential subprocess timeout (5–600 seconds) when Azure CLI or other process-based credentials are slow | |
| | Azure subscription | `Azure__SubscriptionId` | Select the target Azure subscription | | ||
| | Azure location | `Azure__Location` | Set the default region for provisioned resources | | ||
| | Azure resource group | `Azure__ResourceGroup` | Select the resource group to create or reuse | | ||
| | Credential process timeout | `Azure__CredentialProcessTimeoutSeconds` | Override the credential subprocess timeout (5–600 seconds) when `az login` validation is slow on the build agent | |
There was a problem hiding this comment.
Same issue as above: in the CI/CD settings table, the purpose text mentions az login being slow on the build agent, but CI auth is often via OIDC/service connection (no az login). Suggest rewording to describe slow credential subprocess validation more generally, or to explicitly scope this input to scenarios where the pipeline is using Azure CLI/PowerShell/AZD-based credentials.
| | Credential process timeout | `Azure__CredentialProcessTimeoutSeconds` | Override the credential subprocess timeout (5–600 seconds) when `az login` validation is slow on the build agent | | |
| | Credential process timeout | `Azure__CredentialProcessTimeoutSeconds` | Override the credential subprocess timeout (5–600 seconds) when Azure CLI, PowerShell, or AZD credential validation is slow on the build agent | |
Documents the new
Azure:CredentialProcessTimeoutSecondsconfiguration option introduced in microsoft/aspire#16175. The option lets users override the credential subprocess timeout (range 5-600) whenaz loginvalidation is slow due to antivirus, network latency, etc.Changes
A companion PR (#731) targets
release/13.3.