New-MgBetaAppCatalogTeamApp

Module:

Microsoft.Graph.Beta.Teams

Publish an app to the Microsoft Teams app catalog.Specifically, this API publishes the app to your organization's catalog (the tenant app catalog);the created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center.

Note

To view the v1.0 release of this cmdlet, view New-MgAppCatalogTeamApp

Syntax

New-MgBetaAppCatalogTeamApp
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-AppDefinitions <IMicrosoftGraphTeamsAppDefinition[]>]
   [-DisplayName <String>]
   [-DistributionMethod <String>]
   [-ExternalId <String>]
   [-Id <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-MgBetaAppCatalogTeamApp
   -BodyParameter <IMicrosoftGraphTeamsApp>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Publish an app to the Microsoft Teams app catalog.Specifically, this API publishes the app to your organization's catalog (the tenant app catalog);the created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Teams

$params = [Zip file containing a Teams app package]


New-MgBetaAppCatalogTeamApp -BodyParameter $params

This example shows how to use the New-MgBetaAppCatalogTeamApp Cmdlet.

Example 2: Code snippet

Import-Module Microsoft.Graph.Beta.Teams

New-MgBetaAppCatalogTeamApp -Requiresreview true

This example shows how to use the New-MgBetaAppCatalogTeamApp Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

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

-AppDefinitions

The details for each version of the app. To construct, see NOTES section for APPDEFINITIONS properties and create a hash table.

Type:	IMicrosoftGraphTeamsAppDefinition[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

teamsApp To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.

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

-DistributionMethod

teamsAppDistributionMethod

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

-ExternalId

The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.

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

-Headers

Optional headers that will be added to the request.

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

-Id

The unique identifier for an entity. Read-only.

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphTeamsApp

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphTeamsApp

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

APPDEFINITIONS <IMicrosoftGraphTeamsAppDefinition- []>: The details for each version of the app.

• [Id <String>]: The unique identifier for an entity. Read-only.
• [AllowedInstallationScopes <String>]: teamsAppInstallationScopes
• [Authorization <IMicrosoftGraphTeamsAppAuthorization>]: teamsAppAuthorization
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]: teamsAppPermissionSet
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission- []>]: A collection of resource-specific permissions.
      • [PermissionType <String>]: teamsAppResourceSpecificPermissionType
      • [PermissionValue <String>]: The name of the resource-specific permission.
• [AzureAdAppId <String>]: The WebApplicationInfo.Id from the Teams app manifest.
• [Bot <IMicrosoftGraphTeamworkBot>]: teamworkBot
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
• [ColorIcon <IMicrosoftGraphTeamsAppIcon>]: teamsAppIcon
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [HostedContent <IMicrosoftGraphTeamworkHostedContent>]: teamworkHostedContent
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ContentBytes <Byte- []>]: Write only. Bytes for the hosted content (such as images).
    • [ContentType <String>]: Write only. Content type, such as image/png, image/jpg.
  • [WebUrl <String>]: The web URL that can be used for downloading the image.
• [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Application <IMicrosoftGraphIdentity>]: identity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. The display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user won't show up as having changed when using delta.
    • [Id <String>]: Unique identifier for the identity. When the unique identifier is unavailable, the displayName property is provided for the identity, but the id property isn't included in the response.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity
• [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition- []>]: Dashboard cards specified in the Teams app manifest.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]: teamsAppDashboardCardContentSource
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]: teamsAppDashboardCardBotConfiguration
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [BotId <String>]: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition. This is a unique app ID for the bot as registered with the Bot Framework.
    • [SourceType <String>]: teamsAppDashboardCardSourceType
  • [DefaultSize <String>]: teamsAppDashboardCardSize
  • [Description <String>]: The description for the card. Required.
  • [DisplayName <String>]: The name of the card. Required.
  • [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]: teamsAppDashboardCardIcon
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [IconUrl <String>]: The icon for the card, displayed in the toolbox and card bar, is represented as a URL. The preferred size for raster images is 28x28 pixels. If this property has a value, the officeFabricIconFontName property is ignored.
    • [OfficeUiFabricIconName <String>]: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified. For example, 'officeUIFabricIconName': 'Search'.
  • [PickerGroupId <String>]: ID for the group in the card picker. Required.
• [Description <String>]:
• [DisplayName <String>]: The name of the app provided by the app developer.
• [LastModifiedDateTime <DateTime?>]:
• [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]: teamsAppIcon
• [PublishingState <String>]: teamsAppPublishingState
• [Shortdescription <String>]:
• [TeamsAppId <String>]: The ID from the Teams app manifest.
• [Version <String>]: The version number of the application.

BODYPARAMETER <IMicrosoftGraphTeamsApp>: teamsApp

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Id <String>]: The unique identifier for an entity. Read-only.
• [AppDefinitions <IMicrosoftGraphTeamsAppDefinition- []>]: The details for each version of the app.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AllowedInstallationScopes <String>]: teamsAppInstallationScopes
  • [Authorization <IMicrosoftGraphTeamsAppAuthorization>]: teamsAppAuthorization
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]: teamsAppPermissionSet
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission- []>]: A collection of resource-specific permissions.
        • [PermissionType <String>]: teamsAppResourceSpecificPermissionType
        • [PermissionValue <String>]: The name of the resource-specific permission.
  • [AzureAdAppId <String>]: The WebApplicationInfo.Id from the Teams app manifest.
  • [Bot <IMicrosoftGraphTeamworkBot>]: teamworkBot
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ColorIcon <IMicrosoftGraphTeamsAppIcon>]: teamsAppIcon
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [HostedContent <IMicrosoftGraphTeamworkHostedContent>]: teamworkHostedContent
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [ContentBytes <Byte- []>]: Write only. Bytes for the hosted content (such as images).
      • [ContentType <String>]: Write only. Content type, such as image/png, image/jpg.
    • [WebUrl <String>]: The web URL that can be used for downloading the image.
  • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Application <IMicrosoftGraphIdentity>]: identity
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: The display name of the identity. The display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user won't show up as having changed when using delta.
      • [Id <String>]: Unique identifier for the identity. When the unique identifier is unavailable, the displayName property is provided for the identity, but the id property isn't included in the response.
    • [Device <IMicrosoftGraphIdentity>]: identity
    • [User <IMicrosoftGraphIdentity>]: identity
  • [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition- []>]: Dashboard cards specified in the Teams app manifest.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]: teamsAppDashboardCardContentSource
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]: teamsAppDashboardCardBotConfiguration
        • [(Any) <Object>]: This indicates any property can be added to this object.
        • [BotId <String>]: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition. This is a unique app ID for the bot as registered with the Bot Framework.
      • [SourceType <String>]: teamsAppDashboardCardSourceType
    • [DefaultSize <String>]: teamsAppDashboardCardSize
    • [Description <String>]: The description for the card. Required.
    • [DisplayName <String>]: The name of the card. Required.
    • [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]: teamsAppDashboardCardIcon
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [IconUrl <String>]: The icon for the card, displayed in the toolbox and card bar, is represented as a URL. The preferred size for raster images is 28x28 pixels. If this property has a value, the officeFabricIconFontName property is ignored.
      • [OfficeUiFabricIconName <String>]: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified. For example, 'officeUIFabricIconName': 'Search'.
    • [PickerGroupId <String>]: ID for the group in the card picker. Required.
  • [Description <String>]:
  • [DisplayName <String>]: The name of the app provided by the app developer.
  • [LastModifiedDateTime <DateTime?>]:
  • [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]: teamsAppIcon
  • [PublishingState <String>]: teamsAppPublishingState
  • [Shortdescription <String>]:
  • [TeamsAppId <String>]: The ID from the Teams app manifest.
  • [Version <String>]: The version number of the application.
• [DisplayName <String>]: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
• [DistributionMethod <String>]: teamsAppDistributionMethod
• [ExternalId <String>]: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.beta.teams/new-mgbetaappcatalogteamapp

https://learn.microsoft.com/graph/api/teamsapp-publish?view=graph-rest-1.0