New-AzureRmNotificationHub
Creates a notification hub.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
New-AzureRmNotificationHub
[-ResourceGroup] <String>
[-Namespace] <String>
[-InputFile] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmNotificationHub
[-ResourceGroup] <String>
[-Namespace] <String>
[-NotificationHubObj] <NotificationHubAttributes>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-AzureRmNotificationHub cmdlet creates a notification hub. Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. Notification hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. The New-AzureRmNotificationHub cmdlet provides two ways to create a new notification hub. You can create an instance of the NotificationHubAttributes object and then configure that object. You can then copy those property values to your new hub by through the NotificationHubObj parameter. Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values by using the InputFile parameter. When used in conjunction with the New-AzureRmNotificationHub cmdlet, the preceding JSON sample creates a notification hub named ContosoNotificationHub located on the West US datacenter.
Examples
Example 1: Create a notification hub
PS C:\>New-AzureRmNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configurations\InternalHub.json"This command creates a notification hub in the namespace ContosoNamespace. The new hub will be assigned to the ContosoNotificationsGroup. You do not need to specify a name or any other configuration information for the hub; that information will be taken from the input file C:\Configurations\InternalHub.json.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputFile
Specifies the path to a JSON file containing configuration values for the new notification hub.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Namespace
Specifies the namespace to which the notification hub will be assigned. Namespaces provide a way to group and categorize notification hubs. Notification hubs must be assigned to an existing namespace. The New-AzureRmNotificationHub cmdlet cannot create a new namespace.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NotificationHubObj
Specifies the NotificationHubAttributes object that contains configuration information for the new hub.
| Type: | NotificationHubAttributes |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroup
Specifies the resource group to which the notification hub will be assigned. Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. You must use an existing resource group. The New-AzureRmNotificationHub cmdlet cannot create a new resource group.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |