New-AzApiManagementUser
新しいユーザーを登録します。
構文
New-AzApiManagementUser
-Context <PsApiManagementContext>
[-UserId <String>]
-FirstName <String>
-LastName <String>
-Email <String>
-Password <SecureString>
[-State <PsApiManagementUserState>]
[-Note <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
New-AzApiManagementUser コマンドレットによって新しいユーザーが登録されます。
例
例 1: 新しいユーザーを登録する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$securePassword = ConvertTo-SecureString -String "****" -AsPlainText -Force
New-AzApiManagementUser -Context $apimContext -FirstName "Patti" -LastName "Fuller" -Email "Patti.Fuller@contoso.com" -Password $securePassword
このコマンドは、Patti Fuller という名前の新しいユーザーを登録します。
パラメーター
-Context
PsApiManagementContext オブジェクトを指定します。
型: | PsApiManagementContext |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
ユーザーのメール アドレスを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-FirstName
ユーザーの名を指定します。 このパラメーターの長さは 1 ~ 100 文字にする必要があります。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-LastName
ユーザーの姓を指定します。 このパラメーターの長さは 1 ~ 100 文字にする必要があります。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Note
ユーザーに関するメモを指定します。 このパラメーターは省略可能です。 既定値は $Null です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Password
ユーザー パスワードを指定します。 このパラメーターは必須です。
型: | SecureString |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-State
ユーザーの状態を指定します。 このパラメーターは省略可能です。 このパラメーターの既定値は $Null です。
型: | Nullable<T>[PsApiManagementUserState] |
指定可能な値: | Active, Blocked, Deleted, Pending |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-UserId
ユーザー ID を指定します。 このパラメーターは省略可能です。 このパラメーターが指定されていない場合、このコマンドレットはユーザー ID を生成します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
出力
関連リンク
Azure PowerShell