Remove-AzApiManagementUserFromGroup

  • Reference
Module:
Az.ApiManagement

Removes a user from a group.

Syntax

Remove-AzApiManagementUserFromGroup
      -Context <PsApiManagementContext>
      -GroupId <String>
      -UserId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

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

Examples

Example 1: Remove a user from a group

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementUserFromGroup -Context $apimContext -GroupId "0001" -UserId "0123456789"

This command removes a user from a group.

Parameters

-Context

Specifies a PsApiManagementContext object. This parameter is required.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupId

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PsApiManagementContext

String

SwitchParameter

Outputs

Boolean