Get-AzureRmApiManagementUser
ユーザーまたはユーザーを取得します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、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 コマンドレットは、ユーザーが指定されていない場合は、指定されたユーザーまたはすべてのユーザーを取得します。
例
例 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 の インスタンスを指定します。
型: | PsApiManagementContext |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
ユーザーのメール アドレスを指定します。 このパラメーターを指定すると、このコマンドレットは電子メールでユーザーを検索します。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-FirstName
ユーザーの名を指定します。 このパラメーターを指定すると、このコマンドレットは名でユーザーを検索します。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-GroupId
グループ識別子を指定します。 指定した場合、このコマンドレットは指定されたグループ内のすべてのユーザーを検索します。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-LastName
ユーザーの姓を指定します。 指定した場合、このコマンドレットは姓でユーザーを検索します。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-State
ユーザーの状態を指定します。 指定した場合、このコマンドレットは、この状態のユーザーを検索します。 このパラメーターは省略可能です。
型: | Nullable<T>[PsApiManagementUserState] |
指定可能な値: | Active, Blocked, Deleted, Pending |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-UserId
ユーザー ID を指定します。 指定した場合、このコマンドレットは、この識別子によってユーザーを検索します。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]]