Set-AzEventHubApplicationGroup
設定 EventHub 應用程式群組
Syntax
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>] Description
設定 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 會採用 Policy 物件的數位。
它代表在 appplication 群組上定義的整個節流原則集，而不只是一組節流原則。
如果您想要新增或移除節流原則，正確的方法是取得應用程式群組，並查詢傳回之物件的 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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientAppGroupIdentifier
應用程式群組的唯一標識碼。支援 SAS（SASKeyName=KeyName） 或 AAD（AADAppID=Guid）
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
執行 Cmdlet 之前先提示您確認。
| 類型: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。
| 類型: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
識別參數。 若要建構，請參閱 INPUTOBJECT 屬性的 NOTES 區段並建立哈希表。
| 類型: | IEventHubIdentity |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsEnabled
判斷是否允許應用程式群組建立命名空間的連線。 將isEnabled設定為 false 之後，就會卸除應用程式群組的所有現有連線，而且不允許任何新的連線
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
應用程式群組的名稱。
| 類型: | String |
| Aliases: | ApplicationGroupName |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NamespaceName
EventHub 命名空間的名稱
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
以異步方式執行命令
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Policy
定義應用程式群組行為的組策略清單。 這些原則可支持資源治理案例，例如限制輸入或輸出流量。 若要建構，請參閱 POLICY 屬性和建立哈希表的 NOTES 一節。
| 類型: | IApplicationGroupPolicy[] |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
資源群組的名稱。 名稱不區分大小寫。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
目標訂用帳戶的標識碼。
| 類型: | String |
| Position: | Named |
| 預設值: | (Get-AzContext).Subscription.Id |
| 必要: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。
| 類型: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |