Skip to content

Latest commit

 

History

History
96 lines (71 loc) · 2.46 KB

New-AzEventHubThrottlingPolicyConfig.md

File metadata and controls

96 lines (71 loc) · 2.46 KB
external help file Module Name online version schema
Az.EventHub-help.xml
Az.EventHub
2.0.0

New-AzEventHubThrottlingPolicyConfig

SYNOPSIS

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

SYNTAX

New-AzEventHubThrottlingPolicyConfig -Name <String> -RateLimitThreshold <Int64> -MetricId <MetricId>
 [<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

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.MetricId
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name of Throttling Policy Config

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RateLimitThreshold

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

Type: System.Int64
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IThrottlingPolicy

NOTES

RELATED LINKS