{Search} Add 2026-03-01-preview support#33268
Open
mattgotteiner wants to merge 3 commits intoAzure:devfrom
Open
{Search} Add 2026-03-01-preview support#33268mattgotteiner wants to merge 3 commits intoAzure:devfrom
mattgotteiner wants to merge 3 commits intoAzure:devfrom
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Validation for Azure CLI Full Test Starting...
Thanks for your contribution! |
mattgotteiner
requested review from
DanielMicrosoft,
Pan-Qi,
ReaNAiveD,
VeryEarly,
bebound,
jiasli,
jsntcy,
necusjz and
yonzhan
as code owners
|
Hi @mattgotteiner, |
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds initial Azure AI Search management-plane support for API version 2026-03-01-preview in the az search command module, aligning both generated AAZ (REST) commands and SDK-backed operations with the new preview surface.
Changes:
- Bump
azure-mgmt-searchdependency to9.2.x/9.2.0and force SDK clientapi_version='2026-03-01-preview'. - Update generated Search AAZ commands to use
api-version=2026-03-01-previewand add--knowledge-retrievaltosearch service create/update. - Add new AAZ command
az search offering listplus help entries and an implementation-plan markdown document.
Reviewed changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/azure-cli/setup.py | Bumps azure-mgmt-search dependency range to ~=9.2. |
| src/azure-cli/requirements.py3.windows.txt | Pins azure-mgmt-search==9.2.0 for Windows runtime. |
| src/azure-cli/requirements.py3.Linux.txt | Pins azure-mgmt-search==9.2.0 for Linux runtime. |
| src/azure-cli/requirements.py3.Darwin.txt | Pins azure-mgmt-search==9.2.0 for macOS runtime. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/usage/_show.py | Updates AAZ usage show operation to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/usage/_list.py | Updates AAZ usage list operation to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/shared_private_link_resource/_wait.py | Updates AAZ SPLR wait to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/shared_private_link_resource/_update.py | Updates AAZ SPLR update to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/shared_private_link_resource/_show.py | Updates AAZ SPLR show to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/shared_private_link_resource/_list.py | Updates AAZ SPLR list to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/shared_private_link_resource/_delete.py | Updates AAZ SPLR delete to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/shared_private_link_resource/_create.py | Updates AAZ SPLR create to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/query_key/_list.py | Updates AAZ query-key list to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/query_key/_delete.py | Updates AAZ query-key delete to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/query_key/_create.py | Updates AAZ query-key create to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/private_link_resource/_list.py | Updates AAZ private-link-resource list to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/private_endpoint_connection/_update.py | Updates AAZ PEC update to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/private_endpoint_connection/_show.py | Updates AAZ PEC show to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/private_endpoint_connection/_list.py | Updates AAZ PEC list to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/private_endpoint_connection/_delete.py | Updates AAZ PEC delete to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/network_security_perimeter_configuration/_show.py | Updates AAZ NSPC show to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/network_security_perimeter_configuration/_reconcile.py | Updates AAZ NSPC reconcile to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/network_security_perimeter_configuration/_list.py | Updates AAZ NSPC list to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/admin_key/_regenerate.py | Updates AAZ admin-key regenerate to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/admin_key/_list.py | Updates AAZ admin-key list to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_wait.py | Updates AAZ service wait to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_upgrade.py | Updates AAZ service upgrade to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_update.py | Updates AAZ service update to 2026-03-01-preview and adds --knowledge-retrieval. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_show.py | Updates AAZ service show to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_list.py | Updates AAZ service list to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_delete.py | Updates AAZ service delete to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_create.py | Updates AAZ service create to 2026-03-01-preview and adds --knowledge-retrieval. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/service/_check_name_availability.py | Updates AAZ name-availability check to 2026-03-01-preview. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/offering/_list.py | Adds new AAZ command az search offering list. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/offering/init.py | Exposes the new offering command group and commands. |
| src/azure-cli/azure/cli/command_modules/search/aaz/latest/search/offering/__cmd_group.py | Adds new AAZ command group search offering. |
| src/azure-cli/azure/cli/command_modules/search/_help.py | Adds help entries for search offering and search offering list. |
| src/azure-cli/azure/cli/command_modules/search/_client_factory.py | Forces SDK-backed Search client to use api_version='2026-03-01-preview'. |
| search-api-version-update.md | Adds implementation plan / API delta notes for reviewers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add live recordings for knowledge retrieval and offering list, expose knowledge retrieval in read schemas, update Search help text, and make the Search client factory API version configurable. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add live recordings for knowledge retrieval and offering list, expose knowledge retrieval in read schemas, update Search help text, and make the Search client factory API version configurable. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
mattgotteiner
requested review from
isra-fel,
notyashhh,
teresaritorto and
xuming-ms
as code owners
Member
Author
|
Addressed the Copilot review feedback in \�6b50f1983\: added \knowledgeRetrieval\ to read schemas, added live recordings for knowledge retrieval and offering list, regenerated latest help index, updated Azure AI Search wording/help/docstrings, made the Search client factory API version overrideable, and removed \search-api-version-update.md\ from the repo (moved to \C:\Users\magottei\source\scratch\search-api-version-update.md\). Also pushed the local AAZ dev-tools fixes used for generation to \mattgotteiner/aaz-dev-tools@51524a31\. |
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
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.
Related command
az searchDescription
Adds support for Azure AI Search management API
2026-03-01-preview.Changes included:
2025-05-01to2026-03-01-preview.az search offering listfor the newOfferings_Listoperation.--knowledge-retrievaltoaz search service create/updatefor the newknowledgeRetrievalservice property.knowledgeRetrievalin service read schemas.azure-mgmt-searchto9.2.0and passapi_version='2026-03-01-preview'through the Search Python SDK client factory with an overridable default.az search offering listand--knowledge-retrievalcreate/update coverage.AAZ tooling note: the local AAZ dev-tools fork at
mattgotteiner/aaz-dev-tools@51524a31was fixed so the Search 2026 command model can be generated frompackage-preview-2026-03-01. The generated raw model uses swagger-derived command names such assearch search-service, so this PR preserves the existing publicaz search servicesurface while applying the generated 2026 API/schema deltas.Testing Guide
py -3 -m compileall -q src\azure-cli\azure\cli\command_modules\searchpython scripts\generate_latest_indices.py verifypytest src\azure-cli\azure\cli\command_modules\search\tests\latest\test_offering.py::AzureSearchOfferingTests::test_offering_list src\azure-cli\azure\cli\command_modules\search\tests\latest\test_service.py::AzureSearchServicesTests::test_service_knowledge_retrieval -qAzure Search POC (magottei)subscription:AzureSearchOfferingTests.test_offering_listAzureSearchServicesTests.test_service_knowledge_retrievalHistory Notes
[Search]
az search: Add 2026-03-01-preview support.[Search]
az search offering list: Add command to list Azure AI Search offerings by region.[Search]
az search service create/update: Add--knowledge-retrievalto configure the agentic retrieval billing plan.