Set-AzEventHubApplicationGroup

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     : SASKeyName=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 nimmt ein Array von Policy-Objekten an. Es stellt den gesamten Satz von Drosselungsrichtlinien dar, die für die Appplication-Gruppe definiert sind, und nicht nur die. Wenn Sie Einschränkungsrichtlinien hinzufügen oder entfernen möchten, besteht die richtige Methode darin, die Anwendungsgruppe abzurufen und den Richtliniendatenmember des zurückgegebenen Objekts abzufragen, wie oben gezeigt.

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     : SASKeyName=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
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
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
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
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 einer Hashtabelle.

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

-IsEnabled

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

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

-Name

Der Name der Anwendungsgruppe.

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

-NamespaceName

Der Name des EventHub-Namespace

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

-NoWait

Ausführen des Befehls asynchron

Type:SwitchParameter
Position:Named
Default value:None
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 des eingehenden oder ausgehenden Datenverkehrs. Informationen zum Erstellen finden Sie im Abschnitt NOTES für RICHTLINIENeigenschaften und Erstellen einer Hashtabelle.

Type:IApplicationGroupPolicy[]
Position:Named
Default value:None
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
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
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
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

IApplicationGroupPolicy[]

IEventHubIdentity

SwitchParameter

String

Ausgaben

IApplicationGroup

Hinweise

ALIASE

KOMPLEXE PARAMETEREIGENSCHAFTEN

Um die unten beschriebenen Parameter zu erstellen, erstellen Sie eine Hashtabelle mit den entsprechenden Eigenschaften. Um Informationen zu Hashtabellen zu erfahren, führen Sie Get-Help about_Hash_Tables aus.

INPUTOBJECT <IEventHubIdentity>: Identity-Parameter.

  • [Alias <String>]: Name der Konfiguration für die Notfallwiederherstellung
  • [ApplicationGroupName <String>]: Der Name der Anwendungsgruppe
  • [AuthorizationRuleName <String>]: Der Name der Autorisierungsregel.
  • [ClusterName <String>]: Der Name des Event Hubs-Clusters.
  • [ConsumerGroupName <String>]: Der Name der Consumergruppe
  • [EventHubName <String>]: Der Event Hub-Name
  • [Id <String>]: Ressourcenidentitätspfad
  • [NamespaceName <String>]: Der Namespacename
  • [PrivateEndpointConnectionName <String>]: Der Name von PrivateEndpointConnection
  • [ResourceAssociationName <String>]: Der Name der Ressourcenzuordnung
  • [ResourceGroupName <String>]: Name der Ressourcengruppe innerhalb des Azure-Abonnements.
  • [SchemaGroupName <String>]: Der Name der Schemagruppe
  • [SubscriptionId <String>]: Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

POLICY <IApplicationGroupPolicy[]>: Liste der Gruppenrichtlinien, die das Verhalten der Anwendungsgruppe definieren. Die Richtlinien können Ressourcengovernanceszenarien unterstützen, z. B. das Einschränken des eingehenden oder ausgehenden Datenverkehrs.

  • Name <String>: Der Name dieser Richtlinie