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

Get-AzureRmApiManagementUser

获取用户或用户。

警告

截至 2024 年 2 月 29 日,AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新,建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行,但它不再维护或受支持,但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导,请参阅我们的迁移资源

语法

Get-AzureRmApiManagementUser
   -Context <PsApiManagementContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmApiManagementUser
   -Context <PsApiManagementContext>
   [-UserId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmApiManagementUser
   -Context <PsApiManagementContext>
   [-FirstName <String>]
   [-LastName <String>]
   [-State <PsApiManagementUserState>]
   [-Email <String>]
   [-GroupId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Get-AzureRmApiManagementUser cmdlet 获取指定用户或所有用户(如果未指定用户)。

示例

示例 1:获取所有用户

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

此命令获取所有用户。

示例 2:按 ID 获取用户

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789"

此命令按 ID 获取用户。

示例:按姓氏获取用户

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -LastName "Fuller"

此命令可获取具有指定姓氏 Fuller 的用户。

示例 4:通过电子邮件获取用户

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -Email "user@contoso.com"

此命令获取具有指定电子邮件地址的用户。

示例 5:获取组中的所有用户

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -GroupId "0001"

此命令获取指定组中的所有用户。

参数

-Context

指定 PsApiManagementContext实例。

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

-DefaultProfile

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

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

-Email

指定用户的电子邮件地址。 如果指定此参数,则此 cmdlet 通过电子邮件查找用户。 此参数是可选的。

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

-FirstName

指定用户的名字。 如果指定此参数,则此 cmdlet 按名字查找用户。 此参数是可选的。

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

-GroupId

指定组标识符。 如果指定,此 cmdlet 将查找指定组中的所有用户。 此参数是可选的。

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

-LastName

指定用户的姓氏。 如果指定,则此 cmdlet 按姓氏查找用户。 此参数是可选的。

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

-State

指定用户状态。 如果指定,此 cmdlet 将查找处于此状态的用户。 此参数是可选的。

Type:Nullable<T>[PsApiManagementUserState]
Accepted values:Active, Blocked, Deleted, Pending
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

指定用户 ID。 如果指定,则此 cmdlet 通过此标识符查找用户。 此参数是可选的。

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

输入

PsApiManagementContext

String

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]]

输出

PsApiManagementUser