Edit

Share via

Get-TeamsApp

Module:
MicrosoftTeams PowerShell module

Returns app information from the Teams tenant app store.

Syntax

Default (Default) 

Get-TeamsApp
    [-Id <String>]
    [-ExternalId <String>]
    [-DisplayName <String>]
    [-DistributionMethod <String>]
    [<CommonParameters>]

Description

Use any optional parameter to retrieve app information from the Teams tenant app store.

Examples

Example 1

PS C:\> Get-TeamsApp -Id b9cc7986-dd56-4b57-ab7d-9c4e5288b775

Example 2

PS C:\> Get-TeamsApp -ExternalId b00080be-9b31-4927-9e3e-fa8024a7d98a -DisplayName <String>] [-DistributionMethod <String>]

Example 3

PS C:\> Get-TeamsApp -DisplayName SampleApp -DistributionMethod organization

Parameters

-DisplayName

Name of the app visible to users

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DistributionMethod

The type of app in Teams: global or organization. For LOB apps, use "organization"

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExternalId

The external ID of the app, provided by the app developer and used by Microsoft Entra ID

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The app's ID generated by Teams (different from the external ID)

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object