Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for TeamsCustomAppSetting #11833

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
external help file: MicrosoftTeams-help.xml
Module Name: MicrosoftTeams
online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp
schema: 2.0.0
---

# Get-CsTeamsSettingsCustomApp

## SYNOPSIS
Get the Custom Apps Setting's value of Teams Admin Center.

## SYNTAX

```
Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
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.

## EXAMPLES

### Example 1
```powershell
PS C:\> Get-CsTeamsSettingsCustomApp

IsSideloadedAppsInteractionEnabled
----------------------------------
False
```

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.

## PARAMETERS

### -Confirm
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

## INPUTS

### None

## OUTPUTS

### System.Object
## NOTES

## RELATED LINKS
[Set-CsTeamsSettingsCustomApp](Set-CsTeamsSettingsCustomApp.md)
93 changes: 93 additions & 0 deletions teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
external help file: MicrosoftTeams-help.xml
Module Name: MicrosoftTeams
online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp
schema: 2.0.0
---

# Set-CsTeamsSettingsCustomApp

## SYNOPSIS
Set the Custom Apps Setting's value of Teams Admin Center.

## SYNTAX

```
Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled <Boolean>
[-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
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.

## EXAMPLES

### Example 1
```powershell
PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True
```

Set the value of Custom Apps Setting to true.

## PARAMETERS

### -Confirm
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -isSideloadedAppsInteractionEnabled
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.

```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

## INPUTS

### None

## OUTPUTS

### System.Object
## NOTES

## RELATED LINKS
[Get-CsTeamsSettingsCustomApp](Get-CsTeamsSettingsCustomApp.md)