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).
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).
This example will update a new version of an existing app for admin review before publication in the current tenant catalog
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
Type:
Hashtable
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AllowedInstallationScopes
teamsAppInstallationScopes
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Authorization
teamsAppAuthorization
To construct, see NOTES section for AUTHORIZATION properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphTeamsAppAuthorization
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AzureAdAppId
The WebApplicationInfo.Id from the Teams app manifest.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-BodyParameter
teamsAppDefinition
To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphTeamsAppDefinition
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Create
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentity
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Bot
teamworkBot
Parameter properties
Type:
Hashtable
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ColorIcon
teamsAppIcon
To construct, see NOTES section for COLORICON properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphTeamsAppIcon
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CreatedBy
identitySet
To construct, see NOTES section for CREATEDBY properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphIdentitySet
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DashboardCards
Dashboard cards specified in the Teams app manifest.
To construct, see NOTES section for DASHBOARDCARDS properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphTeamsAppDashboardCardDefinition[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-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).
The name of the app provided by the app developer.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Headers
Optional headers that will be added to the request.
Parameter properties
Type:
IDictionary
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Id
The unique identifier for an entity.
Read-only.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
Type:
ITeamsIdentity
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentity
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-LastModifiedDateTime
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).
teamsAppIcon
To construct, see NOTES section for OUTLINEICON properties and create a hash table.
Parameter properties
Type:
IMicrosoftGraphTeamsAppIcon
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PublishingState
teamsAppPublishingState
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
RHV
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Shortdescription
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).
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
wi
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.
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.
[(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.
[(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.
[(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.
[(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
[PlannerBucketId <String>]: The unique identifier of plannerBucket
[PlannerPlanId <String>]: The unique identifier of plannerPlan
[PlannerTaskId <String>]: The unique identifier of plannerTask
[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
[UserPrincipalName <String>]: Alternate key of user
[UserScopeTeamsAppInstallationId <String>]: The unique identifier of userScopeTeamsAppInstallation
[WorkforceIntegrationId <String>]: The unique identifier of workforceIntegration