ApiManagementUserCollection.GetAllAsync Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiManagementUserCollection.cs

Lists a collection of registered users in the specified service instance.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users
• Operation Id: User_ListByService
• Default Api Version: 2023-03-01-preview
• Resource: ApiManagementUserResource

public virtual Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.ApiManagementUserResource> GetAllAsync (string filter = default, int? top = default, int? skip = default, bool? expandGroups = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAllAsync : string * Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>
override this.GetAllAsync : string * Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>

Public Overridable Function GetAllAsync (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional expandGroups As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ApiManagementUserResource)

Parameters

filter

String

| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| registrationDate | filter | ge, le, eq, ne, gt, lt | |</br>| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| groups | expand | | |</br>.

top

Nullable<Int32>

Number of records to return.

skip

Nullable<Int32>

Number of records to skip.

expandGroups

Nullable<Boolean>

Detailed Group in response.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ApiManagementUserResource>

An async collection of ApiManagementUserResource that may take multiple service requests to iterate over.