228 строки
17 KiB
YAML
228 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters"
|
|
name: "UserCreateParameters"
|
|
nameWithType: "UserCreateParameters"
|
|
summary: "User create details."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **UserCreateParameters**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.UserCreateParameters()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.UserCreateParameters()"
|
|
name: "UserCreateParameters()"
|
|
nameWithType: "UserCreateParameters.UserCreateParameters()"
|
|
syntax: "public UserCreateParameters()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.confirmation()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.confirmation()"
|
|
name: "confirmation()"
|
|
nameWithType: "UserCreateParameters.confirmation()"
|
|
summary: "Get determines the type of confirmation e-mail that will be sent to the newly created user."
|
|
syntax: "public Confirmation confirmation()"
|
|
desc: "Get determines the type of confirmation e-mail that will be sent to the newly created user. Possible values include: 'signup', 'invite'."
|
|
returns:
|
|
description: "the confirmation value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.Confirmation?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.Confirmation&text=Confirmation\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.email()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.email()"
|
|
name: "email()"
|
|
nameWithType: "UserCreateParameters.email()"
|
|
summary: "Get email address."
|
|
syntax: "public String email()"
|
|
desc: "Get email address. Must not be empty and must be unique within the service instance."
|
|
returns:
|
|
description: "the email value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.firstName()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.firstName()"
|
|
name: "firstName()"
|
|
nameWithType: "UserCreateParameters.firstName()"
|
|
summary: "Get first name."
|
|
syntax: "public String firstName()"
|
|
desc: "Get first name."
|
|
returns:
|
|
description: "the firstName value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.identities()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.identities()"
|
|
name: "identities()"
|
|
nameWithType: "UserCreateParameters.identities()"
|
|
summary: "Get collection of user identities."
|
|
syntax: "public List<UserIdentityContractInner> identities()"
|
|
desc: "Get collection of user identities."
|
|
returns:
|
|
description: "the identities value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UserIdentityContractInner?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UserIdentityContractInner&text=UserIdentityContractInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.lastName()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.lastName()"
|
|
name: "lastName()"
|
|
nameWithType: "UserCreateParameters.lastName()"
|
|
summary: "Get last name."
|
|
syntax: "public String lastName()"
|
|
desc: "Get last name."
|
|
returns:
|
|
description: "the lastName value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.note()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.note()"
|
|
name: "note()"
|
|
nameWithType: "UserCreateParameters.note()"
|
|
summary: "Get optional note about a user set by the administrator."
|
|
syntax: "public String note()"
|
|
desc: "Get optional note about a user set by the administrator."
|
|
returns:
|
|
description: "the note value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.password()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.password()"
|
|
name: "password()"
|
|
nameWithType: "UserCreateParameters.password()"
|
|
summary: "Get user Password."
|
|
syntax: "public String password()"
|
|
desc: "Get user Password. If no value is provided, a default password is generated."
|
|
returns:
|
|
description: "the password value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.state()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.state()"
|
|
name: "state()"
|
|
nameWithType: "UserCreateParameters.state()"
|
|
summary: "Get account state."
|
|
syntax: "public UserState state()"
|
|
desc: "Get 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. Possible values include: 'active', 'blocked', 'pending', 'deleted'."
|
|
returns:
|
|
description: "the state value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserState?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserState&text=UserState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withConfirmation(com.microsoft.azure.management.apimanagement.v2019_01_01.Confirmation)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withConfirmation(Confirmation confirmation)"
|
|
name: "withConfirmation(Confirmation confirmation)"
|
|
nameWithType: "UserCreateParameters.withConfirmation(Confirmation confirmation)"
|
|
summary: "Set determines the type of confirmation e-mail that will be sent to the newly created user."
|
|
parameters:
|
|
- description: "the confirmation value to set"
|
|
name: "confirmation"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.Confirmation?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.Confirmation&text=Confirmation\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserCreateParameters withConfirmation(Confirmation confirmation)"
|
|
desc: "Set determines the type of confirmation e-mail that will be sent to the newly created user. Possible values include: 'signup', 'invite'."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withEmail(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withEmail(String email)"
|
|
name: "withEmail(String email)"
|
|
nameWithType: "UserCreateParameters.withEmail(String email)"
|
|
summary: "Set email address."
|
|
parameters:
|
|
- description: "the email value to set"
|
|
name: "email"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserCreateParameters withEmail(String email)"
|
|
desc: "Set email address. Must not be empty and must be unique within the service instance."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withFirstName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withFirstName(String firstName)"
|
|
name: "withFirstName(String firstName)"
|
|
nameWithType: "UserCreateParameters.withFirstName(String firstName)"
|
|
summary: "Set first name."
|
|
parameters:
|
|
- description: "the firstName value to set"
|
|
name: "firstName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserCreateParameters withFirstName(String firstName)"
|
|
desc: "Set first name."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withIdentities(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UserIdentityContractInner>)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withIdentities(List<UserIdentityContractInner> identities)"
|
|
name: "withIdentities(List<UserIdentityContractInner> identities)"
|
|
nameWithType: "UserCreateParameters.withIdentities(List<UserIdentityContractInner> identities)"
|
|
summary: "Set collection of user identities."
|
|
parameters:
|
|
- description: "the identities value to set"
|
|
name: "identities"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UserIdentityContractInner?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UserIdentityContractInner&text=UserIdentityContractInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public UserCreateParameters withIdentities(List<UserIdentityContractInner> identities)"
|
|
desc: "Set collection of user identities."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withLastName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withLastName(String lastName)"
|
|
name: "withLastName(String lastName)"
|
|
nameWithType: "UserCreateParameters.withLastName(String lastName)"
|
|
summary: "Set last name."
|
|
parameters:
|
|
- description: "the lastName value to set"
|
|
name: "lastName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserCreateParameters withLastName(String lastName)"
|
|
desc: "Set last name."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withNote(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withNote(String note)"
|
|
name: "withNote(String note)"
|
|
nameWithType: "UserCreateParameters.withNote(String note)"
|
|
summary: "Set optional note about a user set by the administrator."
|
|
parameters:
|
|
- description: "the note value to set"
|
|
name: "note"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserCreateParameters withNote(String note)"
|
|
desc: "Set optional note about a user set by the administrator."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withPassword(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withPassword(String password)"
|
|
name: "withPassword(String password)"
|
|
nameWithType: "UserCreateParameters.withPassword(String password)"
|
|
summary: "Set user Password."
|
|
parameters:
|
|
- description: "the password value to set"
|
|
name: "password"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserCreateParameters withPassword(String password)"
|
|
desc: "Set user Password. If no value is provided, a default password is generated."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withState(com.microsoft.azure.management.apimanagement.v2019_01_01.UserState)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters.withState(UserState state)"
|
|
name: "withState(UserState state)"
|
|
nameWithType: "UserCreateParameters.withState(UserState state)"
|
|
summary: "Set account state."
|
|
parameters:
|
|
- description: "the state value to set"
|
|
name: "state"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserState?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserState&text=UserState\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserCreateParameters withState(UserState state)"
|
|
desc: "Set 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. Possible values include: 'active', 'blocked', 'pending', 'deleted'."
|
|
returns:
|
|
description: "the UserCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserCreateParameters&text=UserCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "User create details."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
|
|
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
|