Skip to content

Commit 64867f6

Browse files
kenwithkenwith
authored
Merge pull request MicrosoftDocs#5320 from get-itips/teams1022cmdlets
Initial upload of -TeamsAppInstallation cmdlets
2 parents ba310a2 + 92fa9ac commit 64867f6

File tree

4 files changed

+475
-0
lines changed

4 files changed

+475
-0
lines changed

‎teams/teams-ps/teams/Add-TeamsAppInstallation.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://docs.microsoft.com/powershell/module/teams/add-teamsappinstallation
5+
schema: 2.0.0
6+
author: kenwith
7+
ms.author: kenwith
8+
ms.reviewer:
9+
---
10+
11+
# Add-TeamsAppInstallation
12+
13+
## SYNOPSIS
14+
Add a Teams App to Microsoft Teams.
15+
16+
## SYNTAX
17+
18+
### TeamScope
19+
```
20+
Add-TeamsAppInstallation -AppId <String> -TeamId <String> [-Permissions <String>] [<CommonParameters>]
21+
```
22+
23+
### UserScope
24+
```
25+
Add-TeamsAppInstallation -AppId <String> -UserId <String> [-Permissions <String>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
Add a Teams App to Microsoft Teams.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df
36+
```
37+
38+
This example adds a Teams App to Microsoft Teams.
39+
40+
## PARAMETERS
41+
42+
### -AppId
43+
Teams App identifier in Microsoft Teams.
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: True
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: True (ByPropertyName)
54+
Accept wildcard characters: False
55+
```
56+
57+
### -Permissions
58+
RSC permissions for the Teams App.
59+
60+
```yaml
61+
Type: String
62+
Parameter Sets: (All)
63+
Aliases:
64+
65+
Required: False
66+
Position: Named
67+
Default value: None
68+
Accept pipeline input: True (ByPropertyName)
69+
Accept wildcard characters: False
70+
```
71+
72+
### -TeamId
73+
Team identifier in Microsoft Teams.
74+
75+
```yaml
76+
Type: String
77+
Parameter Sets: TeamScope
78+
Aliases: GroupId
79+
80+
Required: True
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: True (ByPropertyName)
84+
Accept wildcard characters: False
85+
```
86+
87+
### -UserId
88+
User identifier in Microsoft Teams.
89+
90+
```yaml
91+
Type: String
92+
Parameter Sets: UserScope
93+
Aliases:
94+
95+
Required: True
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: True (ByPropertyName)
99+
Accept wildcard characters: False
100+
```
101+
102+
### CommonParameters
103+
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).
104+
105+
## INPUTS
106+
107+
### System.String
108+
109+
## OUTPUTS
110+
111+
### System.Object
112+
## NOTES
113+
114+
## RELATED LINKS

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

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://docs.microsoft.com/powershell/module/teams/get-teamsappinstallation
5+
schema: 2.0.0
6+
author: kenwith
7+
ms.author: kenwith
8+
ms.reviewer:
9+
---
10+
11+
# Get-TeamsAppInstallation
12+
13+
## SYNOPSIS
14+
Get a Teams App installed in Microsoft Teams.
15+
16+
## SYNTAX
17+
18+
### TeamScope (Default)
19+
```
20+
Get-TeamsAppInstallation -TeamId <String> [-AppInstallationId <String>] [-AppId <String>] [<CommonParameters>]
21+
```
22+
23+
### UserScope
24+
```
25+
Get-TeamsAppInstallation -UserId <String> [-AppInstallationId <String>] [-AppId <String>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
Get a Teams App installed in Microsoft Teams.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
PS C:\> Get-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df
36+
```
37+
38+
This example gets a Teams App specifying its AppId and the TeamId.
39+
40+
## PARAMETERS
41+
42+
### -AppId
43+
Teams App identifier in Microsoft Teams.
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: False
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: True (ByPropertyName)
54+
Accept wildcard characters: False
55+
```
56+
57+
### -AppInstallationId
58+
Installation identifier of the Teams App.
59+
60+
```yaml
61+
Type: String
62+
Parameter Sets: (All)
63+
Aliases:
64+
65+
Required: False
66+
Position: Named
67+
Default value: None
68+
Accept pipeline input: True (ByPropertyName)
69+
Accept wildcard characters: False
70+
```
71+
72+
### -TeamId
73+
Team identifier in Microsoft Teams.
74+
75+
```yaml
76+
Type: String
77+
Parameter Sets: TeamScope
78+
Aliases: GroupId
79+
80+
Required: True
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: True (ByPropertyName)
84+
Accept wildcard characters: False
85+
```
86+
87+
### -UserId
88+
User identifier in Microsoft Teams.
89+
90+
```yaml
91+
Type: String
92+
Parameter Sets: UserScope
93+
Aliases:
94+
95+
Required: True
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: True (ByPropertyName)
99+
Accept wildcard characters: False
100+
```
101+
102+
### CommonParameters
103+
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).
104+
105+
## INPUTS
106+
107+
### System.String
108+
109+
## OUTPUTS
110+
111+
### System.Object
112+
## NOTES
113+
114+
## RELATED LINKS

‎teams/teams-ps/teams/Remove-TeamsAppInstallation.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://docs.microsoft.com/powershell/module/teams/remove-teamsappinstallation
5+
schema: 2.0.0
6+
author: kenwith
7+
ms.author: kenwith
8+
ms.reviewer:
9+
---
10+
11+
# Remove-TeamsAppInstallation
12+
13+
## SYNOPSIS
14+
Removes a Teams App installed in Microsoft Teams.
15+
16+
## SYNTAX
17+
18+
### TeamScope
19+
```
20+
Remove-TeamsAppInstallation [-AppInstallationId <String>] [-AppId <String>] -TeamId <String>
21+
[<CommonParameters>]
22+
```
23+
24+
### UserScope
25+
```
26+
Remove-TeamsAppInstallation [-AppInstallationId <String>] [-AppId <String>] -UserId <String>
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
Removes a Teams App installed in Microsoft Teams.
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
```powershell
37+
PS C:\> Remove-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df
38+
```
39+
40+
This example removes a Teams App in Microsoft Teams specifying its AppId and TeamId.
41+
42+
## PARAMETERS
43+
44+
### -AppId
45+
Teams App identifier in Microsoft Teams.
46+
47+
```yaml
48+
Type: String
49+
Parameter Sets: (All)
50+
Aliases:
51+
52+
Required: False
53+
Position: Named
54+
Default value: None
55+
Accept pipeline input: True (ByPropertyName)
56+
Accept wildcard characters: False
57+
```
58+
59+
### -AppInstallationId
60+
Installation identifier of the Teams App.
61+
62+
```yaml
63+
Type: String
64+
Parameter Sets: (All)
65+
Aliases:
66+
67+
Required: False
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: True (ByPropertyName)
71+
Accept wildcard characters: False
72+
```
73+
74+
### -TeamId
75+
Team identifier in Microsoft Teams.
76+
77+
```yaml
78+
Type: String
79+
Parameter Sets: TeamScope
80+
Aliases: GroupId
81+
82+
Required: True
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: True (ByPropertyName)
86+
Accept wildcard characters: False
87+
```
88+
89+
### -UserId
90+
User identifier in Microsoft Teams.
91+
92+
```yaml
93+
Type: String
94+
Parameter Sets: UserScope
95+
Aliases:
96+
97+
Required: True
98+
Position: Named
99+
Default value: None
100+
Accept pipeline input: True (ByPropertyName)
101+
Accept wildcard characters: False
102+
```
103+
104+
### CommonParameters
105+
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).
106+
107+
## INPUTS
108+
109+
### System.String
110+
111+
## OUTPUTS
112+
113+
### System.Object
114+
## NOTES
115+
116+
## RELATED LINKS

0 commit comments

Comments
 (0)