New-MgAppCatalogTeamAppDefinition

Module:

Microsoft.Graph.Teams Module

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

CreateExpanded (Default)

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>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded

New-MgAppCatalogTeamAppDefinition
    -InputObject <ITeamsIdentity>
    [-TeamsAppId <string>]
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Authorization <IMicrosoftGraphTeamsAppAuthorization>]
    [-Bot <hashtable>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-Description <string>]
    [-DisplayName <string>]
    [-Id <string>]
    [-LastModifiedDateTime <datetime>]
    [-PublishingState <string>]
    [-ShortDescription <string>]
    [-Version <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgAppCatalogTeamAppDefinition
    -TeamsAppId <string>
    -BodyParameter <IMicrosoftGraphTeamsAppDefinition>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentity

New-MgAppCatalogTeamAppDefinition
    -InputObject <ITeamsIdentity>
    -BodyParameter <IMicrosoftGraphTeamsAppDefinition>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-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).

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	AppCatalog.Submit, Directory.ReadWrite.All, AppCatalog.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	Not supported

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

Parameter properties

Type:	System.Collections.Hashtable
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTeamsAppAuthorization
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTeamsAppDefinition
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

Create

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:	System.Collections.Hashtable
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
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:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphIdentitySet
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-Description

Verbose description of the application.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-DisplayName

The name of the app provided by the app developer.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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:	System.Collections.IDictionary
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

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
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

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
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 unique identifier for an entity. Read-only.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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:	Microsoft.Graph.PowerShell.Models.ITeamsIdentity
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).

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	AppCatalog.Submit, Directory.ReadWrite.All, AppCatalog.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	Not supported

Parameter properties

Type:	System.DateTime
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
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

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
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

-PublishingState

teamsAppPublishingState

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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:	System.String
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

Short description of the application.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-TeamsAppId

The unique identifier of teamsApp

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Create

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TeamsAppId1

The ID from the Teams app manifest.

Parameter properties

Type:	System.String
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

-Version

The version number of the application.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
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.

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTeamsAppDefinition

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.ITeamsIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTeamsAppDefinition

{{ Fill in the Description }}

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. [ClientAppId <String>]: The registration ID of the Microsoft Entra app ID associated with the teamsApp. [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. [ClientAppId <String>]: The registration ID of the Microsoft Entra app ID associated with the teamsApp. [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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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 [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 [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 [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

Related Links

• New-MgAppCatalogTeamAppDefinition
• Graph API Reference