Skip to content

Commit 2235ee9

Browse files
Merge pull request #11833 from yishuaihuang4/yishuaihuang4-patch-2
Add docs for TeamsCustomAppSetting
2 parents d4e358d + 512bd60 commit 2235ee9

File tree

2 files changed

+174
-0
lines changed

2 files changed

+174
-0
lines changed
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsTeamsSettingsCustomApp
9+
10+
## SYNOPSIS
11+
Get the Custom Apps Setting's value of Teams Admin Center.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa.
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```powershell
26+
PS C:\> Get-CsTeamsSettingsCustomApp
27+
28+
IsSideloadedAppsInteractionEnabled
29+
----------------------------------
30+
False
31+
```
32+
33+
Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store.
34+
35+
## PARAMETERS
36+
37+
### -Confirm
38+
Prompts you for confirmation before running the cmdlet.
39+
40+
```yaml
41+
Type: SwitchParameter
42+
Parameter Sets: (All)
43+
Aliases: cf
44+
45+
Required: False
46+
Position: Named
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### -WhatIf
53+
Shows what would happen if the cmdlet runs.
54+
The cmdlet is not run.
55+
56+
```yaml
57+
Type: SwitchParameter
58+
Parameter Sets: (All)
59+
Aliases: wi
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### CommonParameters
69+
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).
70+
71+
## INPUTS
72+
73+
### None
74+
75+
## OUTPUTS
76+
77+
### System.Object
78+
## NOTES
79+
80+
## RELATED LINKS
81+
[Set-CsTeamsSettingsCustomApp](Set-CsTeamsSettingsCustomApp.md)
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp
5+
schema: 2.0.0
6+
---
7+
8+
# Set-CsTeamsSettingsCustomApp
9+
10+
## SYNOPSIS
11+
Set the Custom Apps Setting's value of Teams Admin Center.
12+
13+
## SYNTAX
14+
15+
```
16+
Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled <Boolean>
17+
[-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa.
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
```powershell
27+
PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True
28+
```
29+
30+
Set the value of Custom Apps Setting to true.
31+
32+
## PARAMETERS
33+
34+
### -Confirm
35+
Prompts you for confirmation before running the cmdlet.
36+
37+
```yaml
38+
Type: SwitchParameter
39+
Parameter Sets: (All)
40+
Aliases: cf
41+
42+
Required: False
43+
Position: Named
44+
Default value: None
45+
Accept pipeline input: False
46+
Accept wildcard characters: False
47+
```
48+
49+
### -WhatIf
50+
Shows what would happen if the cmdlet runs.
51+
The cmdlet is not run.
52+
53+
```yaml
54+
Type: SwitchParameter
55+
Parameter Sets: (All)
56+
Aliases: wi
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -isSideloadedAppsInteractionEnabled
66+
The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa.
67+
68+
```yaml
69+
Type: Boolean
70+
Parameter Sets: (All)
71+
Aliases:
72+
73+
Required: True
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### CommonParameters
81+
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).
82+
83+
## INPUTS
84+
85+
### None
86+
87+
## OUTPUTS
88+
89+
### System.Object
90+
## NOTES
91+
92+
## RELATED LINKS
93+
[Get-CsTeamsSettingsCustomApp](Get-CsTeamsSettingsCustomApp.md)

0 commit comments

Comments
 (0)