< Back
Get-AzureRmNotificationHub
Post
NAME Get-AzureRmNotificationHub
SYNOPSIS
Gets information about your notification hubs.
SYNTAX
Get-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [[-NotificationHub] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmNotificationHub cmdlet gets information about the notification hubs in a specified namespace and assigned to a specified resource
group. For example, you can get information for all the notification hubs in the namespace ContosoNamespace and assigned to the
ContosoNotificationsGroup resource group.
Alternatively, you can use the NotificationHub parameter to limit the returned data to information about a specific notification hub.
Notification hubs are used to send push notifications to multiple clients regardless of the platform, such as iOS, Android, Windows Phone 8, and
Windows Store, used by those clients. These hubs are roughly equivalent to individual apps and each of your apps will typically have its own
notification hub.
This cmdlet only gets information about the hub itself. Other cmdlets, such as Get-AzureRmNotificationHubAuthorizationRules,
Get-AzureRmNotificationHubListKeys, and Get-AzureRmNotificationHubPNSCredentials, are needed to get information about a hub's authorization rules,
connection strings, and platform notification service credentials.
PARAMETERS
-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 name of the notification hub that this cmdlet gets.
Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients.
Required? false
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
System.Collections.Generic.List`1[Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes]
NOTES
Example 1: Get information for all notification hubs in a specific namespace
PS C:\\>Get-AzureRmNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup"
This command gets information for all the notification hubs in the namespace named ContosoNamespace that have been assigned to the resource group
ContosoNotificationsGroup.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... icationhub
Get-AzureRmNotificationHubAuthorizationRules
Get-AzureRmNotificationHubListKeys
Get-AzureRmNotificationHubPNSCredentials
New-AzureRmNotificationHub
Remove-AzureRmNotificationHub
Set-AzureRmNotificationHubAuthorizationRules
SYNOPSIS
Gets information about your notification hubs.
SYNTAX
Get-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [[-NotificationHub] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmNotificationHub cmdlet gets information about the notification hubs in a specified namespace and assigned to a specified resource
group. For example, you can get information for all the notification hubs in the namespace ContosoNamespace and assigned to the
ContosoNotificationsGroup resource group.
Alternatively, you can use the NotificationHub parameter to limit the returned data to information about a specific notification hub.
Notification hubs are used to send push notifications to multiple clients regardless of the platform, such as iOS, Android, Windows Phone 8, and
Windows Store, used by those clients. These hubs are roughly equivalent to individual apps and each of your apps will typically have its own
notification hub.
This cmdlet only gets information about the hub itself. Other cmdlets, such as Get-AzureRmNotificationHubAuthorizationRules,
Get-AzureRmNotificationHubListKeys, and Get-AzureRmNotificationHubPNSCredentials, are needed to get information about a hub's authorization rules,
connection strings, and platform notification service credentials.
PARAMETERS
-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 name of the notification hub that this cmdlet gets.
Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients.
Required? false
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
System.Collections.Generic.List`1[Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes]
NOTES
Example 1: Get information for all notification hubs in a specific namespace
PS C:\\>Get-AzureRmNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup"
This command gets information for all the notification hubs in the namespace named ContosoNamespace that have been assigned to the resource group
ContosoNotificationsGroup.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... icationhub
Get-AzureRmNotificationHubAuthorizationRules
Get-AzureRmNotificationHubListKeys
Get-AzureRmNotificationHubPNSCredentials
New-AzureRmNotificationHub
Remove-AzureRmNotificationHub
Set-AzureRmNotificationHubAuthorizationRules