ConfigurationClientExtensions.AsPages Method

Definition

Namespace:

Azure.Data.AppConfiguration

Assembly:

Azure.Data.AppConfiguration.dll

Package:

Azure.Data.AppConfiguration v1.5.0

Overloads

AsPages(AsyncPageable<ConfigurationSetting>, IEnumerable<MatchConditions>, String, Nullable<Int32>)	Enumerate the values a Page<T> at a time, if they satisfy the match conditions for each page. This can be used to efficiently check for changes to a cache of pages of settings. This may make multiple service requests.
AsPages(Pageable<ConfigurationSetting>, IEnumerable<MatchConditions>, String, Nullable<Int32>)	Enumerate the values a Page<T> at a time, if they satisfy the match conditions for each page. This can be used to efficiently check for changes to a cache of pages of settings. This may make multiple service requests.

AsPages(AsyncPageable<ConfigurationSetting>, IEnumerable<MatchConditions>, String, Nullable<Int32>)

Source:

ConfigurationClientExtensions.cs

Enumerate the values a Page<T> at a time, if they satisfy the match conditions for each page. This can be used to efficiently check for changes to a cache of pages of settings. This may make multiple service requests.

public static System.Collections.Generic.IAsyncEnumerable<Azure.Page<Azure.Data.AppConfiguration.ConfigurationSetting>> AsPages (this Azure.AsyncPageable<Azure.Data.AppConfiguration.ConfigurationSetting> pageable, System.Collections.Generic.IEnumerable<Azure.MatchConditions> conditions, string continuationToken = default, int? pageSizeHint = default);

static member AsPages : Azure.AsyncPageable<Azure.Data.AppConfiguration.ConfigurationSetting> * seq<Azure.MatchConditions> * string * Nullable<int> -> System.Collections.Generic.IAsyncEnumerable<Azure.Page<Azure.Data.AppConfiguration.ConfigurationSetting>>

<Extension()>
Public Function AsPages (pageable As AsyncPageable(Of ConfigurationSetting), conditions As IEnumerable(Of MatchConditions), Optional continuationToken As String = Nothing, Optional pageSizeHint As Nullable(Of Integer) = Nothing) As IAsyncEnumerable(Of Page(Of ConfigurationSetting))

Parameters

pageable

AsyncPageable<ConfigurationSetting>

The pageable object.

conditions

IEnumerable<MatchConditions>

The match conditions. Conditions are applied to pages one by one in enumeration order.

continuationToken

String

A continuation token indicating where to resume paging or null to begin paging from the beginning.

pageSizeHint

Nullable<Int32>

The number of items per Page<T> that should be requested (from service operations that support it). It's not guaranteed that the value will be respected.

Returns

IAsyncEnumerable<Page<ConfigurationSetting>>

An async sequence of Page<T>s.

Exceptions

InvalidOperationException

Thrown if the pageable used does not support this operation. Only objects returned by the GetConfigurationSettingsAsync(SettingSelector, CancellationToken) support it.

AsPages(Pageable<ConfigurationSetting>, IEnumerable<MatchConditions>, String, Nullable<Int32>)

Source:

ConfigurationClientExtensions.cs

Enumerate the values a Page<T> at a time, if they satisfy the match conditions for each page. This can be used to efficiently check for changes to a cache of pages of settings. This may make multiple service requests.

public static System.Collections.Generic.IEnumerable<Azure.Page<Azure.Data.AppConfiguration.ConfigurationSetting>> AsPages (this Azure.Pageable<Azure.Data.AppConfiguration.ConfigurationSetting> pageable, System.Collections.Generic.IEnumerable<Azure.MatchConditions> conditions, string continuationToken = default, int? pageSizeHint = default);

static member AsPages : Azure.Pageable<Azure.Data.AppConfiguration.ConfigurationSetting> * seq<Azure.MatchConditions> * string * Nullable<int> -> seq<Azure.Page<Azure.Data.AppConfiguration.ConfigurationSetting>>

<Extension()>
Public Function AsPages (pageable As Pageable(Of ConfigurationSetting), conditions As IEnumerable(Of MatchConditions), Optional continuationToken As String = Nothing, Optional pageSizeHint As Nullable(Of Integer) = Nothing) As IEnumerable(Of Page(Of ConfigurationSetting))

Parameters

pageable

Pageable<ConfigurationSetting>

The pageable object.

conditions

IEnumerable<MatchConditions>

The match conditions. Conditions are applied to pages one by one in enumeration order.

continuationToken

String

A continuation token indicating where to resume paging or null to begin paging from the beginning.

pageSizeHint

Nullable<Int32>

The number of items per Page<T> that should be requested (from service operations that support it). It's not guaranteed that the value will be respected.

Returns

IEnumerable<Page<ConfigurationSetting>>

A sequence of Page<T>s.

Exceptions

InvalidOperationException

Thrown if the pageable used does not support this operation. Only objects returned by the GetConfigurationSettings(SettingSelector, CancellationToken) support it.