msgraph-sdk-powershell icon indicating copy to clipboard operation
msgraph-sdk-powershell copied to clipboard

Incorrect Documentation Example for Remove-MgGroupMemberByRef cmdlet

Open MichaelPhillipsPS opened this issue 1 year ago • 1 comments

Describe the bug

This isn't really a bug, but the documentation for the aforementioned Remove-MgGroupMemberByRef cmdlet is out of date. It shows an example that no longer works. The example code snippet shows the following:

Remove-MgGroupMemberByRef -GroupId $groupId -DirectoryObjectId $directoryObjectId

But DirectoryObjectId is no longer a valid parameter for the cmdlet.

Expected behavior

The example should match the updated syntax of that cmdlet.

How to reproduce

Go to the documentation page and take a look:

https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.groups/remove-mggroupmemberbyref?view=graph-powershell-1.0

SDK Version

No response

Latest version known to work for scenario above?

No response

Known Workarounds

Use the Remove-MgGroupMemberDirectoryObjectByRef cmdlet with the same parameter inputs instead.

Debug output

Click to expand log ```
</details>


### Configuration

_No response_

### Other information

_No response_

MichaelPhillipsPS avatar Apr 18 '24 16:04 MichaelPhillipsPS

Thank you @MichaelPhillipsPS for reporting this issue. We will review the document update process and provide a long term solution for such issues.

timayabi2020 avatar Apr 18 '24 18:04 timayabi2020

@MichaelPhillipsPS For backward compatibility purposes Remove-MgGroupMemberByRef cmdlet was reintroduced as an alias for Remove-MgGroupMemberDirectoryObjectByRef from version 2.19.0 and also the online document was updated.

timayabi2020 avatar Jul 29 '24 22:07 timayabi2020

This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 4 days. It will be closed if no further activity occurs within 3 days of this comment.