< Back
Get-AzureRmNotificationHubsNamespaceAuthorizationRules
Post
NAME Get-AzureRmNotificationHubsNamespaceAuthorizationRules
SYNOPSIS
Gets information about the authorization rules associated with a notification hub namespace.
SYNTAX
Get-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [[-AuthorizationRule] <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmNotificationHubsNamespaceAuthorizationRules cmdlet returns information about the Shared Access Signature (SAS) authorization rules
associated with a notification hub namespace. You can return information about all the rules associated with the namespace. Alternatively, and by
including the AuthorizationRule parameter, you can return information for a specific rule.
Authorization rules manage access to namespaces. This is done through the creation of links, as URIs, based on different permission levels.
Platform 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.
This cmdlet only gets the authorization rules associated with a namespace. To get information about the namespace itself, use
Get-AzureRmNotificationHubsNamespace.
PARAMETERS
-AuthorizationRule <String>
Specifies the name of a SAS authentication rule. These rules determine the type of access that users have to the namespace.
Required? false
Position? 2
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
-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
-ResourceGroup <String>
Specifies the resource group to which the authorization rules are 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
<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
System.Collections.Generic.List`1[Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes]
NOTES
Example 1: Get information about all authorization rules assigned to namespaces
PS C:\\>Get-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup"
This command gets information about all the authorization rules assigned to both the namespace ContosoNamespace and the ContosoNotificationsGroup
resource group.
Example 2: Get information about an authorization rule
PS C:\\>Get-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup"
-AuthorizationRule "ListenRule"
This command gets information about a single namespace authorization rule named ListenRule. You must include the namespace and the resource group
when you get information for a specific authorization rule.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ationrules
Get-AzureRmNotificationHubsNamespace
New-AzureRmNotificationHubsNamespace
Remove-AzureRmNotificationHubsNamespace
Set-AzureRmNotificationHubsNamespace
SYNOPSIS
Gets information about the authorization rules associated with a notification hub namespace.
SYNTAX
Get-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> [[-AuthorizationRule] <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmNotificationHubsNamespaceAuthorizationRules cmdlet returns information about the Shared Access Signature (SAS) authorization rules
associated with a notification hub namespace. You can return information about all the rules associated with the namespace. Alternatively, and by
including the AuthorizationRule parameter, you can return information for a specific rule.
Authorization rules manage access to namespaces. This is done through the creation of links, as URIs, based on different permission levels.
Platform 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.
This cmdlet only gets the authorization rules associated with a namespace. To get information about the namespace itself, use
Get-AzureRmNotificationHubsNamespace.
PARAMETERS
-AuthorizationRule <String>
Specifies the name of a SAS authentication rule. These rules determine the type of access that users have to the namespace.
Required? false
Position? 2
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
-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
-ResourceGroup <String>
Specifies the resource group to which the authorization rules are 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
<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
System.Collections.Generic.List`1[Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes]
NOTES
Example 1: Get information about all authorization rules assigned to namespaces
PS C:\\>Get-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup"
This command gets information about all the authorization rules assigned to both the namespace ContosoNamespace and the ContosoNotificationsGroup
resource group.
Example 2: Get information about an authorization rule
PS C:\\>Get-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup"
-AuthorizationRule "ListenRule"
This command gets information about a single namespace authorization rule named ListenRule. You must include the namespace and the resource group
when you get information for a specific authorization rule.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ationrules
Get-AzureRmNotificationHubsNamespace
New-AzureRmNotificationHubsNamespace
Remove-AzureRmNotificationHubsNamespace
Set-AzureRmNotificationHubsNamespace