New-MgBetaUserChatInstalledApp
Install a teamsApp to the specified chat.
Note
To view the v1.0 release of this cmdlet, view New-MgUserChatInstalledApp
Syntax
New-MgBetaUserChatInstalledApp
-ChatId <String>
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
[-Id <String>]
[-TeamsApp <IMicrosoftGraphTeamsApp>]
[-TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgBetaUserChatInstalledApp
-ChatId <String>
-UserId <String>
-BodyParameter <IMicrosoftGraphTeamsAppInstallation>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgBetaUserChatInstalledApp
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
[-Id <String>]
[-TeamsApp <IMicrosoftGraphTeamsApp>]
[-TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgBetaUserChatInstalledApp
-InputObject <ITeamsIdentity>
-BodyParameter <IMicrosoftGraphTeamsAppInstallation>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Install a teamsApp to the specified chat.
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.Beta.PowerShell.Models.IMicrosoftGraphTeamsAppInstallation
Microsoft.Graph.Beta.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.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.[AllowedInstallationScopes <String>]: teamsAppInstallationScopes[Authorization <IMicrosoftGraphTeamsAppAuthorization>]: teamsAppAuthorization[(Any) <Object>]: This indicates any property can be added to this object.[RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]: teamsAppPermissionSet
[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.
[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[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
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.[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.
[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.[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.
RELATED LINKS
https://learn.microsoft.com/graph/api/chat-post-installedapps?view=graph-rest-1.0