Skip to content

Commit 9f1007d

Browse files
authored
Merge pull request Azure#393 from billmath/update2
updating
2 parents c1bca3b + f72789a commit 9f1007d

File tree

3 files changed

+216
-48
lines changed

3 files changed

+216
-48
lines changed

azureadps-2.0-preview/AzureAD/Get-AzureADMSGroup.md

Lines changed: 54 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
external help file: Microsoft.Open.MS.GraphBeta.PowerShell.dll-Help.xml
33
Module Name: AzureADPreview
4-
ms.custom: iamfeature=PowerShell
5-
ms.reviewer: rodejo
64
online version:
75
schema: 2.0.0
86
---
@@ -16,7 +14,7 @@ Gets information about groups in Azure AD.
1614

1715
### GetQuery (Default)
1816
```
19-
Get-AzureADMSGroup [-All <Boolean>] [-Top <Int32>] [-Filter <String>] [<CommonParameters>]
17+
Get-AzureADMSGroup [-All <Boolean>] [-Top <Int32>] [-Select <String>] [-Filter <String>] [<CommonParameters>]
2018
```
2119

2220
### GetVague
@@ -26,13 +24,13 @@ Get-AzureADMSGroup [-SearchString <String>] [-All <Boolean>] [<CommonParameters>
2624

2725
### GetById
2826
```
29-
Get-AzureADMSGroup -Id <String> [-All <Boolean>] [<CommonParameters>]
27+
Get-AzureADMSGroup -Id <String> [-All <Boolean>] [-Select <String>] [<CommonParameters>]
3028
```
3129

3230
## DESCRIPTION
33-
The **Get-AzureADMSGroup** cmdlet gets information about groups in Azure Active Directory (Azure AD).
34-
To get a group, specify the _Id_ parameter.
35-
Specify the _SearchString_ or _Filter_ parameter to find particular groups.
31+
The Get-AzureADMSGroup cmdlet gets information about groups in Azure Active Directory (Azure AD).
32+
To get a group, specify the Id parameter.
33+
Specify the SearchString or Filter parameter to find particular groups.
3634
If you specify no parameters, this cmdlet gets all groups.
3735

3836
## EXAMPLES
@@ -98,10 +96,38 @@ MembershipRuleProcessingState : On
9896

9997
This command gets information for the group that has the specified ID.
10098

99+
### Example 3: Get AssignedLabels and DisplayName property values for all groups
100+
```
101+
PS C:\> Get-AzureADMSGroup -Select "AssignedLabels,DisplayName"
102+
103+
AssignedLabels : [{LabelId: "00000000-0000-0000-0000-000000000000", DisplayName: "Confidential"}]
104+
DisplayName : Project Icarus 1
105+
106+
AssignedLabels : [{LabelId: "00000000-0000-0000-0000-000000000000", DisplayName: "Confidential"}]
107+
DisplayName : Project Icarus 2
108+
```
109+
110+
This command gets AssignedLabels and DisplayName property values for all groups.
111+
112+
AssignedLabels group property could be retrieved only by Select parameter.
113+
114+
### Example 4: Get AssignedLabels and DisplayName property values for a group
115+
```
116+
PS C:\> Get-AzureADMSGroup -Id "11111111-1111-1111-1111-111111111111" -Select "AssignedLabels,DisplayName"
117+
118+
AssignedLabels : [{LabelId: "00000000-0000-0000-0000-000000000000", DisplayName: "Confidential"}]
119+
DisplayName : Project Icarus 1
120+
```
121+
122+
This command gets AssignedLabels and DisplayName property values for a specific group.
123+
124+
AssignedLabels group property could be retrieved only by Select parameter.
125+
101126
## PARAMETERS
102127

103128
### -All
104-
If true, return all groups. If false, return the number of objects specified by the Top parameter
129+
If true, return all groups.
130+
If false, return the number of objects specified by the Top parameter
105131

106132
```yaml
107133
Type: Boolean
@@ -115,6 +141,21 @@ Accept pipeline input: True (ByPropertyName, ByValue)
115141
Accept wildcard characters: False
116142
```
117143
144+
### -Select
145+
Specifies a list of group properties to retrieve.
146+
147+
```yaml
148+
Type: String
149+
Parameter Sets: GetQuery, GetById
150+
Aliases:
151+
152+
Required: False
153+
Position: Named
154+
Default value: None
155+
Accept pipeline input: True (ByPropertyName, ByValue)
156+
Accept wildcard characters: False
157+
```
158+
118159
### -Filter
119160
Specifies an oData v3.0 filter string to match a set of groups.
120161
@@ -147,7 +188,7 @@ Accept wildcard characters: False
147188
148189
### -SearchString
149190
Specifies a search string.
150-
This cmdlet gets groups that have **DisplayName** or **Description** attributes that match the search string.
191+
This cmdlet gets groups that have DisplayName or Description attributes that match the search string.
151192
152193
```yaml
153194
Type: String
@@ -188,18 +229,18 @@ System.Nullable\`1\[\[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral,
188229
## OUTPUTS
189230
190231
### System.Object
191-
192232
## NOTES
193233
This cmdlet is currently in Public Preview.
194234
While a cmdlet is in Public Preview, we may make changes to the cmdlet which could have unexpected effects.
195235
We recommend that you do not use this cmdlet in a production environment.
196236
197237
## RELATED LINKS
198238
199-
[New-AzureADMSGroup](./New-AzureADMSGroup.md)
239+
[New-AzureADMSGroup]()
200240
201-
[Remove-AzureADMSGroup](./Remove-AzureADMSGroup.md)
241+
[Remove-AzureADMSGroup]()
202242
203-
[Set-AzureADMSGroup](./Set-AzureADMSGroup.md)
243+
[Set-AzureADMSGroup]()
204244
205245
[#AzureAD: Certificate based authentication for iOS and Android now in preview!](https://blogs.technet.microsoft.com/enterprisemobility/2016/07/18/azuread-certificate-based-authentication-for-ios-and-android-now-in-preview/)
246+

azureadps-2.0-preview/AzureAD/New-AzureADMSGroup.md

Lines changed: 88 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
external help file: Microsoft.Open.MS.GraphBeta.PowerShell.dll-Help.xml
2+
external help file: Microsoft.Open.MS.GraphBeta.PowerShell.Custom.dll-Help.xml
33
Module Name: AzureADPreview
4-
ms.custom: iamfeature=PowerShell
5-
ms.reviewer: rodejo
64
online version:
75
schema: 2.0.0
86
---
@@ -15,10 +13,10 @@ Creates an Azure AD group.
1513
## SYNTAX
1614

1715
```
18-
New-AzureADMSGroup [-Description <String>] -DisplayName <String> -MailEnabled <Boolean> -MailNickname <String>
19-
-SecurityEnabled <Boolean> [-GroupTypes <System.Collections.Generic.List`1[System.String]>]
20-
[-MembershipRule <String>] [-MembershipRuleProcessingState <String>] [-Visibility <String>]
21-
[<CommonParameters>]
16+
New-AzureADMSGroup [-LabelId <String>] [-Description <String>] -DisplayName <String>
17+
[-IsAssignableToRole <Boolean>] -MailEnabled <Boolean> -MailNickname <String> -SecurityEnabled <Boolean>
18+
[-GroupTypes <System.Collections.Generic.List`1[System.String]>] [-MembershipRule <String>]
19+
[-MembershipRuleProcessingState <String>] [-Visibility <String>] [<CommonParameters>]
2220
```
2321

2422
## DESCRIPTION
@@ -30,7 +28,7 @@ For information about creating dynamic groups, see Using attributes to create ad
3028

3129
### Example 1: Create a dynamic group
3230
```
33-
PS C:\> New-AzureADMSGroup -DisplayName "Dynamic Group 01" -Description "Dynamic group created from PS" -MailEnabled $False -MailNickName "group" -SecurityEnabled $True -GroupTypes "DynamicMembership" -MembershipRule "(user.department -contains ""Marketing"")" -MembershipRuleProcessingState "On"
31+
PS C:\> New-AzureADMSGroup -DisplayName "Dynamic Group 01" -Description "Dynamic group created from PS" -MailEnabled $False -MailNickname "group" -SecurityEnabled $True -GroupTypes "DynamicMembership" -MembershipRule "(user.department -contains ""Marketing"")" -MembershipRuleProcessingState "On"
3432
3533
Id : 9126185e-25df-4522-a380-7ab697a7241c
3634
Description : Dynamic group created from PS
@@ -57,6 +55,36 @@ The processing state is On.
5755
This means that all users in the directory that qualify the rule are added as members to the group.
5856
Any users that do not qualify are removed from the group.
5957

58+
### Example 2: Create a group assignable to role
59+
```
60+
PS C:\> New-AzureADMSGroup -DisplayName "HelpDesk admin group" -Description "Group assignable to role" -MailEnabled $False -MailNickname "helpDeskAdminGroup" -SecurityEnabled $True -IsAssignableToRole $True -Visibility "Private"
61+
62+
Id : 1026185e-25df-4522-a380-7ab697a7241c
63+
Description : Group assignable to role
64+
OnPremisesSyncEnabled :
65+
DisplayName : HelpDesk admin group
66+
Mail :
67+
MailEnabled : False
68+
IsAssignableToRole : True
69+
MailNickname : helpDeskAdminGroup
70+
ProxyAddresses : {}
71+
SecurityEnabled : True
72+
GroupTypes : {}
73+
```
74+
75+
### Example 3: Create a group with label assignment
76+
```
77+
PS C:\> New-AzureADMSGroup -Description "Group associated with a label" -DisplayName "HelpDesk admin group" -GroupTypes "Unified" -LabelId "00000000-0000-0000-0000-000000000000" -MailEnabled $True -MailNickname "helpDeskAdminGroup" -SecurityEnabled $False
78+
79+
Id : 11111111-1111-1111-1111-111111111111
80+
Description : Group associated with a label
81+
DisplayName : HelpDesk admin group
82+
GroupTypes : ["Unified"]
83+
MailEnabled : True
84+
MailNickname : helpDeskAdminGroup
85+
SecurityEnabled : False
86+
```
87+
6088
## PARAMETERS
6189

6290
### -Description
@@ -89,42 +117,59 @@ Accept pipeline input: False
89117
Accept wildcard characters: False
90118
```
91119
92-
### -MailEnabled
93-
Specifies whether this group is mail enabled.
120+
### -GroupTypes
121+
Specifies that the group is a dynamic group.
122+
To create a dynamic group, specify a value of DynamicMembership.
94123
95-
Currently, you cannot create mail enabled groups in Azure AD.
124+
```yaml
125+
Type: System.Collections.Generic.List`1[System.String]
126+
Parameter Sets: (All)
127+
Aliases:
128+
129+
Required: False
130+
Position: Named
131+
Default value: None
132+
Accept pipeline input: False
133+
Accept wildcard characters: False
134+
```
135+
136+
### -IsAssignableToRole
137+
Flag indicates whether group can be assigned to a role.
138+
This property can only be set at the time of group creation and cannot be modified on an existing group.
96139
97140
```yaml
98141
Type: Boolean
99142
Parameter Sets: (All)
100143
Aliases:
101144

102-
Required: True
145+
Required: False
103146
Position: Named
104147
Default value: None
105148
Accept pipeline input: False
106149
Accept wildcard characters: False
107150
```
108151
109-
### -MailNickname
110-
Specifies a mail nickname for the group.
111-
If MailEnabled is $False you must still specify a mail nickname.
152+
### -LabelId
153+
Specifies a comma separated list of label identifiers to assign to the group.
154+
155+
Currently, only one label could be assigned to a group.
112156
113157
```yaml
114158
Type: String
115159
Parameter Sets: (All)
116160
Aliases:
117161

118-
Required: True
162+
Required: False
119163
Position: Named
120164
Default value: None
121-
Accept pipeline input: False
165+
Accept pipeline input: True (ByPropertyName, ByValue)
122166
Accept wildcard characters: False
123167
```
124168
125-
### -SecurityEnabled
126-
Specifies whether the group is security enabled.
127-
For security groups, this value must be $True.
169+
### -MailEnabled
170+
Specifies whether this group is mail enabled.
171+
172+
Currently, you cannot create mail enabled groups in Azure AD.
128173
129174
```yaml
130175
Type: Boolean
@@ -138,16 +183,16 @@ Accept pipeline input: False
138183
Accept wildcard characters: False
139184
```
140185
141-
### -GroupTypes
142-
Specifies that the group is a dynamic group.
143-
To create a dynamic group, specify a value of DynamicMembership.
186+
### -MailNickname
187+
Specifies a mail nickname for the group.
188+
If MailEnabled is $False you must still specify a mail nickname.
144189
145190
```yaml
146-
Type: System.Collections.Generic.List`1[System.String]
191+
Type: String
147192
Parameter Sets: (All)
148193
Aliases:
149194

150-
Required: False
195+
Required: True
151196
Position: Named
152197
Default value: None
153198
Accept pipeline input: False
@@ -192,8 +237,25 @@ Accept pipeline input: False
192237
Accept wildcard characters: False
193238
```
194239
240+
### -SecurityEnabled
241+
Specifies whether the group is security enabled.
242+
For security groups, this value must be $True.
243+
244+
```yaml
245+
Type: Boolean
246+
Parameter Sets: (All)
247+
Aliases:
248+
249+
Required: True
250+
Position: Named
251+
Default value: None
252+
Accept pipeline input: False
253+
Accept wildcard characters: False
254+
```
255+
195256
### -Visibility
196-
This parameter determines the visibility of the group's content and members list. This parameter can take one of the following values:
257+
This parameter determines the visibility of the group's content and members list.
258+
This parameter can take one of the following values:
197259
198260
* "Public" - Anyone can view the contents of the group
199261
* "Private" - Only members can view the content of the group
@@ -225,11 +287,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
225287
## INPUTS
226288
227289
### None
228-
229290
## OUTPUTS
230291
231292
### System.Object
232-
233293
## NOTES
234294
This cmdlet is currently in Public Preview.
235295
While a cmdlet is in Public Preview, we may make changes to the cmdlet which could have unexpected effects.

0 commit comments

Comments
 (0)