Skip to content

New-AzEventHubApplicationGroup.md

Latest commit

 

History

History
273 lines (216 loc) · 7.21 KB

New-AzEventHubApplicationGroup.md

File metadata and controls

273 lines (216 loc) · 7.21 KB
Raw
external help file
Module Name Az.EventHub
online version https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubapplicationgroup
schema 2.0.0

New-AzEventHubApplicationGroup

SYNOPSIS

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>] [-Confirm] [-WhatIf] [<CommonParameters>]

CreateViaIdentityNamespace

New-AzEventHubApplicationGroup -Name <String> -NamespaceInputObject <IEventHubIdentity>
 -Parameter <IApplicationGroup> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

CreateViaIdentityNamespaceExpanded

New-AzEventHubApplicationGroup -Name <String> -NamespaceInputObject <IEventHubIdentity>
 [-ClientAppGroupIdentifier <String>] [-IsEnabled] [-Policy <IApplicationGroupPolicy[]>]
 [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<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)

Type: System.String
Parameter Sets: CreateExpanded, CreateViaIdentityNamespaceExpanded
Aliases:

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: CreateExpanded, CreateViaIdentityNamespaceExpanded
Aliases:

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

-Name

The Application Group name

Type: System.String
Parameter Sets: (All)
Aliases: ApplicationGroupName

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

-NamespaceInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: CreateViaIdentityNamespace, CreateViaIdentityNamespaceExpanded
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NamespaceName

The Namespace name

Type: System.String
Parameter Sets: CreateExpanded
Aliases:

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

-Parameter

The Application Group object

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IApplicationGroup
Parameter Sets: CreateViaIdentityNamespace
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: 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.

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IApplicationGroupPolicy[]
Parameter Sets: CreateExpanded, CreateViaIdentityNamespaceExpanded
Aliases:

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type: System.String
Parameter Sets: CreateExpanded
Aliases:

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

-SubscriptionId

The ID of the target subscription.

Type: System.String
Parameter Sets: CreateExpanded
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IApplicationGroup

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IApplicationGroup

NOTES

RELATED LINKS