search

microsoftgraph / msgraph-sdk-powershell

Powershell SDK for Microsoft Graph
https://www.powershellgallery.com/packages/Microsoft.Graph
Other
691 stars 165 forks source link

Incorrect Documentation Example for Remove-MgGroupMemberByRef cmdlet #2691

Closed MichaelPhillipsPS closed 1 month ago

MichaelPhillipsPS commented 4 months ago

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 ``` ```

Configuration

No response

Other information

No response

timayabi2020 commented 4 months ago

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

timayabi2020 commented 1 month ago

@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.

microsoft-github-policy-service[bot] commented 1 month ago

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.