WebPubSubTrafficThrottleByUserIdRule Class

Definition

Throttle the client traffic by the user ID.

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

Constructors

Name Description
WebPubSubTrafficThrottleByUserIdRule()

Initializes a new instance of WebPubSubTrafficThrottleByUserIdRule.

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.

MaxInboundMessageBytes

Maximum accumulated inbound message bytes allowed for the same user ID within a time window. Clients with the same user ID 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<WebPubSubTrafficThrottleByUserIdRule>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<WebPubSubTrafficThrottleByUserIdRule>.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<WebPubSubTrafficThrottleByUserIdRule>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<WebPubSubTrafficThrottleByUserIdRule>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<WebPubSubTrafficThrottleByUserIdRule>.Write(ModelReaderWriterOptions)

Applies to