Skip to content

Commit 15da6bd

Browse files
Ruchika-mittal01Ruchika-mittal01
authored
Merge pull request #12434 from michbrown-png/missingTPMdocumentation
Adding missing tpm documentation for several parameters
2 parents b78c5f7 + 1ac0649 commit 15da6bd

16 files changed

+1550
-55
lines changed

‎teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ This cmdlet is used to get the status of the batch deployment orchestration.
1313

1414
## SYNTAX
1515

16-
```
16+
```powershell
1717
Get-CsBatchTeamsDeploymentStatus -OrchestrationId <String>
18-
[-Confirm]
19-
[-WhatIf]
18+
-InputObject <IConfigApiBasedCmdletsIdentity>
2019
[<CommonParameters>]
2120
```
2221

@@ -51,6 +50,21 @@ Accept pipeline input: False
5150
Accept wildcard characters: False
5251
```
5352
53+
### -InputObject
54+
The Identity parameter.
55+
56+
```yaml
57+
Type: IConfigApiBasedCmdletsIdentity
58+
Parameter Sets: GetViaIdentity
59+
Aliases:
60+
61+
Required: True
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: True (ByValue)
65+
Accept wildcard characters: False
66+
```
67+
5468
### CommonParameters
5569
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
5670

‎teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ This cmdlet is used to retrieve the organization-wide education configuration fo
1616

1717
## SYNTAX
1818

19+
### Identity (Default)
1920
```powershell
20-
Get-CsTeamsEducationConfiguration [<CommonParameters>]
21+
Get-CsTeamsEducationConfiguration [-Identity <String>] [<CommonParameters>]
22+
```
23+
24+
### Filter
25+
```powershell
26+
Get-CsTeamsEducationConfiguration [-Filter <String>] [<CommonParameters>]
2127
```
2228

2329
## DESCRIPTION
@@ -44,6 +50,36 @@ In this example, the organization has set the defaults as follows:
4450

4551
## PARAMETERS
4652

53+
### -Filter
54+
Enables you to use wildcard characters in order to return a collection of team education configuration settings.
55+
56+
```yaml
57+
Type: String
58+
Parameter Sets: Filter
59+
Aliases:
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### -Identity
69+
The unique identifier of the configuration.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets: Identity
74+
Aliases:
75+
76+
Required: False
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
4783
### CommonParameters
4884
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).
4985

‎teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,25 @@ ms.author: runli
1313

1414
## SYNOPSIS
1515

16-
This cmdlet retrieves all Teams media connectivity policies for current tenant.
16+
This cmdlet retrieves all Teams media connectivity policies for the current tenant.
1717

1818
## SYNTAX
1919

20+
### Identity (Default)
21+
22+
```powershell
23+
Get-CsTeamsMediaConnectivityPolicy [-Identity <String>] [<CommonParameters>]
2024
```
21-
Get-CsTeamsMediaConnectivityPolicy [<CommonParameters>]
25+
26+
### Filter
27+
28+
```powershell
29+
Get-CsTeamsMediaConnectivityPolicy [-Filter <String>] [<CommonParameters>]
2230
```
2331

2432
## DESCRIPTION
2533

26-
This cmdlet retrieves all Teams media connectivity policies for current tenant.
34+
This cmdlet retrieves all Teams media connectivity policies for the current tenant.
2735

2836
## EXAMPLES
2937

@@ -36,10 +44,42 @@ Identity DirectConnection
3644
Tag:Test Enabled
3745
```
3846

39-
retrieves Teams media connectivity policies, show the result as identity tag and "DirectConnection" value.
47+
This example retrieves the Teams media connectivity policies and shows the result as identity tag and "DirectConnection" value.
4048

4149
## PARAMETERS
4250

51+
### -Filter
52+
53+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
54+
55+
```yaml
56+
Type: String
57+
Parameter Sets: Filter
58+
Aliases:
59+
60+
Required: False
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -Identity
68+
69+
The identity of the Teams Media Connectivity Policy.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets: Identity
74+
Aliases:
75+
76+
Required: False
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
4383
### CommonParameters
4484
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).
4585

‎teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This cmdlet supports retrieving the list of team mappings.
1818
## SYNTAX
1919

2020
```
21-
Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId <String> [<CommonParameters>]
21+
Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId <String> -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
@@ -64,6 +64,20 @@ Default value: None
6464
Accept pipeline input: False
6565
Accept wildcard characters: False
6666
```
67+
### -InputObject
68+
The Identity parameter
69+
70+
```yaml
71+
Type: IConfigApiBasedCmdletsIdentity
72+
Parameter Sets: GetViaIdentity
73+
Aliases:
74+
75+
Required: True
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: True (ByValue)
79+
Accept wildcard characters: False
80+
```
6781
6882
### CommonParameters
6983
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).

‎teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ This cmdlet shows the list of Workforce management (WFM) users in a specified WF
1717

1818
## SYNTAX
1919

20-
```
21-
Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId <string> -WfmTeamId <string> [<CommonParameters>]
20+
```powershell
21+
Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId <string> -WfmTeamId <string> -InputObject <IConfigApiBasedCmdletsIdentity> [<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
@@ -79,6 +79,22 @@ Accept pipeline input: False
7979
Accept wildcard characters: False
8080
```
8181
82+
### -InputObject
83+
84+
The identity parameter.
85+
86+
```yaml
87+
Type: IConfigApiBasedCmdletsIdentity
88+
Parameter Sets: GetViaIdentity
89+
Aliases:
90+
91+
Required: True
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: True (ByValue)
95+
Accept wildcard characters: False
96+
```
97+
8298
### CommonParameters
8399
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).
84100

‎teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy
5+
title: Get-CsTeamsWorkLoadPolicy
6+
schema: 2.0.0
7+
---
8+
9+
# Get-CsTeamsWorkLoadPolicy
10+
11+
## SYNOPSIS
12+
13+
This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant.
14+
15+
## SYNTAX
16+
17+
### Identity (Default)
18+
19+
```powershell
20+
Get-CsTeamsWorkLoadPolicy [[-Identity] <String>] [-MsftInternalProcessingMode <String>] [<CommonParameters>]
21+
```
22+
23+
### Filter
24+
25+
```powershell
26+
Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode <String>] [-Filter <String>] [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
31+
The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user.
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
37+
```powershell
38+
PS C:\> Get-CsTeamsWorkLoadPolicy
39+
```
40+
41+
Retrieves the Teams Workload Policy instances and shows assigned values.
42+
43+
## PARAMETERS
44+
45+
### -Filter
46+
47+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
48+
49+
```yaml
50+
Type: String
51+
Parameter Sets: Filter
52+
Aliases:
53+
54+
Required: False
55+
Position: Named
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -Identity
62+
63+
Identity of the Teams Workload Policy.
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: Identity
68+
Aliases:
69+
70+
Required: False
71+
Position: 1
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -MsftInternalProcessingMode
78+
79+
For Microsoft internal use only.
80+
81+
```yaml
82+
Type: String
83+
Parameter Sets: (All)
84+
Aliases:
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### CommonParameters
94+
95+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
96+
97+
## INPUTS
98+
99+
### None
100+
101+
## OUTPUTS
102+
103+
### System.Object
104+
105+
## NOTES
106+
107+
## RELATED LINKS
108+
109+
[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy)
110+
111+
[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy)
112+
113+
[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy)
114+
115+
[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy)

0 commit comments

Comments
 (0)