Skip to content

Latest commit

 

History

History
170 lines (128 loc) · 4.53 KB

Remove-AzNotificationHub.md

File metadata and controls

170 lines (128 loc) · 4.53 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml
Az.NotificationHubs
62631E1C-FB43-4E87-82C2-159A9D1D4221
2.0.0

Remove-AzNotificationHub

SYNOPSIS

Removes an existing notification hub.

SYNTAX

Remove-AzNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-Force]
 [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-AzNotificationHub cmdlet removes an existing notification hub. Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. Platforms include, but are not limited to: iOS, Android, Windows Phone 8, and Windows Store. Notification hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. You can remove an existing notification hub by using the Remove-AzNotificationHub cmdlet. After a hub has been removed you can no longer use that hub to send push notifications to users.

EXAMPLES

Example 1: Remove a notification hub

Remove-AzNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub"

This command removes the notification hub named ContosoInternalHub. In order to remove the hub, you must specify the namespace where the hub is located as well as the resource group the hub is assigned to.

PARAMETERS

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Do not ask for confirmation.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NotificationHub

Specifies the notification hub to be removed. Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

OUTPUTS

System.Void

NOTES

RELATED LINKS

Get-AzNotificationHub

New-AzNotificationHub

Set-AzNotificationHub