How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Indexes API

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

Microsoft Azure Indexes API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Indexes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 12 operations across 8 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

12 operations 8 paths 33 schemas 1 DELETE6 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Indexes 12
GET
/indexes
Microsoft Azure Get Indexes
microsoftAzureIndexesListlatest 4 params → 200default
POST
/indexes
Microsoft Azure Post Indexes
microsoftAzureIndexesCreate 2 params body → 201default
GET
/indexes/{name}
Microsoft Azure Get Indexes Name
microsoftAzureIndexesGetlatest 2 params → 200default
POST
/indexes/{name}:getNextVersion
Microsoft Azure Post Indexes Name:getnextversion
microsoftAzureIndexesGetnextversion 2 params → 200default
GET
/indexes/{name}/versions
Microsoft Azure Get Indexes Name Versions
microsoftAzureIndexesList 8 params → 200default
GET
/indexes/{name}/versions/{version}
Microsoft Azure Get Indexes Name Versions Version
microsoftAzureIndexesGet 3 params → 200default
PUT
/indexes/{name}/versions/{version}
Microsoft Azure Put Indexes Name Versions Version
microsoftAzureIndexesCreateorupdate 3 params body → 200201default
PUT
/indexes('{indexName}')
Microsoft Azure Put Indexes Indexname
microsoftAzureIndexesCreateorupdate 7 params body → 200201default
DELETE
/indexes('{indexName}')
Microsoft Azure Delete Indexes Indexname
microsoftAzureIndexesDelete 5 params → 204404default
GET
/indexes('{indexName}')
Microsoft Azure Get Indexes Indexname
microsoftAzureIndexesGet 3 params → 200default
GET
/indexes('{indexName}')/search.stats
Microsoft Azure Get Indexes Indexname Search Stats
microsoftAzureIndexesGetstatistics 3 params → 200default
POST
/indexes('{indexName}')/search.analyze
Microsoft Azure Post Indexes Indexname Search Analyze
microsoftAzureIndexesAnalyze 3 params body → 200default

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are SearchIndex (13 properties), SearchField (13 properties), Index (7 properties), AnalyzeRequest (5 properties). Each schema is shown below with its type and property counts.

ScoringFunction
object
Base type for functions that can modify document scores during ranking.
4 properties 3 required
AzureActiveDirectoryApplicationCredentials
object
Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.
2 properties 1 required
ScoringFunctionAggregation
string
Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile.
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
Similarity
object
Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant…
1 property 1 required
TokenFilterName
string
Defines the names of all token filters supported by Azure Cognitive Search.
SearchResourceEncryptionKey
object
A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search,…
4 properties 3 required
SearchIndex
object
Represents a search index definition, which describes the fields and search behavior of an index.
13 properties 2 required
Index
object
Index resource Definition
7 properties 3 required
LexicalAnalyzerName
string
Defines the names of all text analyzers supported by Azure Cognitive Search.
LexicalAnalyzer
object
Base type for analyzers.
2 properties 2 required
TokenFilter
object
Base type for token filters.
2 properties 2 required
ScoringFunctionInterpolation
string
Defines the function used to interpolate score boosting across a range of documents.
AnalyzedTokenInfo
object
Information about a token returned by an analyzer.
4 properties 4 required
ScoringProfile
object
Defines parameters for a search index that influence scoring in search queries.
4 properties 1 required
GetIndexStatisticsResult
object
Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.
2 properties 2 required
Suggester
object
Defines how the Suggest API should apply to a group of fields in the index.
3 properties 3 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
VersionInfo
object
Next version definition.
2 properties 1 required
SearchError
object
Describes an error condition for the Azure Cognitive Search API.
3 properties 1 required
LexicalTokenizerName
string
Defines the names of all tokenizers supported by Azure Cognitive Search.
CharFilter
object
Base type for character filters.
2 properties 2 required
AnalyzeResult
object
The result of testing an analyzer on text.
1 property 1 required
SystemData
object
Metadata pertaining to creation and last modification of the resource.
4 properties
SearchField
object
Represents a field in an index definition, which describes the name, data type, and search behavior of a field.
13 properties 2 required
SearchFieldDataType
string
Defines the data type of a field in a search index.
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
TextWeights
object
Defines weights on index fields for which matches should boost scoring in search queries.
1 property 1 required
CorsOptions
object
Defines options to control Cross-Origin Resource Sharing (CORS) for an index.
2 properties 1 required
LexicalTokenizer
object
Base type for tokenizers.
2 properties 2 required
PagedIndex
object
Paged collection of IndexVersion items.
2 properties 1 required
AnalyzeRequest
object
Specifies some text and analysis components used to break that text into tokens.
5 properties 1 required
CharFilterName
string
Defines the names of all character filters supported by Azure Cognitive Search.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-indexes-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Indexes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.