Update-MgBetaAppCatalogTeamAppDefinition
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 Update-MgAppCatalogTeamAppDefinition
Syntax
Update-MgBetaAppCatalogTeamAppDefinition
-TeamsAppDefinitionId <String>
-TeamsAppId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AllowedInstallationScopes <String>]
[-Authorization <IMicrosoftGraphTeamsAppAuthorization>]
[-AzureAdAppId <String>]
[-Bot <Hashtable>]
[-ColorIcon <IMicrosoftGraphTeamsAppIcon>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition[]>]
[-Description <String>]
[-DisplayName <String>]
[-Id <String>]
[-LastModifiedDateTime <DateTime>]
[-OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
[-PublishingState <String>]
[-Shortdescription <String>]
[-TeamsAppId1 <String>]
[-Version <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaAppCatalogTeamAppDefinition
-TeamsAppDefinitionId <String>
-TeamsAppId <String>
-BodyParameter <IMicrosoftGraphTeamsAppDefinition>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaAppCatalogTeamAppDefinition
[-TeamsAppId <String>]
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AllowedInstallationScopes <String>]
[-Authorization <IMicrosoftGraphTeamsAppAuthorization>]
[-AzureAdAppId <String>]
[-Bot <Hashtable>]
[-ColorIcon <IMicrosoftGraphTeamsAppIcon>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition[]>]
[-Description <String>]
[-DisplayName <String>]
[-Id <String>]
[-LastModifiedDateTime <DateTime>]
[-OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
[-PublishingState <String>]
[-Shortdescription <String>]
[-Version <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaAppCatalogTeamAppDefinition
-InputObject <ITeamsIdentity>
-BodyParameter <IMicrosoftGraphTeamsAppDefinition>
[-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.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowedInstallationScopes
teamsAppInstallationScopes
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Authorization
teamsAppAuthorization To construct, see NOTES section for AUTHORIZATION properties and create a hash table.
| Type: | IMicrosoftGraphTeamsAppAuthorization |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AzureAdAppId
The WebApplicationInfo.Id from the Teams app manifest.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
teamsAppDefinition To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphTeamsAppDefinition |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Bot
teamworkBot
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ColorIcon
teamsAppIcon To construct, see NOTES section for COLORICON properties and create a hash table.
| Type: | IMicrosoftGraphTeamsAppIcon |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-CreatedBy
identitySet To construct, see NOTES section for CREATEDBY properties and create a hash table.
| Type: | IMicrosoftGraphIdentitySet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DashboardCards
Dashboard cards specified in the Teams app manifest. To construct, see NOTES section for DASHBOARDCARDS properties and create a hash table.
| Type: | IMicrosoftGraphTeamsAppDashboardCardDefinition[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
The name of the app provided by the app developer.
| 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 |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | ITeamsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LastModifiedDateTime
.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutlineIcon
teamsAppIcon To construct, see NOTES section for OUTLINEICON properties and create a hash table.
| Type: | IMicrosoftGraphTeamsAppIcon |
| 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 |
-PublishingState
teamsAppPublishingState
| Type: | String |
| 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 |
-Shortdescription
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TeamsAppDefinitionId
The unique identifier of teamsAppDefinition
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TeamsAppId
The unique identifier of teamsApp
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TeamsAppId1
The ID from the Teams app manifest.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
The version number of the application.
| Type: | String |
| 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.IMicrosoftGraphTeamsAppDefinition
Microsoft.Graph.Beta.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphTeamsAppDefinition
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.
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.
BODYPARAMETER <IMicrosoftGraphTeamsAppDefinition>: teamsAppDefinition
[(Any) <Object>]: This indicates any property can be added to this object.[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.
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.
INPUTOBJECT <ITeamsIdentity>: Identity Parameter
[AssociatedTeamInfoId <String>]: The unique identifier of associatedTeamInfo[ChannelId <String>]: The unique identifier of channel[ChatId <String>]: The unique identifier of chat[ChatMessageHostedContentId <String>]: The unique identifier of chatMessageHostedContent[ChatMessageId <String>]: The unique identifier of chatMessage[ChatMessageId1 <String>]: The unique identifier of chatMessage[ConversationMemberId <String>]: The unique identifier of conversationMember[DayNoteId <String>]: The unique identifier of dayNote[DeletedChatId <String>]: The unique identifier of deletedChat[DeletedTeamId <String>]: The unique identifier of deletedTeam[GroupId <String>]: The unique identifier of group[OfferShiftRequestId <String>]: The unique identifier of offerShiftRequest[OpenShiftChangeRequestId <String>]: The unique identifier of openShiftChangeRequest[OpenShiftId <String>]: The unique identifier of openShift[PinnedChatMessageInfoId <String>]: The unique identifier of pinnedChatMessageInfo[ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant[SchedulingGroupId <String>]: The unique identifier of schedulingGroup[SharedWithChannelTeamInfoId <String>]: The unique identifier of sharedWithChannelTeamInfo[ShiftId <String>]: The unique identifier of shift[ShiftsRoleDefinitionId <String>]: The unique identifier of shiftsRoleDefinition[SwapShiftsChangeRequestId <String>]: The unique identifier of swapShiftsChangeRequest[TeamId <String>]: The unique identifier of team[TeamTemplateDefinitionId <String>]: The unique identifier of teamTemplateDefinition[TeamTemplateId <String>]: The unique identifier of teamTemplate[TeamsAppDashboardCardDefinitionId <String>]: The unique identifier of teamsAppDashboardCardDefinition[TeamsAppDefinitionId <String>]: The unique identifier of teamsAppDefinition[TeamsAppId <String>]: The unique identifier of teamsApp[TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation[TeamsAsyncOperationId <String>]: The unique identifier of teamsAsyncOperation[TeamsTabId <String>]: The unique identifier of teamsTab[TeamworkDeviceId <String>]: The unique identifier of teamworkDevice[TeamworkDeviceOperationId <String>]: The unique identifier of teamworkDeviceOperation[TeamworkTagId <String>]: The unique identifier of teamworkTag[TeamworkTagMemberId <String>]: The unique identifier of teamworkTagMember[TimeCardId <String>]: The unique identifier of timeCard[TimeOffId <String>]: The unique identifier of timeOff[TimeOffReasonId <String>]: The unique identifier of timeOffReason[TimeOffRequestId <String>]: The unique identifier of timeOffRequest[UserId <String>]: The unique identifier of user[UserScopeTeamsAppInstallationId <String>]: The unique identifier of userScopeTeamsAppInstallation[WorkforceIntegrationId <String>]: The unique identifier of workforceIntegration
OUTLINEICON <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.
RELATED LINKS
https://learn.microsoft.com/graph/api/teamsapp-publish?view=graph-rest-1.0