Skip to content

Commit 75d9c6d

Browse files
authored
Update Get-CsOnlineUser.md
1 parent 0a6ecb4 commit 75d9c6d

File tree

1 file changed

+52
-51
lines changed

1 file changed

+52
-51
lines changed

skype/skype-ps/skype/Get-CsOnlineUser.md

Lines changed: 52 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -49,57 +49,6 @@ If you want to exclude Skype for Business Online users from the data returned by
4949
By definition, users homed on the on-premises version will always have a TenantId equal to 00000000-0000-0000-0000-000000000000.
5050
Users homed on Skype for Business Online will a TenantId that is equal to some value other than 00000000-0000-0000-0000-000000000000.
5151

52-
## EXAMPLES
53-
54-
### -------------------------- Example 1 --------------------------
55-
```
56-
Get-CsOnlineUser
57-
```
58-
59-
The command shown in Example 1 returns information for all the users configured as online users.
60-
61-
### -------------------------- Example 2 --------------------------
62-
```
63-
Get-CsOnlineUser -Identity "sip:[email protected]"
64-
```
65-
66-
In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com".
67-
68-
### -------------------------- Example 3 --------------------------
69-
```
70-
Get-CsOnlineUser -Filter {ArchivingPolicy -eq "RedmondArchiving"}
71-
```
72-
73-
Example 3 uses the Filter parameter to limit the returned data to online users who have been assigned the per-user archiving policy RedmondArchiving.
74-
To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving".
75-
76-
### -------------------------- Example 4 --------------------------
77-
```
78-
Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True}
79-
```
80-
81-
Example 4 returns information only for user accounts that have been configured so that the account does not appear in Microsoft Exchange address lists.
82-
(That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}.
83-
84-
### -------------------------- Example 5 --------------------------
85-
```
86-
Get-CsOnlineUser -Filter {TenantId -eq "bf19b7db-6960-41e5-a139-2aa373474354"}
87-
```
88-
89-
The command shown in Example 5 returns information for all the online users assigned to the tenant with the TenantID "bf19b7db-6960-41e5-a139-2aa373474354".
90-
To accomplish the task, the command includes the Filter parameter along with the filter value {TenantId -eq "bf19b7db-6960-41e5-a139-2aa373474354"}.
91-
This filter limits the returned data to online users assigned to the tenant "bf19b7db-6960-41e5-a139-2aa373474354".
92-
93-
### -------------------------- Example 6 --------------------------
94-
```
95-
PS C:\> $MeetingPolicy="Kiosk"
96-
PS C:\> $filterString = 'TeamsMeetingPolicy -eq "{0}"' -f $MeetingPolicy
97-
PS C:\> Get-CsOnlineUser -Filter $filterString
98-
```
99-
100-
The commands shown in Example 6 filters all the online users with a certain TeamsMeetingPolicy assigned using a variable as filter input.
101-
To accomplish the task, the filter string is first constructed and resolved locally and then used by the Get-CsOnlineUser cmdlet.
102-
10352
**Note:**
10453

10554
Beginning TPM 2.6.2 onwards, the below updates are applicable for TeamsOnly customers.
@@ -238,6 +187,58 @@ LdapFilter has been deprecated due to low usage.
238187
- EnterpriseVoiceEnabled eq true / false
239188

240189

190+
191+
## EXAMPLES
192+
193+
### -------------------------- Example 1 --------------------------
194+
```
195+
Get-CsOnlineUser
196+
```
197+
198+
The command shown in Example 1 returns information for all the users configured as online users.
199+
200+
### -------------------------- Example 2 --------------------------
201+
```
202+
Get-CsOnlineUser -Identity "sip:[email protected]"
203+
```
204+
205+
In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com".
206+
207+
### -------------------------- Example 3 --------------------------
208+
```
209+
Get-CsOnlineUser -Filter {ArchivingPolicy -eq "RedmondArchiving"}
210+
```
211+
212+
Example 3 uses the Filter parameter to limit the returned data to online users who have been assigned the per-user archiving policy RedmondArchiving.
213+
To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving".
214+
215+
### -------------------------- Example 4 --------------------------
216+
```
217+
Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True}
218+
```
219+
220+
Example 4 returns information only for user accounts that have been configured so that the account does not appear in Microsoft Exchange address lists.
221+
(That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}.
222+
223+
### -------------------------- Example 5 --------------------------
224+
```
225+
Get-CsOnlineUser -Filter {TenantId -eq "bf19b7db-6960-41e5-a139-2aa373474354"}
226+
```
227+
228+
The command shown in Example 5 returns information for all the online users assigned to the tenant with the TenantID "bf19b7db-6960-41e5-a139-2aa373474354".
229+
To accomplish the task, the command includes the Filter parameter along with the filter value {TenantId -eq "bf19b7db-6960-41e5-a139-2aa373474354"}.
230+
This filter limits the returned data to online users assigned to the tenant "bf19b7db-6960-41e5-a139-2aa373474354".
231+
232+
### -------------------------- Example 6 --------------------------
233+
```
234+
PS C:\> $MeetingPolicy="Kiosk"
235+
PS C:\> $filterString = 'TeamsMeetingPolicy -eq "{0}"' -f $MeetingPolicy
236+
PS C:\> Get-CsOnlineUser -Filter $filterString
237+
```
238+
239+
The commands shown in Example 6 filters all the online users with a certain TeamsMeetingPolicy assigned using a variable as filter input.
240+
To accomplish the task, the filter string is first constructed and resolved locally and then used by the Get-CsOnlineUser cmdlet.
241+
241242
## PARAMETERS
242243

243244
### -Credential

0 commit comments

Comments
 (0)