| external help file | Module Name | ms.assetid | online version | schema |
|---|---|---|---|---|
Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml |
AzureRM.NotificationHubs |
326C87EB-EC3B-4B04-B593-EAC56FFA854A |
2.0.0 |
Gets the primary and secondary connection strings associated with a notification hub authorization rule.
Get-AzureRmNotificationHubListKeys [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String>
[-AuthorizationRule] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
The Get-AzureRmNotificationHubListKeys cmdlet returns the primary and secondary connection strings of a notification hub Shared Access Signature (SAS) authorization rule. Authorization rules manage user rights to the hub. Each rule includes a primary and a secondary connection string. These connection strings (URIs) perform the following:
- Point users to a resource.
- Include a token containing query parameters. One of these parameters, the signature, is used to authenticate the user and provide the specified level of access.
PS C:\>Get-AzureRmNotificationHubListKeys -Namespace "ContosoNamespace" -NotificationHub "ContosoInternalHub" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule"
This command gets the primary and secondary connection strings for the authorization rule ListenRule, a rule assigned to the ContosoInternalHub notification hub. The command must include the hub namespace and resource group.
Specifies the name of a Shared Access Signature (SAS) authentication rule. These rules determine the type of access that users have to the notification hub.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe credentials, account, tenant, and subscription used for communication with azure
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the namespace to which the notification hub is assigned. Namespaces provide a way to group and categorize notification hubs.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the notification hub that this cmdlet assigns an authorization rule to. Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies 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.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).