Get-AzEventHubApplicationGroup
Gets an ApplicationGroup for a Namespace.
Syntax
Get-AzEventHubApplicationGroup
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzEventHubApplicationGroup
-Name <String>
-NamespaceInputObject <IEventHubIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzEventHubApplicationGroup
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzEventHubApplicationGroup
-InputObject <IEventHubIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets an ApplicationGroup for a Namespace.
Examples
Example 1: Get an application group from an EventHub namespace
Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup
ClientAppGroupIdentifier : NamespaceSASKeyName=RootManageSharedAccessKey
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/
myAppGroup
IsEnabled : True
Location : Central US
Name : myAppGroup
Policy : {{
"name": "throttlingPolicy1",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 10000,
"metricId": "OutgoingMessages"
}, {
"name": "throttlingPolicy2",
"type": "ThrottlingPolicy",
"rateLimitThreshold": 11111,
"metricId": "OutgoingBytes"
}}
ResourceGroupName : myResourceGroup
Gets details of application group myAppGroup
from namespace myNamespace
.
Example 2: Lists all application groups in an EventHub namespace
Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace
Lists all application groups from namespace myNamespace
.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter
Type: | IEventHubIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The Application Group name
Type: | String |
Aliases: | ApplicationGroupName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NamespaceInputObject
Identity Parameter
Type: | IEventHubIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NamespaceName
The Namespace name
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Name of the resource group within the azure subscription.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: | String[] |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell