Remove-SCSMSubscription
Remove-SCSMSubscription
Removes a subscription from Service Manager.
Syntax
Parameter Set: Default
Remove-SCSMSubscription [-Subscription] <Subscription[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCSMSubscription cmdlet removes a subscription from Service Manager.
Parameters
-Subscription<Subscription[]>
Specifies the object that represents the subscription that this cmldet removes.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Notifications.Subscriptions.Subscription
You can pipe a subscription to the Subscription parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
None.
This cmdlet does not generate any output.
Examples
Example 1: Delete subscriptions by using the display name
This command gets subscriptions that have display names that contain the string custom by using the Get-SCSMSubscription cmdlet. The command passes these subscriptions to the current cmdlet by using the pipeline operator. That cmdlet deletes each subscription.
PS C:\>Get-SCSMSubscription -DisplayName "custom*" | Remove-SCSMSubscription