Set-AzureRmApiManagementUser
ユーザーの詳細を設定します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRmApiManagementUser
-Context <PsApiManagementContext>
-UserId <String>
[-FirstName <String>]
[-LastName <String>]
[-Email <String>]
[-Password <SecureString>]
[-State <PsApiManagementUserState>]
[-Note <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Set-AzureRmApiManagementUser コマンドレットは、ユーザーの詳細を設定します。
例
例 1: ユーザーのパスワード、メール アドレス、状態を変更する
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"このコマンドは、新しいユーザー パスワードと電子メール アドレスを設定し、ユーザーをブロックします。
パラメーター
-Context
PsApiManagementContext オブジェクトを指定します。 このパラメーターは必須です。
| 型: | PsApiManagementContext |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
ユーザーのメール アドレスを指定します。 このパラメーターは省略可能です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FirstName
ユーザーの名を指定します。 このパラメーターの長さは 1 ~ 100 文字にする必要があります。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LastName
ユーザーの姓を指定します。 このパラメーターの長さは 1 ~ 100 文字にする必要があります。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Note
ユーザーに関するメモを指定します。 このパラメーターは省略可能です。 このパラメーターの既定値は$nullです。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Passthru
| 型: | SwitchParameter |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Password
ユーザー パスワードを指定します。 このパラメーターは省略可能です。
| 型: | SecureString |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-State
ユーザーの状態を指定します。 このパラメーターは省略可能です。 既定値は [アクティブ] です。
| 型: | PsApiManagementUserState |
| 承認された値: | Active, Blocked, Deleted, Pending |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UserId
ユーザー ID を指定します。 このパラメーターは必須です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |