你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Set-AzEventHubApplicationGroup
设置 EventHub 应用程序组
语法
Set-AzEventHubApplicationGroup
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-ClientAppGroupIdentifier <String>]
[-IsEnabled]
[-Policy <IApplicationGroupPolicy[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzEventHubApplicationGroup
-InputObject <IEventHubIdentity>
[-ClientAppGroupIdentifier <String>]
[-IsEnabled]
[-Policy <IApplicationGroupPolicy[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
设置 EventHub 应用程序组
示例
示例 1:向应用程序组添加限制策略
$t3 = New-AzEventHubThrottlingPolicyConfig -Name t3 -MetricId OutgoingMessages -RateLimitThreshold 12000
$appGroup = Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup
$appGroup.Policy += $t3
Set-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup -Policy $appGroup.Policy
ClientAppGroupIdentifier : NamespaceSASKeyName=a
Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/
myAppGroup
IsEnabled : True
Location : Central US
Name : myAppGroup
Policy : {{
"name": "t1",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 10000,
"metricId": "IncomingMessages"
}, {
"name": "t2",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 20000,
"metricId": "OutgoingBytes"
}, {
"name": "t3",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 12000,
"metricId": "OutgoingMessages"
}}
ResourceGroupName : myResourceGroup
-Policy
采用策略对象的数组。
它表示在应用组上定义的整个限制策略集,而不仅仅是限制策略集。
如果要添加或删除限制策略,正确的方法是获取应用程序组并查询返回的对象的策略数据成员,如上所示。
示例 2:使用 InputObject 参数集更新应用程序组
$appGroup = Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup
Set-AzEventHubApplicationGroup -InputObject $appGroup -IsEnabled:$false
ClientAppGroupIdentifier : NamespaceSASKeyName=a
Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/
myAppGroup
IsEnabled : False
Location : Central US
Name : myAppGroup
Policy : {{
"name": "t1",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 10000,
"metricId": "IncomingMessages"
}, {
"name": "t2",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 20000,
"metricId": "OutgoingBytes"
}, {
"name": "t3",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 12000,
"metricId": "OutgoingMessages"
}}
ResourceGroupName : myResourceGroup
禁用应用程序组 myAppGroup
。
参数
-AsJob
以作业身份运行命令
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ClientAppGroupIdentifier
应用程序组的唯一标识符。支持 SAS(SASKeyName=KeyName) 或 AAD(AADAppID=Guid)
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Confirm
提示你在运行 cmdlet 之前进行确认。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
类型: | PSObject |
别名: | AzureRMContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-InputObject
标识参数。 若要构造,请参阅 INPUTOBJECT 属性的 NOTES 部分并创建哈希表。
类型: | IEventHubIdentity |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-IsEnabled
确定是否允许应用程序组与命名空间建立连接。 将 isEnabled 设置为 false 后,将删除应用程序组的所有现有连接,并且不允许任何新连接
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Name
应用程序组的名称。
类型: | String |
别名: | ApplicationGroupName |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-NamespaceName
EventHub 命名空间的名称
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-NoWait
异步运行命令
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Policy
定义应用程序组行为的组策略列表。 这些策略可以支持资源治理方案,例如限制入口或出口流量。
类型: | IApplicationGroupPolicy[] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ResourceGroupName
资源组的名称。 此名称不区分大小写。
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-SubscriptionId
目标订阅的 ID。
类型: | String |
Position: | Named |
默认值: | (Get-AzContext).Subscription.Id |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
类型: | SwitchParameter |
别名: | wi |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |