Remove-​Azure​Rm​Api​Management​Product

Removes an existing API Management product.

Syntax

Remove-AzureRmApiManagementProduct
      -Context <PsApiManagementContext>
      [-DeleteSubscriptions]
      [-PassThru]
      -ProductId <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-AzureRmApiManagementProduct cmdlet removes an existing API Management product.

Examples

Example 1: Remove an existing product and all subscriptions

PS C:\>Remove-AzureRmApiManagementProduct -Context $APImContext -Id "0123456789" -DeleteSubscriptions -Force

This command removes an existing product and all subscriptions.

Required Parameters

-Context

Specifies an instance of the PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ProductId

Specifies the identifier of the existing product.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DeleteSubscriptions

Indicates whether to delete subscriptions to the product. If you do not set this parameter and subscriptions exists, an exception is thrown.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, if it fails.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

bool