Get-AzNotificationHubListKey

  • Reference
Module:
Az.NotificationHubs

Gets the primary and secondary connection strings associated with a notification hub authorization rule.

Syntax

Get-AzNotificationHubListKey
   [-ResourceGroup] <String>
   [-Namespace] <String>
   [-NotificationHub] <String>
   [-AuthorizationRule] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzNotificationHubListKey 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.

Examples

Example 1: Get the primary and secondary connection strings for an authorization rule

Get-AzNotificationHubListKey -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.

Parameters

-AuthorizationRule

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

-DefaultProfile

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

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

-Namespace

Specifies the namespace to which the notification hub is 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 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:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroup

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.

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

Inputs

String

Outputs

ResourceListKeys