Add-AzureRmApiManagementUserToGroup

NAME Add-AzureRmApiManagementUserToGroup



SYNOPSIS

Adds a user to a group.





SYNTAX

Add-AzureRmApiManagementUserToGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -GroupId <String> [-PassThru]

-UserId <String> [<CommonParameters>]





DESCRIPTION

The Add-AzureRmApiManagementUserToGroup cmdlet adds a user to a 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 group ID. This parameter is required.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

passthru



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-UserId <String>

Specifies the user 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

Boolean







NOTES









Example 1: Add a user to a group



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

PS C:\\>Add-AzureRmApiManagementUserToGroup -Context $apimContext -GroupId "0001" -UserId "0123456789"



This command adds an existing user to an existing group.







RELATED LINKS

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

Get-AzureRmApiManagementUser

Remove-AzureRmApiManagementUserFromGroup