Class UserCreateParameterProperties
- java.lang.Object
-
- com.azure.resourcemanager.apimanagement.models.UserEntityBaseParameters
-
- com.azure.resourcemanager.apimanagement.fluent.models.UserCreateParameterProperties
-
public final class UserCreateParameterProperties extends UserEntityBaseParameters
Parameters supplied to the Create User operation.
-
-
Constructor Summary
Constructors Constructor Description UserCreateParameterProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AppType
appType()
Get the appType property: Determines the type of application which send the create user request.Confirmation
confirmation()
Get the confirmation property: Determines the type of confirmation e-mail that will be sent to the newly created user.String
email()
Get the email property: Email address.String
firstName()
Get the firstName property: First name.String
lastName()
Get the lastName property: Last name.String
password()
Get the password property: User Password.void
validate()
Validates the instance.UserCreateParameterProperties
withAppType(AppType appType)
Set the appType property: Determines the type of application which send the create user request.UserCreateParameterProperties
withConfirmation(Confirmation confirmation)
Set the confirmation property: Determines the type of confirmation e-mail that will be sent to the newly created user.UserCreateParameterProperties
withEmail(String email)
Set the email property: Email address.UserCreateParameterProperties
withFirstName(String firstName)
Set the firstName property: First name.UserCreateParameterProperties
withIdentities(List<UserIdentityContractInner> identities)
Set the identities property: Collection of user identities.UserCreateParameterProperties
withLastName(String lastName)
Set the lastName property: Last name.UserCreateParameterProperties
withNote(String note)
Set the note property: Optional note about a user set by the administrator.UserCreateParameterProperties
withPassword(String password)
Set the password property: User Password.UserCreateParameterProperties
withState(UserState state)
Set the state property: Account state.-
Methods inherited from class com.azure.resourcemanager.apimanagement.models.UserEntityBaseParameters
identities, note, state
-
-
-
-
Method Detail
-
email
public String email()
Get the email property: Email address. Must not be empty and must be unique within the service instance.- Returns:
- the email value.
-
withEmail
public UserCreateParameterProperties withEmail(String email)
Set the email property: Email address. Must not be empty and must be unique within the service instance.- Parameters:
email
- the email value to set.- Returns:
- the UserCreateParameterProperties object itself.
-
firstName
public String firstName()
Get the firstName property: First name.- Returns:
- the firstName value.
-
withFirstName
public UserCreateParameterProperties withFirstName(String firstName)
Set the firstName property: First name.- Parameters:
firstName
- the firstName value to set.- Returns:
- the UserCreateParameterProperties object itself.
-
lastName
public String lastName()
Get the lastName property: Last name.- Returns:
- the lastName value.
-
withLastName
public UserCreateParameterProperties withLastName(String lastName)
Set the lastName property: Last name.- Parameters:
lastName
- the lastName value to set.- Returns:
- the UserCreateParameterProperties object itself.
-
password
public String password()
Get the password property: User Password. If no value is provided, a default password is generated.- Returns:
- the password value.
-
withPassword
public UserCreateParameterProperties withPassword(String password)
Set the password property: User Password. If no value is provided, a default password is generated.- Parameters:
password
- the password value to set.- Returns:
- the UserCreateParameterProperties object itself.
-
appType
public AppType appType()
Get the appType property: Determines the type of application which send the create user request. Default is legacy portal.- Returns:
- the appType value.
-
withAppType
public UserCreateParameterProperties withAppType(AppType appType)
Set the appType property: Determines the type of application which send the create user request. Default is legacy portal.- Parameters:
appType
- the appType value to set.- Returns:
- the UserCreateParameterProperties object itself.
-
confirmation
public Confirmation confirmation()
Get the confirmation property: Determines the type of confirmation e-mail that will be sent to the newly created user.- Returns:
- the confirmation value.
-
withConfirmation
public UserCreateParameterProperties withConfirmation(Confirmation confirmation)
Set the confirmation property: Determines the type of confirmation e-mail that will be sent to the newly created user.- Parameters:
confirmation
- the confirmation value to set.- Returns:
- the UserCreateParameterProperties object itself.
-
withState
public UserCreateParameterProperties withState(UserState state)
Set the state property: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.- Overrides:
withState
in classUserEntityBaseParameters
- Parameters:
state
- the state value to set.- Returns:
- the UserEntityBaseParameters object itself.
-
withNote
public UserCreateParameterProperties withNote(String note)
Set the note property: Optional note about a user set by the administrator.- Overrides:
withNote
in classUserEntityBaseParameters
- Parameters:
note
- the note value to set.- Returns:
- the UserEntityBaseParameters object itself.
-
withIdentities
public UserCreateParameterProperties withIdentities(List<UserIdentityContractInner> identities)
Set the identities property: Collection of user identities.- Overrides:
withIdentities
in classUserEntityBaseParameters
- Parameters:
identities
- the identities value to set.- Returns:
- the UserEntityBaseParameters object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classUserEntityBaseParameters
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-