Add-AzApiManagementUserToGroup

Module:

Az.ApiManagement

Adds a user to a group.

Syntax

PowerShell

Add-AzApiManagementUserToGroup
   -Context <PsApiManagementContext>
   -GroupId <String>
   -UserId <String>
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Add-AzApiManagementUserToGroup cmdlet adds a user to a group.

Examples

Example 1: Add a user to a group

PowerShell

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

This command adds an existing user to an existing 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 group ID. This parameter is required.

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

-PassThru

passthru

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

-UserId

Specifies the user ID. This parameter is required.

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

Inputs

PsApiManagementContext

String

SwitchParameter

Outputs

Boolean

Related Links

• Get-AzApiManagementUser
• Remove-AzApiManagementUserFromGroup