Skip to content

Commit 509b76b

Browse files
rjagiewichrjagiewich
authored
Merge pull request #13137 from lakshmir124/user/lakshmiroy/RLCCmdlets
Add TeamsRemoteLogCollection documentation
2 parents 5d2609b + 1722796 commit 509b76b

6 files changed

+638
-0
lines changed

‎teams/teams-ps/MicrosoftTeams/Get-CsTeamsRemoteLogCollectionConfiguration.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: lakshmiroy
4+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
5+
Locale: en-US
6+
manager: wayvad
7+
Module Name: MicrosoftTeams
8+
ms.author: lakshmiroy
9+
online version: https://learn.microsoft.com/powershell/module/skype/get-csTeamsRemoteLogCollectionConfiguration
10+
schema: 2.0.0
11+
title: Get-CsTeamsRemoteLogCollectionConfiguration
12+
---
13+
14+
# Get-CsTeamsRemoteLogCollectionConfiguration
15+
16+
## SYNOPSIS
17+
Returns list of devices for which remote log collection has been initiated for.
18+
19+
## SYNTAX
20+
21+
### Identity (Default)
22+
```
23+
Get-CsTeamsRemoteLogCollectionConfiguration [-Identity <Guid>]
24+
[<CommonParameters>]
25+
26+
```
27+
28+
## DESCRIPTION
29+
30+
Remote log collection is a feature in Microsoft Teams that allows IT administrators to remotely trigger the collection of diagnostic logs from user devices through the Teams Admin Center (TAC). Instead of relying on manual user intervention, admins can initiate log collection for troubleshooting directly from the TAC portal.
31+
32+
TeamsRemoteLogCollectionConfiguration is updated with a list of devices when an administrator wants to initiate a request for remote log collection for a user's device. Each device has a unique GUID identity, userId, deviceId and expiry date.
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
```
38+
PS C:\> Get-CsTeamsRemoteLogCollectionConfiguration
39+
```
40+
41+
The above cmdlet lists the devices of TeamsRemoteLogCollectionConfiguration.
42+
43+
## PARAMETERS
44+
45+
### -Identity
46+
{{Fill Identity Description}}
47+
48+
```yaml
49+
Type: XdsIdentity
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: False
54+
Position: 1
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### CommonParameters
61+
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).
62+
63+
## INPUTS
64+
65+
### None
66+
67+
## OUTPUTS
68+
69+
### System.Object
70+
71+
## RELATED LINKS
72+
73+
[Get-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/get-csTeamsRemoteLogCollectionDevice)
74+
75+
[Set-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/set-csTeamsRemoteLogCollectionDevice)
76+
77+
[New-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/new-csTeamsRemoteLogCollectionDevice)
78+
79+
[Remove-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csTeamsRemoteLogCollectionDevice)

‎teams/teams-ps/MicrosoftTeams/Get-CsTeamsRemoteLogCollectionDevice.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: lakshmiroy
4+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
5+
Locale: en-US
6+
manager: wayvad
7+
Module Name: MicrosoftTeams
8+
ms.author: lakshmiroy
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csTeamsRemoteLogCollectionDevice
10+
schema: 2.0.0
11+
title: Get-CsTeamsRemoteLogCollectionDevice
12+
---
13+
14+
# Get-CsTeamsRemoteLogCollectionDevice
15+
16+
## SYNOPSIS
17+
Returns a list of devices for which remote log collection has been initiated for.
18+
19+
## SYNTAX
20+
21+
### Identity (Default)
22+
```
23+
Get-CsTeamsRemoteLogCollectionDevice [[-Identity] <Guid>]
24+
[<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
Remote log collection is a feature in Microsoft Teams that allows IT administrators to remotely trigger the collection of diagnostic logs from user devices through the Teams Admin Center (TAC). Instead of relying on manual user intervention, admins can initiate log collection for troubleshooting directly from the TAC portal.
29+
30+
TeamsRemoteLogCollectionConfiguration is updated with a list of devices when an administrator wants to initiate a request for remote log collection for a user's device. Each device has a unique GUID identity, userId, deviceId and expiry date.
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
```
36+
PS C:\> Get-CsTeamsRemoteLogCollectionDevice
37+
```
38+
39+
The above cmdlet lists all the devices of TeamsRemoteLogCollectionDevice.
40+
41+
## PARAMETERS
42+
43+
### -Identity
44+
The Identity parameter identifies the remote log collection configuration.
45+
46+
```yaml
47+
Type: Guid
48+
Parameter Sets: (All)
49+
Aliases:
50+
51+
Required: False
52+
Position: 1
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### CommonParameters
59+
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).
60+
61+
## INPUTS
62+
63+
### None
64+
65+
## OUTPUTS
66+
67+
### System.Object
68+
69+
## RELATED LINKS
70+
71+
[Get-CsTeamsRemoteLogCollectionConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csTeamsRemoteLogCollectionConfiguration)
72+
73+
[Set-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/set-csTeamsRemoteLogCollectionDevice)
74+
75+
[New-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/new-csTeamsRemoteLogCollectionDevice)
76+
77+
[Remove-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csTeamsRemoteLogCollectionDevice)

‎teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,12 @@ This cmdlet allows the admin to get a list of existing tags for telephone number
263263
### [Get-CsPolicyPackage](Get-CsPolicyPackage.md)
264264
This cmdlet supports retrieving all the policy packages available on a tenant.
265265

266+
### [Get-CsTeamsRemoteLogCollectionConfiguration](Get-CsTeamsRemoteLogCollectionConfiguration.md)
267+
This cmdlet displays all the devices added to the configuration for remote log collection.
268+
269+
### [Get-CsTeamsRemoteLogCollectionDevice](Get-CsTeamsRemoteLogCollectionDevice.md)
270+
This cmdlet displays all the devices added to the configuration for remote log collection.
271+
266272
### [Get-CsSdgBulkSignInRequestsSummary](Get-CsSdgBulkSignInRequestsSummary.md)
267273
Get the tenant level summary of all bulk sign in requests executed in the past 30 days.
268274

@@ -869,6 +875,9 @@ Creates a new online voice route.
869875
### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md)
870876
Creates a new online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users.
871877

878+
### [New-CsTeamsRemoteLogCollectionDevice](New-CsTeamsRemoteLogCollectionDevice.md)
879+
This cmdlet creates a request for remote log collection for a device.
880+
872881
### [New-CsSdgBulkSignInRequest](New-CsSdgBulkSignInRequest.md)
873882
Use the New-CsSdgBulkSignInRequest cmdlet to sign in a batch of up to 100 devices.
874883

@@ -1166,6 +1175,9 @@ This cmdlet will remove/unassign a phone number from a user or a resource accoun
11661175
### [Remove-CsPhoneNumberTag](Remove-CsPhoneNumberTag.md)
11671176
This cmdlet allows admin to remove a tag from phone number.
11681177

1178+
### [Remove-CsTeamsRemoteLogCollectionDevice](Remove-CsTeamsRemoteLogCollectionDevice.md)
1179+
This cmdlet will remove/delete a device from the remote log collection configuration.
1180+
11691181
### [Remove-CsSharedCallQueueHistoryTemplate](Remove-CsSharedCallQueueHistoryTemplate.md)
11701182
```powershell Remove-CsSharedCallQueueHistoryTemplate -Id <String> [<CommonParameters>] ```
11711183

@@ -1478,6 +1490,9 @@ This cmdlet assigns a policy to a specific telephone number in Microsoft Teams.
14781490
### [Set-CsPhoneNumberTag](Set-CsPhoneNumberTag.md)
14791491
This cmdlet allows the admin to create and assign a tag to a phone number.
14801492

1493+
### [Set-CsTeamsRemoteLogCollectionDevice](Set-CsTeamsRemoteLogCollectionDevice.md)
1494+
This cmdlet allows the admin to create and edit a device requested for remote log collection.
1495+
14811496
### [Set-CsSharedCallQueueHistoryTemplate](Set-CsSharedCallQueueHistoryTemplate.md)
14821497
```powershell Set-CsSharedCallQueueHistoryTemplate -Instance <instance> [<CommonParameters>] ```
14831498

‎teams/teams-ps/MicrosoftTeams/New-CsTeamsRemoteLogCollectionDevice.md‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: lakshmiroy
4+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
5+
Locale: en-US
6+
manager: wayvad
7+
Module Name: MicrosoftTeams
8+
ms.author: lakshmiroy
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/new-csTeamsRemoteLogCollectionDevice
10+
schema: 2.0.0
11+
title: New-CsTeamsRemoteLogCollectionDevice
12+
13+
---
14+
15+
# New-CsTeamsRemoteLogCollectionDevice
16+
17+
## SYNOPSIS
18+
19+
This cmdlet allows you to create a new TeamsRemoteLogCollectionDevice instance and set it's properties.
20+
21+
## SYNTAX
22+
23+
```powershell
24+
New-CsTeamsRemoteLogCollectionDevice [-Identity <Guid>] [-UserId <String>]
25+
[-DeviceId <String>] [-ExpireAfter <String>] [-Force] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
This cmdlet allows you to create a TeamsRemoteLogCollectionDevice instance.
31+
32+
Remote log collection is a feature in Microsoft Teams that allows IT administrators to remotely trigger the collection of diagnostic logs from user devices through the Teams Admin Center (TAC). Instead of relying on manual user intervention, admins can initiate log collection for troubleshooting directly from the TAC portal.
33+
34+
TeamsRemoteLogCollectionConfiguration is updated with a list of devices when an administrator wants to initiate a request for remote log collection for a user's device. Each device has a unique GUID identity, userId, deviceId and expiry date.
35+
36+
## EXAMPLES
37+
38+
Each Identity, userId and deviceId must be a valid GUID
39+
### Example 1
40+
```powershell
41+
PS C:\> New-CsTeamsRemoteLogCollectionDevice -UserId "765267a2-aa73-4984-a37e-43470f5e21a7" -DeviceId "765267a2-aa73-4984-a37e-43470f5e21a7" -ExpireAfter "06/07/2025 15:30:45"
42+
```
43+
44+
Creates a new instance of TeamsRemoteLogCollectionDevice.
45+
46+
## PARAMETERS
47+
48+
### -UserId
49+
50+
> Applicable: Microsoft Teams
51+
52+
Indicates the userId of the user for which an admin is requesting logs for. This userId must be a valid GUID.
53+
54+
```yaml
55+
Type: String
56+
Parameter Sets: (All)
57+
Aliases:
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -DeviceId
66+
67+
> Applicable: Microsoft Teams
68+
69+
Indicates the deviceId of the device for which an admin is requesting logs for. This deviceId must be a valid GUID.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets: (All)
74+
Aliases:
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -ExpireAfter
83+
84+
> Applicable: Microsoft Teams
85+
86+
Indicates the expiry date after which the remote log collection request will expire. This expire after date should be set to now() + 3 days. This expiry date should be in ISO 8601 UTC format.
87+
88+
```yaml
89+
Type: String
90+
Parameter Sets: (All)
91+
Aliases:
92+
Required: False
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
99+
### -Confirm
100+
Prompts you for confirmation before running the cmdlet.
101+
102+
```yaml
103+
Type: SwitchParameter
104+
Parameter Sets: (All)
105+
Aliases: cf
106+
107+
Required: False
108+
Position: Named
109+
Default value: None
110+
Accept pipeline input: False
111+
Accept wildcard characters: False
112+
```
113+
114+
### -Identity
115+
116+
> Applicable: Microsoft Teams
117+
118+
Policy instance name.
119+
120+
```yaml
121+
Type: XdsIdentity
122+
Parameter Sets: (All)
123+
Aliases:
124+
Required: True
125+
Position: 1
126+
Default value: None
127+
Accept pipeline input: False
128+
Accept wildcard characters: False
129+
```
130+
131+
### -WhatIf
132+
Shows what would happen if the cmdlet runs.
133+
The cmdlet is not run.
134+
135+
```yaml
136+
Type: SwitchParameter
137+
Parameter Sets: (All)
138+
Aliases: wi
139+
140+
Required: False
141+
Position: Named
142+
Default value: None
143+
Accept pipeline input: False
144+
Accept wildcard characters: False
145+
```
146+
147+
### CommonParameters
148+
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).
149+
150+
## INPUTS
151+
152+
### None
153+
154+
## OUTPUTS
155+
156+
### System.Object
157+
158+
## NOTES
159+
160+
## RELATED LINKS
161+
162+
[Get-CsTeamsRemoteLogCollectionConfiguration](https://learn.microsoft.com/powershell/module/microsoftteams/get-csTeamsRemoteLogCollectionConfiguration)
163+
164+
[Get-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/get-csTeamsRemoteLogCollectionDevice)
165+
166+
[Set-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/set-csTeamsRemoteLogCollectionDevice)
167+
168+
[Remove-CsTeamsRemoteLogCollectionDevice](https://learn.microsoft.com/powershell/module/microsoftteams/remove-csTeamsRemoteLogCollectionDevice)

0 commit comments

Comments
 (0)