Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renames entra group user to entra group member. Closes #6396 #6398

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/docs/about/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ sidebar_position: 3

**Entra ID:**

- [entra group user set](../cmd/entra/group/group-user-set.mdx) - updates role of users in an Entra group [#5473](https://github.com/pnp/cli-microsoft365/issues/5473)
- [entra group user set](../cmd/entra/group/group-member-set.mdx) - updates role of users in an Entra group [#5473](https://github.com/pnp/cli-microsoft365/issues/5473)
- [entra user groupmembership list](../cmd/entra/user/user-groupmembership-list.mdx) - retrieves all groups where the user is a member of [#5904](https://github.com/pnp/cli-microsoft365/issues/5904)

**Global:**
Expand Down Expand Up @@ -344,7 +344,7 @@ sidebar_position: 3

- [entra administrativeunit member remove](../cmd/entra/administrativeunit/administrativeunit-member-remove.mdx) - removes a member (user, group, or device) from an administrative unit [#5734](https://github.com/pnp/cli-microsoft365/issues/5734)
- [entra app permission list](../cmd/entra/app/app-permission-list.mdx) - lists the application and delegated permissions for a specified Entra Application Registration [#5668](https://github.com/pnp/cli-microsoft365/issues/5668)
- [entra group user add](../cmd/entra/group/group-user-add.mdx) - adds a user to a Microsoft Entra ID group [#5471](https://github.com/pnp/cli-microsoft365/issues/5471)
- [entra group user add](../cmd/entra/group/group-member-add.mdx) - adds a user to a Microsoft Entra ID group [#5471](https://github.com/pnp/cli-microsoft365/issues/5471)
- [entra group add](../cmd/entra/group/group-add.mdx) - creates a Microsoft Entra group [#5476](https://github.com/pnp/cli-microsoft365/issues/5476)
- [entra user registrationdetails list](../cmd/entra/user/user-registrationdetails-list.mdx) - retrieves a list of the authentication methods registered for users [#5773](https://github.com/pnp/cli-microsoft365/issues/5773)

Expand Down Expand Up @@ -502,7 +502,7 @@ sidebar_position: 3

**Entra ID**

- [entra group user list](../cmd/entra/group/group-user-list.mdx) - lists users of a specific Entra group [#5469](https://github.com/pnp/cli-microsoft365/issues/5469)
- [entra group user list](../cmd/entra/group/group-member-list.mdx) - lists users of a specific Entra group [#5469](https://github.com/pnp/cli-microsoft365/issues/5469)

### Changes

Expand Down
62 changes: 62 additions & 0 deletions docs/docs/cmd/entra/group/group-member-add.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import Global from '/docs/cmd/_global.mdx';

# entra group member add

Adds a member to a Microsoft Entra ID group

## Usage

```sh
m365 entra group member add [options]
```

## Options

```md definition-list
`-i, --groupId [groupId]`
: The ID of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.

`-n, --groupDisplayName [groupDisplayName]`
: The display name of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.

`--ids [ids]`
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both.

`--userNames [userNames]`
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.

`-r, --role <role>`
: The role to be assigned to the new users. Valid values: `Owner`, `Member`.
```

<Global />

## Examples

Add a single member specified by ID as a member to a group specified by display name.

```sh
m365 entra group member add --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
```

Add multiple members specified by ID as members to a group specified by ID.

```sh
m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
```

Add a single member specified by UPN as an owner to a group specified by display name.

```sh
m365 entra group member add --groupDisplayName Developers --userNames [email protected] --role Owner
```

Adds multiple members specified by UPN as owners to a group specified by ID.

```sh
m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "[email protected],[email protected]" --role Owner
```

## Response

The command won't return a response on success.
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# entra group user list
# entra group member list

Lists users of a specific Entra group
Lists members of a specific Entra group

## Usage

```sh
m365 entra group user list [options]
m365 entra group member list [options]
```

## Alias
Expand All @@ -28,13 +28,13 @@ m365 aad group user list [options]
: The display name of the Entra group. Specify `groupId` or `groupName` but not both.

`-r, --role [role]`
: Filter the results to only users with the given role: `Owner`, `Member`.
: Filter the results to only members with the given role: `Owner`, `Member`.

`-p, --properties [properties]`
: Comma-separated list of properties to retrieve.

`-f, --filter [filter]`
: OData filter to use to query the list of users with.
: OData filter to use to query the list of members with.
```

<Global />
Expand All @@ -45,34 +45,34 @@ When the `properties` option includes values with a `/`, for example: `manager/d

## Examples

List all group users from a group specified by ID.
List all group members from a group specified by ID.

```sh
m365 entra group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
m365 entra group member list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
```

List all owners from a group specified by display name.

```sh
m365 entra group user list --groupName Developers --role Owner
m365 entra group member list --groupName Developers --role Owner
```

List all group users from a group specified by name. For each one return the display name, e-mail address, and manager display name.
List all group members from a group specified by name. For each one return the display name, e-mail address, and manager display name.

```sh
m365 entra group user list --groupName Developers --properties "displayName,mail,manager/displayName"
m365 entra group member list --groupName Developers --properties "displayName,mail,manager/displayName"
```

List all group users from a group specified by name. For each one return the display name, e-mail address, and manager information.
List all group members from a group specified by name. For each one return the display name, e-mail address, and manager information.

```sh
m365 entra group user list --groupName Developers --properties "displayName,mail,manager/*"
m365 entra group member list --groupName Developers --properties "displayName,mail,manager/*"
```

List all group members that are guest users.
List all group members that are guest members.

```sh
m365 entra group user list --groupName Developers --filter "userType eq 'Guest'"
m365 entra group member list --groupName Developers --filter "userType eq 'Guest'"
```

## Response
Expand Down
62 changes: 62 additions & 0 deletions docs/docs/cmd/entra/group/group-member-set.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import Global from '/docs/cmd/_global.mdx';

# entra group member set

Updates role of members in a Microsoft Entra ID group

## Usage

```sh
m365 entra group member set [options]
```

## Options

```md definition-list
`-i, --groupId [groupId]`
: The ID of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.

`-n, --groupDisplayName [groupDisplayName]`
: The display name of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.

`--ids [ids]`
: Comma-separated list of user IDs. Specify either `ids` or `userNames` but not both.

`--userNames [userNames]`
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.

`-r, --role <role>`
: The new role to be assigned to the members. Valid values: `Owner`, `Member`.
```

<Global />

## Examples

Update a single member specified by ID to a member of a group specified by display name

```sh
m365 entra group member set --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
```

Update multiple members specified by ID to members of a group specified by ID

```sh
m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
```

Update a single member specified by UPN to an owner of a group specified by display name

```sh
m365 entra group member set --groupDisplayName Developers --userNames [email protected] --role Owner
```

Update multiple members specified by UPN to owners of a group specified by ID

```sh
m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "[email protected],[email protected]" --role Owner
```

## Response

The command won't return a response on success.
62 changes: 0 additions & 62 deletions docs/docs/cmd/entra/group/group-user-add.mdx

This file was deleted.

62 changes: 0 additions & 62 deletions docs/docs/cmd/entra/group/group-user-set.mdx

This file was deleted.

13 changes: 12 additions & 1 deletion docs/docs/v10-upgrade-guidance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ We updated option naming from `groupDisplayName` to `groupName` and `userPrincip

**Affected commands:**

- [entra group user list](./cmd/entra/group/group-user-list.mdx)
- [entra group member list](./cmd/entra/group/group-member-list.mdx)
- [entra m365group conversation post list](./cmd/entra/m365group/m365group-conversation-post-list.mdx)
- [entra m365group recyclebinitem list](./cmd/entra/m365group/m365group-recyclebinitem-list.mdx)
- [outlook message get](./cmd/outlook/message/message-get.mdx)
Expand Down Expand Up @@ -130,6 +130,17 @@ We've enhanced the [entra m365group set](./cmd/entra/m365group/m365group-set.mdx

Make sure that if you are currently updating groups using the `displayName` option, you update your scripts to use the `newDisplayName` option instead.

### Renamed `entra group user` commands to `entra group member`

We have renamed the `entra group user` commands to `entra group member` to better reflect the command's purpose,. The following commands were renamed:
- [entra group member add](./cmd/entra/group/group-member-add.mdx)
- [entra group member list](./cmd/entra/group/group-member-list.mdx)
- [entra group member set](./cmd/entra/group/group-member-set.mdx)

#### What action do I need to take?

Please update your scripts to use the new command names.

## SharePoint

### Updated `spo site appcatalog remove` options
Expand Down
Loading