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.

Sign up for GitHub

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

Jump to bottom

Remove deprecated option username from entra m365group user set, Closes #6224 #6274

Closed
wants to merge 2 commits into from
Closed

Remove deprecated option username from entra m365group user set, Closes #6224 #6274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a02a4a0
First commit
nicodecleyre Aug 26, 2024
e7f5fe4
V10 guidance update
nicodecleyre Oct 2, 2024
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
11 changes: 4 additions & 7 deletions docs/docs/cmd/entra/m365group/m365group-user-set.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,11 @@ m365 aad teams user set
`--teamName [teamName]`
: The display name of the Microsoft Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.

`-n, --userName [userName]`
: (deprecated) User's UPN (User Principal Name), e.g. [email protected].

`--ids [ids]`
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify only one of the following `userName`, `ids` or `userNames`.
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify only one of the following `ids` or `userNames`.

`--userNames [userNames]`
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify only one of the following `userName`, `ids` or `userNames`.
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify only one of the following `ids` or `userNames`.

`-r, --role <role>`
: Role to set for the given user in the specified Microsoft 365 Group or Microsoft Teams team. Allowed values: `Owner`, `Member`
Expand All @@ -59,7 +56,7 @@ The command will return an error if the user already has the specified role in t
Promote a single user to Owner of the given Microsoft 365 Group

```sh
m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userName '[email protected]' --role Owner
m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userNames '[email protected]' --role Owner
```

Promote multiple users specified by the userNames parameter to Owner of the given Microsoft 365 Group
Expand All @@ -77,7 +74,7 @@ m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' -
Demote a single user from Owner to Member in the given Microsoft 365 Group

```sh
m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userName '[email protected]' --role Member
m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userNames '[email protected]' --role Member
```

Demote multiple users specified by the userNames parameter from Owner to Member of the given Microsoft Teams team
Expand Down
10 changes: 9 additions & 1 deletion docs/docs/v10-upgrade-guidance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The deprecated Guest value was removed from the `role` option in the [aad m365gr

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

Please, check the documentation of the aad m365group user list](./cmd/entra/m365group/m365group-user-list.mdx) command to see the updated ``role` option and adjust your scripts accordingly.
Please, check the documentation of the [aad m365group user list](./cmd/entra/m365group/m365group-user-list.mdx) command to see the updated ``role` option and adjust your scripts accordingly.

#### Aligned options with naming convention

Expand Down Expand Up @@ -130,6 +130,14 @@ 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.

### Removed deprecated option `username` from `entra m365group user set` command.

The deprecated option `username` was removed from the [entra m365group user set](./cmd/entra/m365group/m365group-user-set.mdx) command.

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

Please, check the documentation of the [entra m365group user set](./cmd/entra/m365group/m365group-user-set.mdx) command to see the updated `username` option and adjust your scripts accordingly.
nicodecleyre marked this conversation as resolved.
Show resolved Hide resolved

## SharePoint

### Updated `spo site appcatalog remove` options
Expand Down
2 changes: 1 addition & 1 deletion src/m365/entra/commands/m365group/m365group-user-set.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@ describe(commands.M365GROUP_USER_SET, () => {
sinonUtil.restore(entraGroup.isUnifiedGroup);
sinon.stub(entraGroup, 'isUnifiedGroup').resolves(false);

await assert.rejects(command.action(logger, { options: { groupId: groupId, userName: '[email protected]' } } as any),
await assert.rejects(command.action(logger, { options: { groupId: groupId, userNames: userUpns.join(',') } } as any),
new CommandError(`Specified group with id '${groupId}' is not a Microsoft 365 group.`));
});
});
15 changes: 3 additions & 12 deletions src/m365/entra/commands/m365group/m365group-user-set.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ interface CommandArgs {
}

interface Options extends GlobalOptions {
userName?: string;
ids?: string;
userNames?: string;
groupId?: string;
Expand Down Expand Up @@ -66,9 +65,6 @@ class EntraM365GroupUserSetCommand extends GraphCommand {

#initOptions(): void {
this.options.unshift(
{
option: '-n, --userName [userName]'
},
{
option: '--ids [ids]'
},
Expand Down Expand Up @@ -130,30 +126,25 @@ class EntraM365GroupUserSetCommand extends GraphCommand {

#initOptionSets(): void {
this.optionSets.push({ options: ['groupId', 'groupName', 'teamId', 'teamName'] });
this.optionSets.push({ options: ['userName', 'ids', 'userNames'] });
this.optionSets.push({ options: ['ids', 'userNames'] });
}

#initTypes(): void {
this.types.string.push('userName', 'ids', 'userNames', 'groupId', 'groupName', 'teamId', 'teamName', 'role');
this.types.string.push('ids', 'userNames', 'groupId', 'groupName', 'teamId', 'teamName', 'role');
}

public async commandAction(logger: Logger, args: CommandArgs): Promise<void> {
await this.showDeprecationWarning(logger, aadCommands.M365GROUP_USER_SET, commands.M365GROUP_USER_SET);

if (args.options.userName) {
await this.warn(logger, `Option 'userName' is deprecated. Please use 'ids' or 'userNames' instead.`);
}

try {
const userNames = args.options.userNames || args.options.userName;
const groupId: string = await this.getGroupId(logger, args);
const isUnifiedGroup = await entraGroup.isUnifiedGroup(groupId);

if (!isUnifiedGroup) {
throw Error(`Specified group with id '${groupId}' is not a Microsoft 365 group.`);
}

const userIds: string[] = await this.getUserIds(logger, args.options.ids, userNames);
const userIds: string[] = await this.getUserIds(logger, args.options.ids, args.options.userNames);

// we can't simply switch the role
// first add users to the new role
Expand Down