Edit

Share via

Get-AzNotificationHubListKey

Module:
Az.NotificationHubs Module

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

Syntax

Default (Default) 

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Namespace

Specifies the namespace to which the notification hub is assigned. Namespaces provide a way to group and categorize notification hubs.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys