New-MgAppCatalogTeamAppDefinition
Update an app previously published to the Microsoft Teams app catalog. To update an app, the distributionMethod property for the app must be set to organization. This API specifically updates an app published to your organization's app catalog (the tenant app catalog).
Note
To view the beta release of this cmdlet, view New-MgBetaAppCatalogTeamAppDefinition
Syntax
New-MgAppCatalogTeamAppDefinition
-TeamsAppId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Authorization <IMicrosoftGraphTeamsAppAuthorization>]
[-Bot <Hashtable>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-Description <String>]
[-DisplayName <String>]
[-Id <String>]
[-LastModifiedDateTime <DateTime>]
[-PublishingState <String>]
[-ShortDescription <String>]
[-TeamsAppId1 <String>]
[-Version <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgAppCatalogTeamAppDefinition
[-TeamsAppId <String>]
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Authorization <IMicrosoftGraphTeamsAppAuthorization>]
[-Bot <Hashtable>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-Description <String>]
[-DisplayName <String>]
[-Id <String>]
[-LastModifiedDateTime <DateTime>]
[-PublishingState <String>]
[-ShortDescription <String>]
[-Version <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgAppCatalogTeamAppDefinition
-TeamsAppId <String>
-BodyParameter <IMicrosoftGraphTeamsAppDefinition>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgAppCatalogTeamAppDefinition
-InputObject <ITeamsIdentity>
-BodyParameter <IMicrosoftGraphTeamsAppDefinition>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update an app previously published to the Microsoft Teams app catalog. To update an app, the distributionMethod property for the app must be set to organization. This API specifically updates an app published to your organization's app catalog (the tenant app catalog).
Examples
Example 1: Update an application previously published to the Microsoft Teams app catalog
Import-Module Microsoft.Graph.Teams
$params = app.zip
New-MgAppCatalogTeamAppDefinition -TeamsAppId $teamsAppId -BodyParameter $params
This example will update an application previously published to the microsoft teams app catalog
Example 2: Update a new version of an existing app for admin review prior to publication in the current tenant catalog
Import-Module Microsoft.Graph.Teams
$params = app.zip
New-MgAppCatalogTeamAppDefinition -TeamsAppId $teamsAppId -Requiresreview true -BodyParameter $params
This example will update a new version of an existing app for admin review prior to publication in the current tenant catalog
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
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 |
-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 |
-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 |
-Description
Verbose description of the application.
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 |
-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
Short description of the application.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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.PowerShell.Models.IMicrosoftGraphTeamsAppDefinition
Microsoft.Graph.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.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.[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.
[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.
[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.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[Description <String>]
: Verbose description of the application.[DisplayName <String>]
: The name of the app provided by the app developer.[LastModifiedDateTime <DateTime?>]
:[PublishingState <String>]
: teamsAppPublishingState[ShortDescription <String>]
: Short description of the application.[TeamsAppId <String>]
: The ID from the Teams app manifest.[Version <String>]
: The version number of the application.
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.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
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[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[SwapShiftsChangeRequestId <String>]
: The unique identifier of swapShiftsChangeRequest[TeamId <String>]
: The unique identifier of team[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[TeamworkTagId <String>]
: The unique identifier of teamworkTag[TeamworkTagMemberId <String>]
: The unique identifier of teamworkTagMember[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