New-MgUserChatInstalledApp

  • Reference
Module:
Microsoft.Graph.Teams

Install a teamsApp to the specified chat.

Note

To view the beta release of this cmdlet, view New-MgBetaUserChatInstalledApp

Syntax

New-MgUserChatInstalledApp
   -ChatId <String>
   -UserId <String>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
   [-Id <String>]
   [-TeamsApp <IMicrosoftGraphTeamsApp>]
   [-TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgUserChatInstalledApp
   -ChatId <String>
   -UserId <String>
   -BodyParameter <IMicrosoftGraphTeamsAppInstallation>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgUserChatInstalledApp
   -InputObject <ITeamsIdentity>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
   [-Id <String>]
   [-TeamsApp <IMicrosoftGraphTeamsApp>]
   [-TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgUserChatInstalledApp
   -InputObject <ITeamsIdentity>
   -BodyParameter <IMicrosoftGraphTeamsAppInstallation>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Install a teamsApp to the specified chat.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) TeamsAppInstallation.ReadWriteSelfForChat TeamsAppInstallation.ReadWriteAndConsentForChat, TeamsAppInstallation.ReadWriteAndConsentSelfForChat, TeamsAppInstallation.ReadWriteForChat
Delegated (personal Microsoft account) Not supported. Not supported.
Application TeamsAppInstallation.ReadWriteSelfForChat.All Chat.Manage.Chat, TeamsAppInstallation.ReadWriteAndConsentForChat.All, TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All, TeamsAppInstallation.ReadWriteForChat.All

Parameters

-AdditionalProperties

Additional Parameters

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

-BodyParameter

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

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

-ChatId

The unique identifier of chat

Type:String
Position:Named
Default value:None
Required:True
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

-ConsentedPermissionSet

teamsAppPermissionSet To construct, see NOTES section for CONSENTEDPERMISSIONSET properties and create a hash table.

Type:IMicrosoftGraphTeamsAppPermissionSet
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

-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

-TeamsApp

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

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

-TeamsAppDefinition

teamsAppDefinition To construct, see NOTES section for TEAMSAPPDEFINITION properties and create a hash table.

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

-UserId

The unique identifier of user

Type:String
Position:Named
Default value:None
Required:True
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.IMicrosoftGraphTeamsAppInstallation

Microsoft.Graph.PowerShell.Models.ITeamsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTeamsAppInstallation

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.

BODYPARAMETER <IMicrosoftGraphTeamsAppInstallation>: teamsAppInstallation

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ConsentedPermissionSet <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.
  • [TeamsApp <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.
      • [Authorization <IMicrosoftGraphTeamsAppAuthorization>]: teamsAppAuthorization
        • [(Any) <Object>]: This indicates any property can be added to this object.
        • [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]: teamsAppPermissionSet
      • [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.
    • [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.
  • [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]: teamsAppDefinition

CONSENTEDPERMISSIONSET <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.

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

TEAMSAPP <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.
    • [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.
  • [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.

TEAMSAPPDEFINITION <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.

New-MgBetaUserChatInstalledApp

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