< Back

Get-AzureRmNotificationHubListKeys

Tue Jan 29, 2019 9:59 pm

NAME Get-AzureRmNotificationHubListKeys



SYNOPSIS

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





SYNTAX

Get-AzureRmNotificationHubListKeys [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-AuthorizationRule] <String>

[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

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.







PARAMETERS

-AuthorizationRule <String>

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.



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



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



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



<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

Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys







NOTES









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



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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ublistkeys

Get-AzureRmNotificationHubAuthorizationRules