Set-​Azure​Rm​Notification​Hubs​Namespace​Authorization​Rules

Sets authorization rules for a notification hub namespace.

Syntax

Set-AzureRmNotificationHubsNamespaceAuthorizationRules
   [-ResourceGroup] <String>
   [-Namespace] <String>
   [-SASRule] <SharedAccessAuthorizationRuleAttributes>
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]
Set-AzureRmNotificationHubsNamespaceAuthorizationRules
   [-ResourceGroup] <String>
   [-Namespace] <String>
   [-InputFile] <String>
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-AzureRmNotificationHubsNamespaceAuthorizationRules cmdlet modifies a Shared Access Signature (SAS) authorization rule assigned to a notification hub namespace. Authorization rules manage user rights to the namespace and to the notification hubs contained in that namespace.

This cmdlet provides two ways to modify an authorization rule assigned to a namespace. For one, you can create an instance of the SharedAccessAuthorizationRuleAttributes object and then configure that object with the property values you want the rule to possess. You can use the .NET Framework to accomplish this. You can then copy those property values to the rule through the SASRule parameter.

Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values through the InputFile parameter. A JSON file is a text file that uses syntax similar to this:

{
"Name": "ContosoAuthorizationRule",
"PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=",
"Rights": [
"Listen",
"Send"
]
}

When used in conjunction with the Set-AzureRmNotificationHubsNamespaceAuthorizationRules cmdlet, the preceding JSON sample modifies an authorization rule named ContosoAuthorizationRule to give users Listen and Send rights to the namespace.

Examples

Example 1: Modify an authorization rule assigned to a namespace

PS C:\>Set-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationGroup" -InputFile "C:\Configuration\AuthorizationRules.json"

This command modifies an authorization rule assigned to the namespace named ContosoNamespace. You must specify the resource group that the namespace is assigned to. Information about the authorization rule is not included in the command itself. Instead, that information is obtained from the input file C:\Configuration\AuthorizationRules.json.

Required Parameters

-InputFile

Specifies the path to a JSON file containing configuration information for the new rule.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Namespace

Specifies the namespace that contains the authorization rules that this cmdlet modifies. Namespaces provide a way to group and categorize notification hubs.

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

Specifies the resource group to which the namespace is assigned.Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration.

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

Specifies the SharedAccessAuthorizationRuleAttributes object that contains configuration information for the authorization rules that this cmdlet modifies.

Type:SharedAccessAuthorizationRuleAttributes
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional 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
-Force

Do not ask for confirmation.

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