Remove-AzureRmApiManagementUserFromGroup

NAME Remove-AzureRmApiManagementUserFromGroup



SYNOPSIS

Removes a user from a group.





SYNTAX

Remove-AzureRmApiManagementUserFromGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -GroupId <String>

[-PassThru] -UserId <String> [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmApiManagementUserFromGroup cmdlet removes a user from an existing group.





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 ID of the group from which to remove a user.



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



-UserId <String>

Specifies the ID of the user to remove from the group.



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 user from a group



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Remove-AzureRmApiManagementUserFromGroup -Context $apimContext -GroupId "0001" -UserId "0123456789"



This command removes a user from a group.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... rfromgroup

Add-AzureRmApiManagementUserToGroup

Get-AzureRmApiManagementUser