Edit

Share via


New-AzEventHubThrottlingPolicyConfig

Constructs an IThrottlingPolicy object that can be fed as input to New-AzEventHubApplicationGroup or Set-AzEventHubApplicationGroup

Syntax

Default (Default)

New-AzEventHubThrottlingPolicyConfig
    -Name <String>
    -RateLimitThreshold <Int64>
    -MetricId <String>
    [<CommonParameters>]

Description

Constructs an IThrottlingPolicy object that can be fed as input to New-AzEventHubApplicationGroup or Set-AzEventHubApplicationGroup

Examples

Example 1: Constructs an IThrottlingPolicy object

New-AzEventHubThrottlingPolicyConfig -Name t1 -RateLimitThreshold 10000 -MetricId IncomingBytes
MetricId      Name RateLimitThreshold Type
--------      ---- ------------------ ----
IncomingBytes t1                10000 ThrottlingPolicy

Please refer examples for Set-AzEventHubApplicationGroup to know more.

Parameters

-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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Name of Throttling Policy Config

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RateLimitThreshold

The Threshold limit above which the application group will be throttled.Rate limit is always per second.

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

IThrottlingPolicy