Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

RateLimiterOptionsExtensions Class

Definition

Namespace:
Microsoft.AspNetCore.RateLimiting
Assembly:
Microsoft.AspNetCore.RateLimiting.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.RateLimiting v7.0.0-rc.2.22476.2
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
RateLimiterOptionsExtensions.cs

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.

Extension methods for the RateLimiting middleware options.

public static class RateLimiterOptionsExtensions
type RateLimiterOptionsExtensions = class
Public Module RateLimiterOptionsExtensions
Inheritance
RateLimiterOptionsExtensions

Methods

Name Description
AddConcurrencyLimiter(RateLimiterOptions, String, Action<ConcurrencyLimiterOptions>)

Registers a new ConcurrencyLimiter with the given ConcurrencyLimiterOptions to the application. The limiter can be added to an endpoint via RequireRateLimiting<TBuilder>(TBuilder, String), or via the EnableRateLimitingAttribute.
AddFixedWindowLimiter(RateLimiterOptions, String, Action<FixedWindowRateLimiterOptions>)

Registers a new FixedWindowRateLimiter with the given FixedWindowRateLimiterOptions to the application. The limiter can be added to an endpoint via RequireRateLimiting<TBuilder>(TBuilder, String), or via the EnableRateLimitingAttribute.
AddSlidingWindowLimiter(RateLimiterOptions, String, Action<SlidingWindowRateLimiterOptions>)

Registers a new SlidingWindowRateLimiter with the given SlidingWindowRateLimiterOptions to the application. The limiter can be added to an endpoint via RequireRateLimiting<TBuilder>(TBuilder, String), or via the EnableRateLimitingAttribute.
AddTokenBucketLimiter(RateLimiterOptions, String, Action<TokenBucketRateLimiterOptions>)

Registers a new TokenBucketRateLimiter with the given TokenBucketRateLimiterOptions to the application. The limiter can be added to an endpoint via RequireRateLimiting<TBuilder>(TBuilder, String), or via the EnableRateLimitingAttribute.

Applies to

Feedback

Was this page helpful?