Set-AzureRmEventHubAuthorizationRule

Updates the specified authorization rule on an Event Hub.

Syntax

Set-AzureRmEventHubAuthorizationRule
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Name] <String>
   [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
   [[-Rights] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmEventHubAuthorizationRule
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-EventHub] <String>
   [-Name] <String>
   [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
   [[-Rights] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmEventHubAuthorizationRule
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-InputObject] <PSSharedAccessAuthorizationRuleAttributes>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureRmEventHubAuthorizationRule cmdlet updates the specified authorization rule on the given Event Hub.

Examples

Example 1

PS C:\> Set-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRuleName MyAuthRuleName -Rights @("Manage")

Updates the authorization rule `MyAuthRuleName` to grant Manage rights to the Event Hub `MyEventHubName`, scoped by the namespace `MyNamespaceName`.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EventHub

EventHub Name

Type:String
Aliases:EventHubName
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InputObject

AuthorizationRule Object

Type:PSSharedAccessAuthorizationRuleAttributes
Aliases:AuthRuleObj
Position:4
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

AuthorizationRule Name

Type:String
Aliases:AuthorizationRuleName
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Namespace

Namespace Name

Type:String
Aliases:NamespaceName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Resource Group Name

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Rights

Rights, e.g. @("Listen","Send","Manage")

Type:System.String[]
Accepted values:Listen, Send, Manage
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

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

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

Inputs

String

PSSharedAccessAuthorizationRuleAttributes

Parameters: InputObject (ByValue)

System.String[]

Outputs

PSSharedAccessAuthorizationRuleAttributes