< Back
Remove-AzureRmApiManagementProductFromGroup
Post
NAME Remove-AzureRmApiManagementProductFromGroup
SYNOPSIS
Removes a product from a group.
SYNTAX
Remove-AzureRmApiManagementProductFromGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -GroupId <String>
[-PassThru] -ProductId <String> [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmApiManagementProductFromGroup cmdlet removes a product from an existing group. In other words, this cmdlet removes the group
assignment from a product.
PARAMETERS
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object. This parameter is required.
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 group ID. This parameter is required.
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 $False, otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProductId <String>
Specifies the product ID. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.Boolean
NOTES
Example 1: Remove a product from a group
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Remove-AzureRmApiManagementProductFromGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789"
This command removes a product from an existing group.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tfromgroup
Add-AzureRmApiManagementProductToGroup
SYNOPSIS
Removes a product from a group.
SYNTAX
Remove-AzureRmApiManagementProductFromGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -GroupId <String>
[-PassThru] -ProductId <String> [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmApiManagementProductFromGroup cmdlet removes a product from an existing group. In other words, this cmdlet removes the group
assignment from a product.
PARAMETERS
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object. This parameter is required.
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 group ID. This parameter is required.
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 $False, otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProductId <String>
Specifies the product ID. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.Boolean
NOTES
Example 1: Remove a product from a group
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Remove-AzureRmApiManagementProductFromGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789"
This command removes a product from an existing group.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tfromgroup
Add-AzureRmApiManagementProductToGroup