SearchIndexClient.GetIndexesAsync 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 |
|---|---|
| GetIndexesAsync(String, Nullable<Int32>, String, RequestContext) |
[Protocol Method] Lists all indexes available for a search service.
|
| GetIndexesAsync(String, Nullable<Int32>, Nullable<ListingSearchType>, CancellationToken) |
Lists all indexes available for a search service. |
| GetIndexesAsync(CancellationToken) |
Gets a list of all indexes. |
GetIndexesAsync(String, Nullable<Int32>, String, 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.AsyncPageable<BinaryData> GetIndexesAsync(string search, int? pageSize, string searchType, Azure.RequestContext context);abstract member GetIndexesAsync : string * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetIndexesAsync : string * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>Public Overridable Function GetIndexesAsync (search As String, pageSize As Nullable(Of Integer), searchType As String, context As RequestContext) As AsyncPageable(Of BinaryData)Parameters
- search
- String
A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no narrowing is applied.
The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.
- searchType
- String
Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.
- 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
GetIndexesAsync(String, Nullable<Int32>, Nullable<ListingSearchType>, CancellationToken)
- Source:
- SearchIndexClient.cs
Lists all indexes available for a search service.
public virtual Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndex> GetIndexesAsync(string search = default, int? pageSize = default, Azure.Search.Documents.Indexes.Models.ListingSearchType? searchType = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetIndexesAsync : string * Nullable<int> * Nullable<Azure.Search.Documents.Indexes.Models.ListingSearchType> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndex>
override this.GetIndexesAsync : string * Nullable<int> * Nullable<Azure.Search.Documents.Indexes.Models.ListingSearchType> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndex>Public Overridable Function GetIndexesAsync (Optional search As String = Nothing, Optional pageSize As Nullable(Of Integer) = Nothing, Optional searchType As Nullable(Of ListingSearchType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SearchIndex)Parameters
- search
- String
A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no narrowing is applied.
The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.
- searchType
- Nullable<ListingSearchType>
Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
Service returned a non-success status code.
Applies to
GetIndexesAsync(CancellationToken)
- Source:
- SearchIndexClient.cs
- Source:
- SearchIndexClient.cs
Gets a list of all indexes.
public virtual Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndex> GetIndexesAsync(System.Threading.CancellationToken cancellationToken = default);public virtual Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndex> GetIndexesAsync(System.Threading.CancellationToken cancellationToken);abstract member GetIndexesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndex>
override this.GetIndexesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndex>Public Overridable Function GetIndexesAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SearchIndex)Public Overridable Function GetIndexesAsync (cancellationToken As CancellationToken) As AsyncPageable(Of SearchIndex)Parameters
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be canceled.
Returns
The AsyncPageable<T> from the server containing a list of SearchIndex.
Exceptions
Thrown when a failure is returned by the Search service.
