Skip to content

Update Get-CsOnlineUser.md #12508

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

Merged
merged 6 commits into from
Feb 24, 2025
Merged

Update Get-CsOnlineUser.md #12508

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f449583
Update Get-CsOnlineUser.md
praspatil05 Feb 5, 2025
081312b
Merge branch 'main' into patch-11
praspatil05 Feb 18, 2025
e3f549b
Add Properties parameter to Get-CsOnlineUser cmdlet
praspatil05 Feb 18, 2025
358a0f0
Add Properties parameter to Get-CsOnlineUser cmdlet
praspatil05 Feb 18, 2025
4cf6c9b
Update to the description
praspatil05 Feb 24, 2025
7fc1e09
Merge branch 'main' into patch-11
Ruchika-mittal01 Feb 24, 2025
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
47 changes: 30 additions & 17 deletions teams/teams-ps/teams/Get-CsOnlineUser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Returns information about users who have accounts homed on Microsoft Teams or Sk
Get-CsOnlineUser [[-Identity] <UserIdParameter>]
[-AccountType <String>]
[-Filter <String>]
[-Properties <String>]
[-ResultSize <Unlimited>]
[-SkipUserPolicies]
[-SoftDeletedUser]
[-Sort]
[-UsePreferredDC]
[<CommonParameters>]
```

Expand Down Expand Up @@ -191,6 +191,27 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Properties

Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Note that the following properties will always be present in the output: Identity, UserPrincipalName, Alias, AccountEnabled, DisplayName.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the possible input values and what are the definitions for the values?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get-CsOnlineUser cmdlet provides numerous attribtues in the output. With properties parameter, customer can choose any value which they want in the output rather than getting the complete set of values.

Copy link
Contributor

@michbrown-png michbrown-png Feb 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Get-CsOnlineUser doc, there's a parameter called "AccountType" that provides more information on the possible values for the "AccountType" parameter. https://learn.microsoft.com/en-us/powershell/module/teams/get-csonlineuser?view=teams-ps

image

I am looking for something like this. What does Identity, UserPrincipalName, Alias, AccountEnabled, and DisplayName mean in this context? Are these the only properties that a user is allowed to specify?


Examples:
- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes
- Get-CsOnlineUser -Properties DisplayName, Alias, LineURI

```yaml
Type: String
Parameter Sets: (All)
Aliases:
applicable: Microsoft Teams

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ResultSize

**Note**: Starting with Teams PowerShell Modules version 4.0 and later, "-ResultSize" type has been changed to uint32.
Expand Down Expand Up @@ -267,22 +288,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -UsePreferredDC

Reserved for Microsoft internal use.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down Expand Up @@ -315,6 +320,14 @@ A recent fix has addressed an issue where some Guest users were being omitted fr
- Conferencing_RequiresCommunicationCredits: Allows pay-per minute Audio Conferencing without monthly licenses.
- CommunicationCredits: Enables users to pay Teams calling and conferencing through the credits.

**Updates in Teams PowerShell Module version 6.9.0 and later**:

Adds new attribute in the output of Get-CsOnlineUser cmdlet in commercial environments.
- TelephoneNumbers: A new list of complex object that includes telephone number and its corresponding assignment category. The assignment category can include values such as 'Primary', 'Private', and 'Alternate'.

Adds new parameter to the Get-CsOnlineUser cmdlet in all clouds:
- Properties: Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Note that the following properties will always be present in the output: Identity, UserPrincipalName, Alias, AccountEnabled, DisplayName.

**Updates in Teams PowerShell Module version 6.8.0 and later**:

New policies - TeamsBYODAndDesksPolicy, TeamsAIPolicy, TeamsWorkLocationDetectionPolicy, TeamsMediaConnectivityPolicy, TeamsMeetingTemplatePermissionPolicy, TeamsVirtualAppointmentsPolicy and TeamsWorkLoadPolicy will be visible in the Get-CsOnlineUser cmdlet output.
Expand Down