SearchIndexClient.GetIndexes Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| GetIndexes(RequestContext) |
[Protocol Method] Lists all indexes available for a search service.
|
| GetIndexes(CancellationToken) |
Gets a list of all indexes. |
GetIndexes(RequestContext)
- Source:
- SearchIndexClient.cs
[Protocol Method] Lists all indexes available for a search service.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Pageable<BinaryData> GetIndexes(Azure.RequestContext context);abstract member GetIndexes : Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetIndexes : Azure.RequestContext -> Azure.Pageable<BinaryData>Public Overridable Function GetIndexes (context As RequestContext) As Pageable(Of BinaryData)Parameters
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
Service returned a non-success status code.
Applies to
GetIndexes(CancellationToken)
- Source:
- SearchIndexClient.cs
- Source:
- SearchIndexClient.cs
Gets a list of all indexes.
public virtual Azure.Pageable<Azure.Search.Documents.Indexes.Models.SearchIndex> GetIndexes(System.Threading.CancellationToken cancellationToken = default);abstract member GetIndexes : System.Threading.CancellationToken -> Azure.Pageable<Azure.Search.Documents.Indexes.Models.SearchIndex>
override this.GetIndexes : System.Threading.CancellationToken -> Azure.Pageable<Azure.Search.Documents.Indexes.Models.SearchIndex>Public Overridable Function GetIndexes (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SearchIndex)Parameters
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be canceled.
Returns
The Pageable<T> from the server containing a list of SearchIndex.
Exceptions
Thrown when a failure is returned by the Search service.
