Office365UsersClient.SearchUserAsync Method

Definition

Search for users (V2)

public virtual Azure.AsyncPageable<Azure.Connectors.Sdk.Office365Users.Models.User> SearchUserAsync(string searchTerm = default, int? top = default, bool? isSearchTermRequired = default, System.Threading.CancellationToken cancellationToken = default);
abstract member SearchUserAsync : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Connectors.Sdk.Office365Users.Models.User>
override this.SearchUserAsync : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Connectors.Sdk.Office365Users.Models.User>
Public Overridable Function SearchUserAsync (Optional searchTerm As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional isSearchTermRequired As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of User)

Parameters

searchTerm
String

Search term

top
Nullable<Int32>

Top

isSearchTermRequired
Nullable<Boolean>

Is search term required

cancellationToken
CancellationToken

Cancellation token.

Returns

An async enumerable of User items across all pages.

Remarks

Retrieves the user profiles that match the search term (V2).

Applies to