-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.yml
107 lines (107 loc) · 8.93 KB
/
com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
### YamlMime:JavaType
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters"
name: "UserEntityBaseParameters"
nameWithType: "UserEntityBaseParameters"
summary: "User Entity Base Parameters set."
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 **UserEntityBaseParameters**"
constructors:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.UserEntityBaseParameters()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.UserEntityBaseParameters()"
name: "UserEntityBaseParameters()"
nameWithType: "UserEntityBaseParameters.UserEntityBaseParameters()"
syntax: "public UserEntityBaseParameters()"
methods:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.identities()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.identities()"
name: "identities()"
nameWithType: "UserEntityBaseParameters.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.UserEntityBaseParameters.note()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.note()"
name: "note()"
nameWithType: "UserEntityBaseParameters.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.UserEntityBaseParameters.state()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.state()"
name: "state()"
nameWithType: "UserEntityBaseParameters.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.UserEntityBaseParameters.withIdentities(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UserIdentityContractInner>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.withIdentities(List<UserIdentityContractInner> identities)"
name: "withIdentities(List<UserIdentityContractInner> identities)"
nameWithType: "UserEntityBaseParameters.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 UserEntityBaseParameters withIdentities(List<UserIdentityContractInner> identities)"
desc: "Set collection of user identities."
returns:
description: "the UserEntityBaseParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters&text=UserEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.withNote(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.withNote(String note)"
name: "withNote(String note)"
nameWithType: "UserEntityBaseParameters.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 UserEntityBaseParameters withNote(String note)"
desc: "Set optional note about a user set by the administrator."
returns:
description: "the UserEntityBaseParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters&text=UserEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.withState(com.microsoft.azure.management.apimanagement.v2019_01_01.UserState)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters.withState(UserState state)"
name: "withState(UserState state)"
nameWithType: "UserEntityBaseParameters.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 UserEntityBaseParameters 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 UserEntityBaseParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserEntityBaseParameters&text=UserEntityBaseParameters\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "User Entity Base Parameters set."
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