< Back
Remove-AzureRmApiManagementGroup
Post
NAME Remove-AzureRmApiManagementGroup
SYNOPSIS
Removes an existing API management group.
SYNTAX
Remove-AzureRmApiManagementGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -GroupId <String> [-PassThru]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmApiManagementGroup cmdlet removes an existing API management group.
PARAMETERS
-Context <PsApiManagementContext>
Specifies the instance of a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GroupId <String>
Specifies the identifier of a management group.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Boolean
NOTES
Example 1: Remove an existing management group
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ementgroup
Get-AzureRmApiManagementGroup
New-AzureRmApiManagementGroup
Set-AzureRmApiManagementGroup
SYNOPSIS
Removes an existing API management group.
SYNTAX
Remove-AzureRmApiManagementGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -GroupId <String> [-PassThru]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmApiManagementGroup cmdlet removes an existing API management group.
PARAMETERS
-Context <PsApiManagementContext>
Specifies the instance of a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GroupId <String>
Specifies the identifier of a management group.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Boolean
NOTES
Example 1: Remove an existing management group
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ementgroup
Get-AzureRmApiManagementGroup
New-AzureRmApiManagementGroup
Set-AzureRmApiManagementGroup