Set-AzEventHubApplicationGroup
Définit un groupe d’applications EventHub
Syntaxe
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
Définit un groupe d’applications EventHub
Exemples
Exemple 1 : Ajouter des stratégies de limitation à un groupe d’applications
$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
prend un tableau d’objets De stratégie.
Il représente l’ensemble des stratégies de limitation définies sur le groupe d’application et pas seulement sur celui-ci.
Si vous souhaitez ajouter ou supprimer des stratégies de limitation, la bonne façon de le faire consiste à obtenir le groupe d’applications et à interroger le membre de données de stratégie de l’objet retourné comme indiqué ci-dessus.
Exemple 2 : Mettre à jour le groupe d’applications à l’aide du jeu de paramètres 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
Désactive le groupe myAppGroup
d’applications .
Paramètres
-AsJob
Exécuter la commande en tant que travail
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ClientAppGroupIdentifier
Identificateur unique pour le groupe d’applications. Prend en charge SAS(SASKeyName=KeyName) ou AAD(AADAppID=Guid)
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Alias: | cf |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Type: | PSObject |
Alias: | AzureRMContext, AzureCredential |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-InputObject
Paramètre d’identité. Pour construire, consultez la section NOTES pour les propriétés INPUTOBJECT et créez une table de hachage.
Type: | IEventHubIdentity |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-IsEnabled
Détermine si le groupe d’applications est autorisé à créer une connexion avec l’espace de noms ou non. Une fois que l’isEnabled a la valeur false, toutes les connexions existantes du groupe d’applications sont supprimées et aucune nouvelle connexion n’est autorisée
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Name
Nom du groupe d’applications.
Type: | String |
Alias: | ApplicationGroupName |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-NamespaceName
Nom de l’espace de noms EventHub
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-NoWait
Exécuter la commande de manière asynchrone
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Policy
Liste des stratégies de groupe qui définissent le comportement du groupe d’applications. Les stratégies peuvent prendre en charge des scénarios de gouvernance des ressources tels que la limitation du trafic d’entrée ou de sortie.
Type: | IApplicationGroupPolicy[] |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ResourceGroupName
Nom du groupe de ressources. Le nom ne respecte pas la casse.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-SubscriptionId
ID de l’abonnement cible.
Type: | String |
Position: | Named |
Valeur par défaut: | (Get-AzContext).Subscription.Id |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-WhatIf
Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
Type: | SwitchParameter |
Alias: | wi |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |