你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzApiManagementUser

  • 参考
模块:
Az.ApiManagement

设置用户详细信息。

语法

Set-AzApiManagementUser
   -Context <PsApiManagementContext>
   -UserId <String>
   [-FirstName <String>]
   [-LastName <String>]
   [-Email <String>]
   [-Password <SecureString>]
   [-State <PsApiManagementUserState>]
   [-Note <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-AzApiManagementUser cmdlet 设置用户详细信息。

示例

示例 1：更改用户的密码、电子邮件地址和状态

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force
Set-AzApiManagementUser -Context $apimContext -UserId "0123456789" -Email "patti.fuller@contoso.com" -Password $securePassword -State "Blocked"

此命令设置新的用户密码和电子邮件地址，并阻止用户。

示例 2

设置用户详细信息。 （自动生成）

Set-AzApiManagementUser -Context <PsApiManagementContext> -Email 'patti.fuller@contoso.com' -FirstName 'Patti' -LastName 'Fuller' -Password <SecureString> -State Active -UserId '0123456789'

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-Context

指定 PsApiManagementContext 对象。 此参数是必需的。

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

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

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

-Email

指定用户的电子邮件地址。 此参数是可选的。

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

-FirstName

指定用户的名字。 此参数长度必须为 1 到 100 个字符。

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

-LastName

指定用户的姓氏。 此参数长度必须为 1 到 100 个字符。

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

-Note

指定有关用户的注释。 此参数是可选的。 此参数的默认值为$null。

Type:String
Position:Named
Default value:None
Required:False
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

-Password

指定用户密码。 此参数是可选的。

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

-State

指定用户状态。 此参数是可选的。 默认值为“活动”。

Type:PsApiManagementUserState
Accepted values:Active, Blocked, Deleted, Pending
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

指定用户 ID。 此参数是必需的。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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

输入

PsApiManagementContext

String

SecureString

PsApiManagementUserState

SwitchParameter

输出

PsApiManagementUser