< Back
Remove-AzureRmNotificationHubAuthorizationRules
Post
NAME Remove-AzureRmNotificationHubAuthorizationRules
SYNOPSIS
Removes an authorization rule from a notification hub.
SYNTAX
Remove-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-AuthorizationRule]
<String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmNotificationHubAuthorizationRules cmdlet removes a Shared Access Signature (SAS) authorization rule from a notification hub.
Authorization rules manage access to your notification hubs through the creation of links, as URIs, based on different permission levels.
Permission levels can be one of the following:
- Listen
- Send
- Manage
Clients are directed to one of these URIs based on the appropriate permission level. For instance, a client given the Listen permission will be
directed to the URI for that permission.
Removing an authorization rule also removes the corresponding user permission.
PARAMETERS
-AuthorizationRule <String>
Specifies the name of the SAS authentication rule that this cmdlet removes.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-Force [<SwitchParameter>]
Do not ask for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Namespace <String>
Specifies the namespace to which the notification hub is 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 the authorization rules are assigned to. Notification hubs are used to send push notifications to multiple
clients regardless of the platform.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroup <String>
Specifies the resource group to which the notification hub is assigned. Resource groups organize items such as namespaces, notification hubs,
and authorization rules in ways that help simply inventory management and Azure administration.
Required? true
Position? 0
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
None
This cmdlet does not accept any input.
OUTPUTS
NOTES
Example 1: Remove an authorization rule from a notification hub
PS C:\\>Remove-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -NotificationHub "ContosoExternalHub" -ResourceGroup
"ContosoNotificationsGroup" -AuthorizationRule "ListenRule"
This command removes the authorization rule named ListenRule from the notification hub named ContosoExternalHub. When you run this command you
must specify both the namespace and the resource group that the hub is assigned to.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ationrules
Get-AzureRmNotificationHubAuthorizationRules
New-AzureRmNotificationHubAuthorizationRules
Set-AzureRmNotificationHubAuthorizationRules
SYNOPSIS
Removes an authorization rule from a notification hub.
SYNTAX
Remove-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-AuthorizationRule]
<String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmNotificationHubAuthorizationRules cmdlet removes a Shared Access Signature (SAS) authorization rule from a notification hub.
Authorization rules manage access to your notification hubs through the creation of links, as URIs, based on different permission levels.
Permission levels can be one of the following:
- Listen
- Send
- Manage
Clients are directed to one of these URIs based on the appropriate permission level. For instance, a client given the Listen permission will be
directed to the URI for that permission.
Removing an authorization rule also removes the corresponding user permission.
PARAMETERS
-AuthorizationRule <String>
Specifies the name of the SAS authentication rule that this cmdlet removes.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-Force [<SwitchParameter>]
Do not ask for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Namespace <String>
Specifies the namespace to which the notification hub is 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 the authorization rules are assigned to. Notification hubs are used to send push notifications to multiple
clients regardless of the platform.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroup <String>
Specifies the resource group to which the notification hub is assigned. Resource groups organize items such as namespaces, notification hubs,
and authorization rules in ways that help simply inventory management and Azure administration.
Required? true
Position? 0
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
None
This cmdlet does not accept any input.
OUTPUTS
NOTES
Example 1: Remove an authorization rule from a notification hub
PS C:\\>Remove-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -NotificationHub "ContosoExternalHub" -ResourceGroup
"ContosoNotificationsGroup" -AuthorizationRule "ListenRule"
This command removes the authorization rule named ListenRule from the notification hub named ContosoExternalHub. When you run this command you
must specify both the namespace and the resource group that the hub is assigned to.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ationrules
Get-AzureRmNotificationHubAuthorizationRules
New-AzureRmNotificationHubAuthorizationRules
Set-AzureRmNotificationHubAuthorizationRules