Microsoft Azure Indexes API

The Indexes API from Microsoft Azure — 8 operation(s) for indexes.

Documentation GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /indexes List the latest version of each index asset · Microsoft Azure Get Indexes #

Ask an LLM

“How do I see the newest version of every index registered in my AI project?”

“Can I page through index assets with a top and skip limit?”

Tell an agent

List the latest version of each index in my project.

Show the first {top} indexes at their latest version.

POST /indexes Create a new search index · Microsoft Azure Post Indexes #

Ask an LLM

“How do I create an Azure AI Search index with my own fields?”

“Can I set scoring profiles and custom analyzers when I first create a search index?”

Tell an agent

Create search index {name} with fields {fields}.

Create a new index {name} using scoring profile {defaultScoringProfile} by default.

GET /indexes/{name} Get the latest version of an index asset · Microsoft Azure Get Indexes Name #

Ask an LLM

“How do I fetch the most recent version of a named index asset?”

“What is the current version of the index asset called 'product-docs'?”

Tell an agent

Get the latest version of index asset {name}.

Show me the newest registered version of {name}.

POST /indexes/{name}:getNextVersion Get the next version number for an index asset · Microsoft Azure Post Indexes Name:getnextversion #

Ask an LLM

“What version number should I use next when registering a new version of an index asset?”

“Can I ask the service for the next available index version before I create one?”

Tell an agent

Get the next version number for index asset {name}.

Tell me which version to use next for index {name}.

GET /indexes/{name}/versions List all versions of an index asset · Microsoft Azure Get Indexes Name Versions #

Ask an LLM

“How do I see the full version history of an index asset?”

“Can I list index versions filtered by tags or include archived ones?”

Tell an agent

List all versions of index asset {name} with view type {viewType}.

Show versions of index {name} tagged {tags}, view type {viewType}.

GET /indexes/{name}/versions/{version} Get a specific version of an index asset · Microsoft Azure Get Indexes Name Versions Version #

Ask an LLM

“How do I fetch one particular version of an index asset rather than the latest?”

“Where is the storage URI for version 3 of my index asset?”

Tell an agent

Get version {version} of index asset {name}.

Show the storage location of index {name} at version {version}.

PUT /indexes/{name}/versions/{version} Create or update an index asset version · Microsoft Azure Put Indexes Name Versions Version #

Ask an LLM

“How do I register a new version of an index asset pointing at a storage URI?”

“Can I update the stage or description of an existing index asset version?”

Tell an agent

Register version {version} of index asset {name} with id {id}, stage {stage} and storage URI {storageUri}.

Set the stage of index {name} version {version} to {stage}.

PUT /indexes('{indexName}') Create or update a search index definition · Microsoft Azure Put Indexes Indexname #

Ask an LLM

“How do I add fields to an existing search index or create it if missing?”

“Can I update a search index that requires taking it offline briefly?”

Tell an agent

Create or update search index {index} with fields {fields}, returning {prefer}.

Update search index {index} and allow downtime {allowIndexDowntime} so new analyzers apply.

DELETE /indexes('{indexName}') Delete a search index and its documents · Microsoft Azure Delete Indexes Indexname #

Ask an LLM

“What happens to my documents when I delete an Azure AI Search index?”

“Can a deleted search index be recovered?”

Tell an agent destructive · confirm first

Delete search index {index} and all its documents.

Permanently remove search index {index} only if its ETag matches {etag}.

GET /indexes('{indexName}') Get a search index definition · Microsoft Azure Get Indexes Indexname #

Ask an LLM

“How do I retrieve the field schema of an Azure AI Search index?”

“Which analyzers and scoring profiles does my search index use?”

Tell an agent

Get the definition of search index {index}.

Show the fields and suggesters configured on search index {index}.

GET /indexes('{indexName}')/search.stats Get document count and storage for a search index · Microsoft Azure Get Indexes Indexname Search Stats #

Ask an LLM

“How many documents are in my search index and how much storage does it use?”

“Where can I see storage usage statistics for a single search index?”

Tell an agent

Get document count and storage usage for search index {index}.

Show statistics for search index {index}.

POST /indexes('{indexName}')/search.analyze Test how an analyzer tokenizes text · Microsoft Azure Post Indexes Indexname Search Analyze #

Ask an LLM

“How can I see how a search analyzer breaks my text into tokens?”

“Can I test a custom tokenizer on sample text before using it in my index?”

Tell an agent

Analyze the text {text} in search index {index} using analyzer {analyzer}.

Show the tokens tokenizer {tokenizer} produces for {text} in index {index}.

Microsoft Azure Indexes API

Operations 12

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification