Skip to content

.NET Samples - Configuration Naming Update - #4149

Merged
Chris (crickman) merged 21 commits into
crickman/dotnet-sample-improvementsfrom
copilot/rename-configuration-settings
Feb 24, 2026
Merged

.NET Samples - Configuration Naming Update#4149
Chris (crickman) merged 21 commits into
crickman/dotnet-sample-improvementsfrom
copilot/rename-configuration-settings

Conversation

CopilotAI commented Feb 21, 2026

Copy link
Copy Markdown
Contributor

Motivation and Context

Rename configuration settings for consistency within .NET and also between .NET and Python.

Validation

Most recent integration test runs:

.NET - https://github.com/microsoft/agent-framework/actions/runs/22326836567
Python - https://github.com/microsoft/agent-framework/actions/runs/22363194830

Description

Applied the following updates to configuration names:

OriginalActual
SERVER_URLAGUI_SERVER_URL
OTLP_ENDPOINTOTEL_EXPORTER_OTLP_ENDPOINT
Anthropic.ApiKeyANTHROPIC_API_KEY
Anthropic.ChatModelIdANTHROPIC_CHAT_MODEL_NAME
Anthropic.ChatReasoningModelIdANTHROPIC_REASONING_MODEL_NAME
Anthropic.ServiceIdANTHROPIC_SERVICE_ID
ANTHROPIC_APIKEYANTHROPIC_API_KEY
ANTHROPIC_DEPLOYMENT_NAMEANTHROPIC_CHAT_MODEL_NAME
ANTHROPIC_MODELANTHROPIC_CHAT_MODEL_NAME
BEDROCK_ACCESSKEYBEDROCK_ACCESS_KEY
BEDROCK_SECRETACCESSKEYBEDROCK_SECRET_KEY
AZURE_FOUNDRY_MODEL_DEPLOYMENTAZURE_AI_MODEL_DEPLOYMENT_NAME
AZURE_FOUNDRY_OPENAI_API_KEYAZURE_OPENAI_API_KEY
AZURE_FOUNDRY_PROJECT_DEEP_RESEARCH_DEPLOYMENT_NAMEAZURE_AI_REASONING_DEPLOYMENT_NAME
AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAMEAZURE_AI_MODEL_DEPLOYMENT_NAME
AZURE_FOUNDRY_PROJECT_ENDPOINTAZURE_AI_PROJECT_ENDPOINT
AzureAI.BingConnectionIdAZURE_AI_BING_CONNECTION_ID
AzureAI.DeploymentNameAZURE_AI_MODEL_DEPLOYMENT_NAME
AzureAI.EndpointAZURE_AI_PROJECT_ENDPOINT
AZURE_OPENAI_CHAT_DEPLOYMENT_NAMEAZURE_OPENAI_DEPLOYMENT_NAME
AZURE_OPENAI_DEPLOYMENTAZURE_OPENAI_DEPLOYMENT_NAME
AZURE_OPENAI_KEYAZURE_OPENAI_API_KEY
BING_CONNECTION_IDAZURE_AI_BING_CONNECTION_ID
BING_CUSTOM_SEARCH_PROJECT_CONNECTION_IDAZURE_AI_CUSTOM_SEARCH_CONNECTION_ID
BING_CUSTOM_SEARCH_INSTANCE_NAMEAZURE_AI_CUSTOM_SEARCH_INSTANCE_NAME
COSMOS_EMULATOR_AVAILABLECOSMOSDB_EMULATOR_AVAILABLE
COSMOS_PRESERVE_CONTAINERSCOSMOSDB_PRESERVE_CONTAINERS
FOUNDRY_CONNECTION_GROUNDING_TOOLAZURE_AI_BING_CONNECTION_ID
FOUNDRY_MEDIA_DEPLOYMENT_NAMEAZURE_AI_MODEL_DEPLOYMENT_NAME
FOUNDRY_MODEL_DEPLOYMENT_NAMEAZURE_AI_MODEL_DEPLOYMENT_NAME
FOUNDRY_PROJECT_ENDPOINTAZURE_AI_PROJECT_ENDPOINT
FOUNDRY_PROJECT_EMBEDDING_MODELAZURE_AI_EMBEDDING_DEPLOYMENT_NAME
FOUNDRY_PROJECT_MEMORY_STORE_NAMEAZURE_AI_MEMORY_STORE_ID
Mem0.ApiKeyMEM0_API_KEY
Mem0.ServiceUriMEM0_ENDPOINT
MEM0_APIKEYMEM0_API_KEY
CopilotStudioAgent.AppClientIdCOPILOTSTUDIO_AGENT_APP_ID
CopilotStudioAgent.DirectConnectUrlCOPILOTSTUDIO_DIRECT_CONNECT_URL
CopilotStudioAgent.TenantIdCOPILOTSTUDIO_TENANT_ID
OpenAI.ApiKeyOPENAI_API_KEY
OpenAI.ChatModelIdOPENAI_CHAT_MODEL_NAME
OpenAI.ChatReasoningModelIdOPENAI_REASONING_MODEL_NAME
OpenAI.ServiceIdOPENAI_SERVICE_ID
OPENAI_MODELOPENAI_CHAT_MODEL_NAME

Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
CopilotAI changed the title [WIP] Update configuration setting names in dotnet samplesRename configuration keys in dotnet/samples to standardized namesFeb 21, 2026
@markwallace-microsoftMark Wallace (markwallace-microsoft) added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs .NET Usage: [Issues, PRs], Target: .Net labels Feb 22, 2026
@github-actionsgithub-actionsBot changed the title Rename configuration keys in dotnet/samples to standardized names.NET: Rename configuration keys in dotnet/samples to standardized namesFeb 22, 2026
@crickmanChris (crickman) changed the title .NET: Rename configuration keys in dotnet/samples to standardized names.NET Samples - Configuration Naming UpdateFeb 22, 2026
@crickman
Chris (crickman) marked this pull request as ready for review February 22, 2026 00:22
Comment on lines +208 to +210
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
OPENAI_CHAT_MODEL_NAME: ${{ vars.OPENAI_CHAT_MODEL_NAME }}
OPENAI_REASONING_MODEL_NAME: ${{ vars.OPENAI_REASONING_MODEL_NAME }}

@rogerbarretoRoger Barreto (rogerbarreto)Feb 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chris (@crickman) I think not using "__" double underscores breaks the UserSecrets approach please ensure we can safely use single _

@crickmanChris (crickman)Feb 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User-secrets are still functional, the keys have just changed. Instead of a binding to a configuration class, the configuration keys are simply read directly. While I'm fond of class-binding for configuration, these provides alignnment between sample usage and integration tests.

The high level requirement here is that integration tests use the same configuration as samples.

Here an example of integration test secrets for local usage:

{
"AZURE_AI_PROJECT_ENDPOINT": "https://<foundry>.services.ai.azure.com/api/projects/<project>",
"AZURE_AI_MODEL_DEPLOYMENT_NAME": "gpt-4.1",
"AZURE_AI_REASONING_DEPLOYMENT_NAME": "o3",
"AZURE_AI_EMBEDDING_DEPLOYMENT_NAME": "text-embedding-3-large",
"AZURE_AI_BING_CONNECTION_ID": "skbinggrounding"
}

Here is the simplified shared configuration keys: https://github.com/microsoft/agent-framework/blob/copilot/rename-configuration-settings/dotnet/src/Shared/IntegrationTests/TestSettings.cs

I've verified this works from the command line with no environmental vars defined.

@crickman
Chris (crickman) merged commit 1b6b2d8 into crickman/dotnet-sample-improvementsFeb 24, 2026
2 checks passed
@github-project-automationgithub-project-automationBot moved this from In Review to Done in Agent FrameworkFeb 24, 2026
github-merge-queueBot pushed a commit that referenced this pull request Feb 26, 2026
…c… (#4092)
* Python: .NET Samples - Restructure and Improve Samples (Feature Branch) (#4091)
* Moved by agent (#4094)
* Fix readme links
* .NET Samples - Create `04-hosting` learning path step (#4098)
* Agent move
* Agent reorderd
* Remove A2A section from README Removed A2A section from the Getting Started README.
* Agent fixed links
* Fix broken sample links in durable-agents README (#4101)
* Initial plan
* Fix broken internal links in documentation
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Revert template link changes; keep only durable-agents README fix
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* .NET Samples - Create `03-workflows` learning path step (#4102)
* Fix solution project path
* Python: Fix broken markdown links to repo resources (outside /docs) (#4105)
* Initial plan
* Fix broken markdown links to repo resources
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Update README to rename .NET Workflows Samples section
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* .NET Samples - Create `02-agents` learning path step (#4107)
* .NET: Fix broken relative link in GroupChatToolApproval README (#4108)
* Initial plan
* Fix broken link in GroupChatToolApproval README
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Update labeler configuration for workflow samples
* .NET - Reorder Agents samples to start from Step01 instead of Step04 (#4110)
* Fix solution
* Resolve new sample paths
* Move new AgentSkills and AgentWithMemory_Step04 samples
* Fix link
* Fix readme path
* fix: update stale dotnet/samples/Durable path reference in AGENTS.md
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Moved new sample
* Update solution
* Resolve merge (new sample)
* Sync to new sample - FoundryAgents_Step21_BingCustomSearch
* Updated README
* .NET Samples - Configuration Naming Update (#4149)
* .NET: Restore AzureFunctions index parity with ConsoleApps under DurableAgents samples (#4221)
* Clean-up `05_host_your_agent`
* Config setting consistency
* Refine samples
* AGENTS.md
* Move new samples
* Re-order samples
* Move new project and fixup solution
* Fixup model config
* Fix up new UT project
---------
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
westey (westey-m) added a commit that referenced this pull request Feb 26, 2026
* .NET: Add Microsoft Fabric sample #3674 (#4230)
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>
* Python: Phase 2: Embedding clients for Ollama, Bedrock, and Azure AI Inference (#4207)
* Phase 2: Embedding clients for Ollama, Bedrock, and Azure AI Inference
Add embedding client implementations to existing provider packages:
- OllamaEmbeddingClient: Text embeddings via Ollama's embed API
- BedrockEmbeddingClient: Text embeddings via Amazon Titan on Bedrock
- AzureAIInferenceEmbeddingClient: Text and image embeddings via Azure AI
Inference, supporting Content | str input with separate model IDs for
text (AZURE_AI_INFERENCE_EMBEDDING_MODEL_ID) and image
(AZURE_AI_INFERENCE_IMAGE_EMBEDDING_MODEL_ID) endpoints
Additional changes:
- Rename EmbeddingCoT -> EmbeddingT, EmbeddingOptionsCoT -> EmbeddingOptionsT
- Add otel_provider_name passthrough to all embedding clients
- Register integration pytest marker in all packages
- Add lazy-loading namespace exports for Ollama and Bedrock embeddings
- Add image embedding sample using Cohere-embed-v3-english
- Add azure-ai-inference dependency to azure-ai package
Part of #1188
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Fix mypy duplicate name and ruff lint issues
- Rename second 'vector' variable to 'img_vector' in image embedding loop
- Combine nested with statements in tests
- Remove unused result assignments in tests
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* updates from feedback
* Fix CI failures in embedding usage handling
- Fix Azure AI embedding mypy issues by normalizing vectors to list[float],
safely accumulating optional usage token fields, and filtering None entries
before constructing GeneratedEmbeddings
- Avoid Bandit false positive by initializing usage details as an empty dict
- Update OpenAI embedding tests to assert canonical usage keys
(input_token_count/total_token_count)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* [Purview] Mark responses as responses and fix epoch bug for python long overflow (#4225)
* .NET: Support InvokeMcpTool for declarative workflows (#4204)
* Initial implementation of InvokeMcpTool in declarative workflow
* Cleaned up sample implementation
* Updated sample comments.
* Added missing executor routing attribute
* Fix PR comments.
* Updated based on PR comments.
* Updated based on PR comments.
* Removed unnecessary using statement.
* Update Python package versions to rc2 (#4258)
- Bump core and azure-ai to 1.0.0rc2
- Bump preview packages to 1.0.0b260225
- Update dependencies to >=1.0.0rc2
- Add CHANGELOG entries for changes since rc1
- Update uv.lock
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* .NET: Fixing issue where OpenTelemetry span is never exported in .NET in-process workflow execution (#4196)
* 1. Add reproduction test for issue #4155: workflow.run Activity never stopped in streaming OffThread path
The WorkflowRunActivity_IsStopped_Streaming_OffThread test demonstrates that
the workflow.run OpenTelemetry Activity created in StreamingRunEventStream.RunLoopAsync
is started but never stopped when using the OffThread/Default streaming execution.
The background run loop keeps running after event consumption completes, so the
using Activity? declaration never disposes until explicit StopAsync() is called.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2. Fix workflow.run Activity never stopped in streaming OffThread execution (#4155)
The workflow.run OpenTelemetry Activity in StreamingRunEventStream.RunLoopAsync
was scoped to the method lifetime via 'using'. Since the run loop only exits on
cancellation, the Activity was never stopped/exported until explicit disposal.
Fix: Remove 'using' and explicitly dispose the Activity when the workflow reaches
Idle status (all supersteps complete). A safety-net disposal in the finally block
handles cancellation and error paths.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Add root-level workflow.session activity spanning run loop lifetime\n\nImplements two-level telemetry hierarchy per PR feedback from lokitoth:\n- workflow.session: spans the entire run loop / stream lifetime\n- workflow_invoke: per input-to-halt cycle, nested within the session\n\nThis ensures the session activity stays open across multiple turns,\nwhile individual run activities are created and disposed per cycle.\n\nAlso fixes linkedSource CancellationTokenSource disposal leak in\nStreamingRunEventStream (added using declaration)."
* Address Copilot review: fix Activity/CTS disposal, rename activity, add error tag\n\n1. LockstepRunEventStream: Remove 'using' from Activity in async iterator\n and manually dispose in finally block (fixes#4155 pattern). Also dispose\n linkedSource CTS in finally to prevent leak.\n2. Tags.cs: Add ErrorMessage (\"error.message\") tag for runtime errors,\n distinct from BuildErrorMessage (\"build.error.message\").\n3. ActivityNames: Rename WorkflowRun from \"workflow_invoke\" to \"workflow.run\"\n for cross-language consistency.\n4. WorkflowTelemetryContext: Fix XML doc to say \"outer/parent span\" instead\n of \"root-level span\".\n5. ObservabilityTests: Assert WorkflowSession absence when DisableWorkflowRun\n is true.\n6. WorkflowRunActivityStopTests: Fix streaming test race by disposing\n StreamingRun before asserting activities are stopped.\n7. StreamingRunEventStream/LockstepRunEventStream: Use Tags.ErrorMessage\n instead of Tags.BuildErrorMessage for runtime error events."
* Review fixes: revert workflow_invoke rename, use 'using' for linkedSource, move SessionStarted earlier\n\n- Revert ActivityNames.WorkflowRun back to \"workflow_invoke\" (OTEL semantic convention contract)\n- Use 'using' declaration for linkedSource CTS in LockstepRunEventStream (no timing sensitivity)\n- Move SessionStarted event before WaitForInputAsync in StreamingRunEventStream to match Lockstep behavior"
* Improve naming and comments in WorkflowRunActivityStopTests"
* Prevent session Activity.Current leak in lockstep mode, add nesting test
Save and restore Activity.Current in LockstepRunEventStream.Start() so the
session activity doesn't leak into caller code via AsyncLocal. Re-establish
Activity.Current = sessionActivity before creating the run activity in
TakeEventStreamAsync to preserve parent-child nesting.
Add test verifying app activities after RunAsync are not parented under the
session, and that the workflow_invoke activity nests under the session."
* Fix stale XML doc: WorkflowRun -> WorkflowInvoke in ObservabilityTests
---------
Co-authored-by: alliscode <bentho@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python / .NET Samples - Restructure and Improve Samples (Feature Branc… (#4092)
* Python: .NET Samples - Restructure and Improve Samples (Feature Branch) (#4091)
* Moved by agent (#4094)
* Fix readme links
* .NET Samples - Create `04-hosting` learning path step (#4098)
* Agent move
* Agent reorderd
* Remove A2A section from README Removed A2A section from the Getting Started README.
* Agent fixed links
* Fix broken sample links in durable-agents README (#4101)
* Initial plan
* Fix broken internal links in documentation
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Revert template link changes; keep only durable-agents README fix
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* .NET Samples - Create `03-workflows` learning path step (#4102)
* Fix solution project path
* Python: Fix broken markdown links to repo resources (outside /docs) (#4105)
* Initial plan
* Fix broken markdown links to repo resources
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Update README to rename .NET Workflows Samples section
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* .NET Samples - Create `02-agents` learning path step (#4107)
* .NET: Fix broken relative link in GroupChatToolApproval README (#4108)
* Initial plan
* Fix broken link in GroupChatToolApproval README
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Update labeler configuration for workflow samples
* .NET - Reorder Agents samples to start from Step01 instead of Step04 (#4110)
* Fix solution
* Resolve new sample paths
* Move new AgentSkills and AgentWithMemory_Step04 samples
* Fix link
* Fix readme path
* fix: update stale dotnet/samples/Durable path reference in AGENTS.md
Co-authored-by: crickman <66376200+crickman@users.noreply.github.com>
* Moved new sample
* Update solution
* Resolve merge (new sample)
* Sync to new sample - FoundryAgents_Step21_BingCustomSearch
* Updated README
* .NET Samples - Configuration Naming Update (#4149)
* .NET: Restore AzureFunctions index parity with ConsoleApps under DurableAgents samples (#4221)
* Clean-up `05_host_your_agent`
* Config setting consistency
* Refine samples
* AGENTS.md
* Move new samples
* Re-order samples
* Move new project and fixup solution
* Fixup model config
* Fix up new UT project
---------
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
* Python: Fix Bedrock embedding test stub missing meta attribute (#4287)
* Fix Bedrock embedding test stub missing meta attribute
* Increase test coverage so gate passes
* Python: (ag-ui): fix approval payloads being re-processed on subsequent conversation turns (#4232)
* Fix ag-ui tool call issue
* Safe json fix
* Python: Update workflow orchestration samples to use AzureOpenAIResponsesClient (#4285)
* Update workflow orchestration samples to use AzureOpenAIResponsesClient
* Fix broken link
* Move scripts to scripts folder
---------
Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Rishabh Chawla <rishabhchawla1995@gmail.com>
Co-authored-by: Peter Ibekwe <109177538+peibekwe@users.noreply.github.com>
Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
Co-authored-by: Ben Thomas <ben.thomas@microsoft.com>
Co-authored-by: alliscode <bentho@microsoft.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
@crickman
Chris (crickman) deleted the copilot/rename-configuration-settings branch March 5, 2026 09:55
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationUsage: [Issues, PRs], Target: documentation in the code base and learn docs.NETUsage: [Issues, PRs], Target: .Net

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

@rogerbarreto@crickman@moonbox3@markwallace-microsoft