TrafficThrottleByJwtCustomClaimRule interface

Package:

@azure/arm-signalr

Throttle the client traffic by a custom JWT claim

Extends

ClientTrafficControlRule

Properties

aggregationWindowInSeconds	The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.
claimName	The name of the claim in the JWT token. The message bytes with the same claim value will be aggregated. If the claim is not found in the token, the rule will be skipped.
maxInboundMessageBytes	Maximum accumulated inbound message bytes allowed for the same JWT signature within a time window. Clients with the same JWT claim will get disconnected if the message bytes exceeds this value. Default value is 1GB.
type

Property Details

aggregationWindowInSeconds

The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.

aggregationWindowInSeconds?: number

Property Value

number

claimName

The name of the claim in the JWT token. The message bytes with the same claim value will be aggregated. If the claim is not found in the token, the rule will be skipped.

claimName: string

Property Value

string

maxInboundMessageBytes

Maximum accumulated inbound message bytes allowed for the same JWT signature within a time window. Clients with the same JWT claim will get disconnected if the message bytes exceeds this value. Default value is 1GB.

maxInboundMessageBytes?: number

Property Value

number

type

type: "TrafficThrottleByJwtCustomClaimRule"

Property Value

"TrafficThrottleByJwtCustomClaimRule"