SearchIndexClient.GetIndexesWithSelectedPropertiesAsync Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.1

Overloads

Name	Description
GetIndexesWithSelectedPropertiesAsync(IEnumerable<String>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, RequestContext)	[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.
GetIndexesWithSelectedPropertiesAsync(IEnumerable<String>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	Lists all indexes available for a search service.

GetIndexesWithSelectedPropertiesAsync(IEnumerable<String>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, 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> GetIndexesWithSelectedPropertiesAsync(System.Collections.Generic.IEnumerable<string> select, int? top, int? skip, bool? count, Azure.RequestContext context);

abstract member GetIndexesWithSelectedPropertiesAsync : seq<string> * Nullable<int> * Nullable<int> * Nullable<bool> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetIndexesWithSelectedPropertiesAsync : seq<string> * Nullable<int> * Nullable<int> * Nullable<bool> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetIndexesWithSelectedPropertiesAsync (select As IEnumerable(Of String), top As Nullable(Of Integer), skip As Nullable(Of Integer), count As Nullable(Of Boolean), context As RequestContext) As AsyncPageable(Of BinaryData)

Parameters

select

IEnumerable<String>

Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.

top

Nullable<Int32>

The number of items to retrieve. Default is 50, maximum is 1000.

skip

Nullable<Int32>

The number of items to skip.

count

Nullable<Boolean>

A value that specifies whether to fetch the total count of items. Default is false.

context

RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

AsyncPageable<BinaryData>

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

GetIndexesWithSelectedPropertiesAsync(IEnumerable<String>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

Source:

SearchIndexClient.cs

Lists all indexes available for a search service.

public virtual Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndexResponse> GetIndexesWithSelectedPropertiesAsync(System.Collections.Generic.IEnumerable<string> select = default, int? top = default, int? skip = default, bool? count = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndexesWithSelectedPropertiesAsync : seq<string> * Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndexResponse>
override this.GetIndexesWithSelectedPropertiesAsync : seq<string> * Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchIndexResponse>

Public Overridable Function GetIndexesWithSelectedPropertiesAsync (Optional select As IEnumerable(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional count As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SearchIndexResponse)

Parameters

select

IEnumerable<String>

Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.

top

Nullable<Int32>

The number of items to retrieve. Default is 50, maximum is 1000.

skip

Nullable<Int32>

The number of items to skip.

count

Nullable<Boolean>

A value that specifies whether to fetch the total count of items. Default is false.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

AsyncPageable<SearchIndexResponse>

Exceptions

RequestFailedException

Service returned a non-success status code.