Set-AzEventHubApplicationGroup

  • Referenz
Modul:
Az.EventHub

Legt eine EventHub-Anwendungsgruppe fest

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>]

Beschreibung

Legt eine EventHub-Anwendungsgruppe fest

Beispiele

Beispiel 1: Hinzufügen von Einschränkungsrichtlinien zu einer Anwendungsgruppe

$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 verwendet ein Array von Richtlinienobjekten. Sie stellt den gesamten Satz von Einschränkungsrichtlinien dar, die für die Appplication-Gruppe und nicht nur für die Drosselung definiert sind. Wenn Sie Einschränkungsrichtlinien hinzufügen oder entfernen möchten, besteht die richtige Methode darin, die Anwendungsgruppe abzurufen und das Richtliniendatenelement des zurückgegebenen Objekts wie oben gezeigt abzufragen.

Beispiel 2: Aktualisieren der Anwendungsgruppe mithilfe des InputObject-Parametersatzes

$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

Deaktiviert die Anwendungsgruppe myAppGroup.

Parameter

-AsJob

Ausführen des Befehls als Auftrag

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

-ClientAppGroupIdentifier

Der eindeutige Bezeichner für die Anwendungsgruppe. Unterstützt SAS(SASKeyName=KeyName) oder AAD(AADAppID=Guid)

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity-Parameter. Informationen zum Erstellen finden Sie im Abschnitt "NOTES" für INPUTOBJECT-Eigenschaften und erstellen eine Hashtabelle.

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

-IsEnabled

Bestimmt, ob die Anwendungsgruppe eine Verbindung mit dem Namespace erstellen darf oder nicht. Sobald "isEnabled" auf "false" festgelegt ist, werden alle vorhandenen Verbindungen der Anwendungsgruppe gelöscht, und es sind keine neuen Verbindungen zulässig.

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

-Name

Der Name der Anwendungsgruppe.

Type:String
Aliases:ApplicationGroupName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NamespaceName

Der Name des EventHub-Namespace

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

-NoWait

Asynchrones Ausführen des Befehls

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

-Policy

Liste der Gruppenrichtlinien, die das Verhalten der Anwendungsgruppe definieren. Die Richtlinien können Ressourcengovernanceszenarien unterstützen, z. B. das Einschränken von Eingangs- oder Ausgangsdatenverkehr. Informationen zum Erstellen finden Sie im Abschnitt "NOTES" für RICHTLINIENeigenschaften und erstellen eine Hashtabelle.

Type:IApplicationGroupPolicy[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

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

-SubscriptionId

Hierbei handelt es sich um die ID des Zielabonnements.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

IApplicationGroupPolicy[]

IEventHubIdentity

SwitchParameter

String

Ausgaben

IApplicationGroup