Set-AzureRmApiManagementUser

NAME Set-AzureRmApiManagementUser



SYNOPSIS

Sets user details.





SYNTAX

Set-AzureRmApiManagementUser -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Email <String>] [-FirstName <String>]

[-LastName <String>] [-Note <String>] [-PassThru] [-Password <SecureString>] [-State {Active | Blocked}] -UserId <String> [<CommonParameters>]





DESCRIPTION

The Set-AzureRmApiManagementUser cmdlet sets user details.





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



-Email <String>

Specifies the email address of the user. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-FirstName <String>

Specifies the first name of the user. This parameter must be 1 to 100 characters long.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LastName <String>

Specifies the last name of the user. This parameter is must be 1 to 100 characters long.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Note <String>

Specifies a note about the user. This parameter is optional. The default value of this parameter is $null.



Required? false

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



-Password <SecureString>

Specifies the user password. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-State <PsApiManagementUserState>

Specifies the user state. This parameter is optional. The default value is Active.



Required? false

Position? named

Default value None

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

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser







NOTES









Example 1: Change a user's password, email address and state



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

PS C:\\>$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force

PS C:\\>Set-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Email "patti.fuller@contoso.com" -Password $securePassword -State

"Blocked"



This command sets a new user password and email address and blocks the user.







RELATED LINKS

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

Get-AzureRmApiManagementUser

New-AzureRmApiManagementUser

Remove-AzureRmApiManagementUser