New-AzureRmNotificationHubAuthorizationRules

Reference

Module:: AzureRM.NotificationHubs

Creates an authorization rule and assigns the rule to a notification hub.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmNotificationHubAuthorizationRules
   [-ResourceGroup] <String>
   [-Namespace] <String>
   [-NotificationHub] <String>
   [-InputFile] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzureRmNotificationHubAuthorizationRules
   [-ResourceGroup] <String>
   [-Namespace] <String>
   [-NotificationHub] <String>
   [-SASRule] <SharedAccessAuthorizationRuleAttributes>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmNotificationHubAuthorizationRules cmdlet creates a notification hub Shared Access Signature (SAS) authorization rule. Authorization rules are used to manage access to your notification hubs. This is done by the creation of links, as URIs, based on different permission levels. Clients are directed to one of these URIs based on the appropriate permission level. For example, a client given the Listen permission will be directed to the URI for that permission.

Examples

Example 1: Create a notification hub authorization rule

PS C:\>New-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -NotificationHub "ContosoInternalHub" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configuration\ExternalAccessRule.json"

This command creates a new authorization rule and assigns it to the notification hub named ContosoInternalHub. This hub is located in the ContosoNamespace namespace and is assigned to the ContosoNotificationsGroup resource group. Note that all the configuration information for the rule, including the rule name, will be taken from the input file C:\Configuration\ExternalAccessRule.json.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputFile

Specifies the input file for the authorization rule that this cmdlet creates.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Namespace

Specifies the namespace to which the authorization rules are assigned. Namespaces provide a way to group and categorize notification hubs.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-NotificationHub

Specifies the notification hub that the authorization rules will be assigned to. Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. Note that you must specify the name of an existing notification hub. The New-AzureRmNotificationHubAuthorizationRules cmdlet cannot create new notification hubs.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroup

Specifies the resource group that the notification hub is assigned to.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SASRule

Specifies the SharedAccessAuthorizationRuleAttributes object containing configuration information for the new rules.

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

Inputs

String

Outputs

SharedAccessAuthorizationRuleAttributes