< Back
New-AzureRmNotificationHubAuthorizationRules
Post
NAME New-AzureRmNotificationHubAuthorizationRules
SYNOPSIS
Creates an authorization rule and assigns the rule to a notification hub.
SYNTAX
New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-InputFile] <String>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-SASRule]
<SharedAccessAuthorizationRuleAttributes> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<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.
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
-InputFile <String>
Specifies the input file for the authorization rule that this cmdlet creates.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Namespace <String>
Specifies the namespace to which the authorization rules are assigned. Namespaces provide a way to group and categorize notification hubs.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NotificationHub <String>
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.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroup <String>
Specifies the resource group that the notification hub is assigned to.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SASRule <SharedAccessAuthorizationRuleAttributes>
Specifies the SharedAccessAuthorizationRuleAttributes object containing configuration information for the new rules.
Required? true
Position? 3
Default value None
Accept pipeline input? False
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ationrules
Get-AzureRmNotificationHubAuthorizationRules
Remove-AzureRmNotificationHubAuthorizationRules
Set-AzureRmNotificationHubAuthorizationRules
SYNOPSIS
Creates an authorization rule and assigns the rule to a notification hub.
SYNTAX
New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-InputFile] <String>
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-SASRule]
<SharedAccessAuthorizationRuleAttributes> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<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.
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
-InputFile <String>
Specifies the input file for the authorization rule that this cmdlet creates.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Namespace <String>
Specifies the namespace to which the authorization rules are assigned. Namespaces provide a way to group and categorize notification hubs.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NotificationHub <String>
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.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroup <String>
Specifies the resource group that the notification hub is assigned to.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SASRule <SharedAccessAuthorizationRuleAttributes>
Specifies the SharedAccessAuthorizationRuleAttributes object containing configuration information for the new rules.
Required? true
Position? 3
Default value None
Accept pipeline input? False
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ationrules
Get-AzureRmNotificationHubAuthorizationRules
Remove-AzureRmNotificationHubAuthorizationRules
Set-AzureRmNotificationHubAuthorizationRules