Skip to content

Commit 0a6de19

Browse files
tiburdtiburd
authored
Merge pull request #11509 from saleens7/patch-5
Add CsTeamsCustomBannerText
2 parents eb67be5 + 229cc81 commit 0a6de19

File tree

4 files changed

+341
-0
lines changed

4 files changed

+341
-0
lines changed

‎teams/teams-ps/teams/Get-CsTeamsCustomBannerText

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
Module Name: MicrosoftTeams
3+
title: Get-CsTeamsCustomBannerText
4+
author: saleens7
5+
ms.author: wblocker
6+
online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsCustomBannerText
7+
schema: 2.0.0
8+
---
9+
10+
11+
# Get-CsTeamsCustomBannerText
12+
13+
## SYNOPSIS
14+
15+
Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call.
16+
17+
## SYNTAX
18+
19+
### Identity (Default)
20+
```
21+
Get-CsTeamsCustomBannerText [[-Identity] <String>] [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
26+
Returns all or a single instance of custom banner texts.
27+
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
```powershell
33+
PS C:\> Get-CsTeamsCustomBannerText
34+
```
35+
36+
Gets the properties of all instances of the TeamsCustomBannerText.
37+
38+
### Example 2
39+
```powershell
40+
PS C:\> Get-CsTeamsCustomBannerText -Identity CustomText
41+
```
42+
43+
Gets the properties of the CustomText instance of TeamsCustomBannerText.
44+
45+
## PARAMETERS
46+
47+
### -Identity
48+
Policy instance name (optional).
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: Identity
53+
Aliases:
54+
Applicable: Microsoft Teams
55+
Required: False
56+
Position: 1
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### CommonParameters
63+
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).
64+
65+
66+
## INPUTS
67+
68+
### None
69+
70+
## OUTPUTS
71+
72+
### System.Object
73+
## NOTES
74+
75+
## RELATED LINKS
76+
77+
[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md)
78+
79+
[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md)
80+
81+
[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md)

‎teams/teams-ps/teams/New-CsTeamsCustomBannerText

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
Module Name: MicrosoftTeams
3+
title: New-CsTeamsCustomBannerText
4+
author: saleens7
5+
ms.author: wblocker
6+
online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsCustomBannerText
7+
schema: 2.0.0
8+
---
9+
10+
# New-CsTeamsCustomBannerText
11+
12+
## SYNOPSIS
13+
14+
Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call.
15+
16+
## SYNTAX
17+
18+
### Identity (Default)
19+
```
20+
New-CsTeamsCustomBannerText [[-Id] <Guid>] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Creates a single instance of a custom banner text.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
31+
```powershell
32+
PS C:\> New-CsTeamsCustomBannerText -Identity CustomText
33+
```
34+
35+
Creates an instance of TeamsCustomBannerText with the name CustomText.
36+
37+
## PARAMETERS
38+
39+
### -Id
40+
The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create.
41+
42+
```yaml
43+
Type: Guid
44+
Parameter Sets: Identity
45+
Aliases:
46+
Applicable: Microsoft Teams
47+
Required: False
48+
Position: 1
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -Text
55+
The text that the tenant admin would like to set in the policy.
56+
57+
```yaml
58+
Type: String
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -Description
66+
The description that the tenant admin would like to set to identify what this text represents.
67+
68+
```yaml
69+
Type: String
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
77+
### CommonParameters
78+
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).
79+
80+
81+
## INPUTS
82+
83+
### None
84+
85+
## OUTPUTS
86+
87+
### System.Object
88+
## NOTES
89+
90+
## RELATED LINKS
91+
92+
[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md)
93+
94+
[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md)
95+
96+
[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md)

‎teams/teams-ps/teams/Remove-CsTeamsCustomBannerText

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
Module Name: MicrosoftTeams
3+
title: Remove-CsTeamsCustomBannerText
4+
author: saleens7
5+
ms.author: wblocker
6+
online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText
7+
schema: 2.0.0
8+
---
9+
10+
# Remove-CsTeamsCustomBannerText
11+
12+
## SYNOPSIS
13+
14+
Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call.
15+
16+
## SYNTAX
17+
18+
### Identity (Default)
19+
```
20+
Remove-CsTeamsCustomBannerText [[-Identity] <String>] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Removes a single instance of custom banner text.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText
31+
```
32+
33+
Removes a TeamsCustomBannerText instance with the name "CustomText".
34+
35+
## PARAMETERS
36+
37+
### -Identity
38+
Policy instance name (optional).
39+
40+
```yaml
41+
Type: String
42+
Parameter Sets: Identity
43+
Aliases:
44+
Applicable: Microsoft Teams
45+
Required: False
46+
Position: 1
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### CommonParameters
53+
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).
54+
55+
56+
## INPUTS
57+
58+
### None
59+
60+
## OUTPUTS
61+
62+
### System.Object
63+
## NOTES
64+
65+
## RELATED LINKS
66+
67+
[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md)
68+
69+
[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md)
70+
71+
[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md)

‎teams/teams-ps/teams/Set-CsTeamsCustomBannerText

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
Module Name: MicrosoftTeams
3+
title: Set-CsTeamsCustomBannerText
4+
author: saleens7
5+
ms.author: wblocker
6+
online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText
7+
schema: 2.0.0
8+
---
9+
10+
# Set-CsTeamsCustomBannerText
11+
12+
## SYNOPSIS
13+
14+
Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call.
15+
16+
## SYNTAX
17+
18+
### Identity (Default)
19+
```
20+
Set-CsTeamsCustomBannerText [[-Id] <Guid>] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Updates a single instance of a custom banner text.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
PS C:\> Set-CsTeamsCustomBannerText -Identity CustomText
31+
```
32+
33+
Sets the properties of the CustomText instance of TeamsCustomBannerText.
34+
35+
## PARAMETERS
36+
37+
### -Id
38+
The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create.
39+
40+
```yaml
41+
Type: Guid
42+
Parameter Sets: Identity
43+
Aliases:
44+
Applicable: Microsoft Teams
45+
Required: False
46+
Position: 1
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### -Text
53+
The text that the tenant admin would like to set in the policy.
54+
55+
```yaml
56+
Type: String
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### -Description
64+
The description that the tenant admin would like to set to identify what this text represents.
65+
66+
```yaml
67+
Type: String
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### CommonParameters
75+
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).
76+
77+
78+
## INPUTS
79+
80+
### None
81+
82+
## OUTPUTS
83+
84+
### System.Object
85+
## NOTES
86+
87+
## RELATED LINKS
88+
89+
[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md)
90+
91+
[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md)
92+
93+
[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md)

0 commit comments

Comments
 (0)