New-AzEventHubApplicationGroup
create an ApplicationGroup for a Namespace.
Syntax
CreateExpanded (Default)
New-AzEventHubApplicationGroup
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-ClientAppGroupIdentifier <String>]
[-IsEnabled]
[-Policy <IApplicationGroupPolicy[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityNamespaceExpanded
New-AzEventHubApplicationGroup
-Name <String>
-NamespaceInputObject <IEventHubIdentity>
[-ClientAppGroupIdentifier <String>]
[-IsEnabled]
[-Policy <IApplicationGroupPolicy[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityNamespace
New-AzEventHubApplicationGroup
-Name <String>
-NamespaceInputObject <IEventHubIdentity>
-Parameter <IApplicationGroup>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
create an ApplicationGroup for a Namespace.
Examples
Example 1: Create an application group with 2 Throttling policies
$t1 = New-AzEventHubThrottlingPolicyConfig -Name t1 -MetricId IncomingMessages -RateLimitThreshold 10000
$t2 = New-AzEventHubThrottlingPolicyConfig -Name t2 -MetricId OutgoingBytes -RateLimitThreshold 20000
New-AzEventHubApplicationGroup -NamespaceName myNamespace -ResourceGroupName myResourceGroup -Name myAppGroup -ClientAppGroupIdentifier NamespaceSASKeyName=a -Policy $t1,$t2
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"
}}
ResourceGroupName : myResourceGroup
Creates a new application group myAppGroup on namespace myNamespace with 2 throttling policies.
Parameters
-ClientAppGroupIdentifier
The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityNamespaceExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IsEnabled
Determines if Application Group is allowed to create connection with namespace or not.
Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityNamespaceExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The Application Group name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ApplicationGroupName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
CreateViaIdentityNamespaceExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityNamespace
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-NamespaceName
The Namespace name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Parameter
The Application Group object
Parameter properties
Parameter sets
CreateViaIdentityNamespace
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Policy
List of group policies that define the behavior of application group.
The policies can support resource governance scenarios such as limiting ingress or egress traffic.
Parameter properties
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CreateViaIdentityNamespaceExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Name of the resource group within the azure subscription.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
