< Back

Set-AzureRmEventHubAuthorizationRule

Tue Jan 29, 2019 9:47 pm

NAME Set-AzureRmEventHubAuthorizationRule



SYNOPSIS

Updates the specified authorization rule on an Event Hub.





SYNTAX

Set-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> [-Name] <String> [[-InputObject]

<PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] {Listen | Send | Manage | Listen | Send | Manage}] [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [[-InputObject]

<PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] {Listen | Send | Manage | Listen | Send | Manage}] [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-InputObject] <PSSharedAccessAuthorizationRuleAttributes>

[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-Rights] {Listen | Send | Manage | Listen | Send | Manage}

[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-EventHub <String>

EventHub Name



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-InputObject <PSSharedAccessAuthorizationRuleAttributes>

AuthorizationRule Object



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

AuthorizationRule Name



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Namespace <String>

Namespace Name



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Resource Group Name



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Rights <String[]>

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



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes System.String[]





OUTPUTS

Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes







NOTES









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`.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... zationrule