Remove-​Azure​Rm​Api​Management​Group

Removes an existing API management group.

Syntax

Remove-AzureRmApiManagementGroup
      -Context <PsApiManagementContext>
      -GroupId <String>
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-AzureRmApiManagementGroup cmdlet removes an existing API management group.

Examples

Example 1: Remove an existing management group

PS C:\>Remove-AzureRmApiManagementGroup -Context $APImContext -GroupId "Group0001" -Force

This command removes an existing management group named Group0001 and does not prompt the user for confirmation.

Required Parameters

-Context

Specifies the instance of a PsApiManagementContext object.

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

Specifies the identifier of a management group.

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
-PassThru

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

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

Boolean