Skip to content

Commit dce35e3

Browse files
authored
Create Get-TeamsApp.md
1 parent 9843c8f commit dce35e3

File tree

1 file changed

+122
-0
lines changed

1 file changed

+122
-0
lines changed

teams/teams-ps/teams/Get-TeamsApp.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
title: Get-TeamsApp
5+
author: joeyglocke
6+
ms.author: joglocke
7+
ms.reviewer: ken.withee
8+
manager: islubin
9+
online version:
10+
schema: 2.0.0
11+
---
12+
13+
# Get-TeamsApp
14+
15+
## SYNOPSIS
16+
Returns app information from the Teams tenant app store.
17+
18+
## SYNTAX
19+
20+
```
21+
Get-TeamsApp [-Id <String>] [-ExternalId <String>] [-DisplayName <String>] [-DistributionMethod <String>]
22+
[<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Use any optional parameter to retrieve app information from the Teams tenant app store.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Get-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775
33+
```
34+
35+
### Example 2
36+
```powershell
37+
PS C:\> Get-TeamsApp -ExternalId b00080be-9b31-4927-9e3e-fa8024a7d98a -DisplayName <String>] [-DistributionMethod <String>]
38+
```
39+
40+
### Example 3
41+
```powershell
42+
PS C:\> Get-TeamsApp -DisplayName SampleApp -DistributionMethod organization
43+
```
44+
45+
## PARAMETERS
46+
47+
### -DisplayName
48+
Name of the app visible to users
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
Aliases:
54+
55+
Required: False
56+
Position: Named
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### -DistributionMethod
63+
The type of app in Teams: global or organization. For LOB apps, use "organization"
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -ExternalId
78+
The external ID of the app, provided by the app developer and used by Azure Active Directory
79+
80+
```yaml
81+
Type: String
82+
Parameter Sets: (All)
83+
Aliases:
84+
85+
Required: False
86+
Position: Named
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### -Id
93+
The app's ID generated by Teams (different from the external ID)
94+
95+
```yaml
96+
Type: String
97+
Parameter Sets: (All)
98+
Aliases:
99+
100+
Required: False
101+
Position: Named
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
### CommonParameters
108+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
109+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
110+
111+
## INPUTS
112+
113+
### None
114+
115+
116+
## OUTPUTS
117+
118+
### System.Object
119+
120+
## NOTES
121+
122+
## RELATED LINKS

0 commit comments

Comments
 (0)