Share via

ThrottlingPolicy Class

  • Reference

Properties of the throttling policy.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.eventhub.v2022_01_01_preview.models._models_py3.ApplicationGroupPolicy
ThrottlingPolicy

Constructor

ThrottlingPolicy(*, name: str, rate_limit_threshold: int, metric_id: str | _models.MetricId, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The Name of this policy. Required.
rate_limit_threshold
int

The Threshold limit above which the application group will be throttled.Rate limit is always per second. Required.
metric_id
str or MetricId

Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal. Required. Known values are: "IncomingBytes", "OutgoingBytes", "IncomingMessages", and "OutgoingMessages".

Variables

Name Description
name
str

The Name of this policy. Required.
type
str or ApplicationGroupPolicyType

Application Group Policy types. Required. "ThrottlingPolicy"
rate_limit_threshold
int

The Threshold limit above which the application group will be throttled.Rate limit is always per second. Required.
metric_id
str or MetricId

Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal. Required. Known values are: "IncomingBytes", "OutgoingBytes", "IncomingMessages", and "OutgoingMessages".