WebPubSubTrafficThrottleByJwtCustomClaimRule Class

Definition

Throttle the client traffic by a custom JWT claim.

public class WebPubSubTrafficThrottleByJwtCustomClaimRule : Azure.ResourceManager.WebPubSub.Models.WebPubSubClientTrafficControlRule, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.WebPubSub.Models.WebPubSubTrafficThrottleByJwtCustomClaimRule>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.WebPubSub.Models.WebPubSubTrafficThrottleByJwtCustomClaimRule>
type WebPubSubTrafficThrottleByJwtCustomClaimRule = class
    inherit WebPubSubClientTrafficControlRule
    interface IJsonModel<WebPubSubTrafficThrottleByJwtCustomClaimRule>
    interface IPersistableModel<WebPubSubTrafficThrottleByJwtCustomClaimRule>
Public Class WebPubSubTrafficThrottleByJwtCustomClaimRule
Inherits WebPubSubClientTrafficControlRule
Implements IJsonModel(Of WebPubSubTrafficThrottleByJwtCustomClaimRule), IPersistableModel(Of WebPubSubTrafficThrottleByJwtCustomClaimRule)
Inheritance
WebPubSubTrafficThrottleByJwtCustomClaimRule
Implements

Constructors

Name Description
WebPubSubTrafficThrottleByJwtCustomClaimRule(String)

Initializes a new instance of WebPubSubTrafficThrottleByJwtCustomClaimRule.

Properties

Name Description
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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<WebPubSubClientTrafficControlRule>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from WebPubSubClientTrafficControlRule)
IJsonModel<WebPubSubClientTrafficControlRule>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from WebPubSubClientTrafficControlRule)
IJsonModel<WebPubSubTrafficThrottleByJwtCustomClaimRule>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<WebPubSubTrafficThrottleByJwtCustomClaimRule>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<WebPubSubClientTrafficControlRule>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from WebPubSubClientTrafficControlRule)
IPersistableModel<WebPubSubClientTrafficControlRule>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from WebPubSubClientTrafficControlRule)
IPersistableModel<WebPubSubClientTrafficControlRule>.Write(ModelReaderWriterOptions) (Inherited from WebPubSubClientTrafficControlRule)
IPersistableModel<WebPubSubTrafficThrottleByJwtCustomClaimRule>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<WebPubSubTrafficThrottleByJwtCustomClaimRule>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<WebPubSubTrafficThrottleByJwtCustomClaimRule>.Write(ModelReaderWriterOptions)

Applies to