New-MgChatTab
Add (pin) a tab to the specified chat. The corresponding app must already be installed in the chat.
Note
To view the beta release of this cmdlet, view New-MgBetaChatTab
Syntax
New-MgChatTab
-ChatId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Configuration <IMicrosoftGraphTeamsTabConfiguration>]
[-DisplayName <String>]
[-Id <String>]
[-TeamsApp <IMicrosoftGraphTeamsApp>]
[-WebUrl <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgChatTab
-ChatId <String>
-BodyParameter <IMicrosoftGraphTeamsTab>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgChatTab
-InputObject <ITeamsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Configuration <IMicrosoftGraphTeamsTabConfiguration>]
[-DisplayName <String>]
[-Id <String>]
[-TeamsApp <IMicrosoftGraphTeamsApp>]
[-WebUrl <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgChatTab
-InputObject <ITeamsIdentity>
-BodyParameter <IMicrosoftGraphTeamsTab>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Add (pin) a tab to the specified chat. The corresponding app must already be installed in the chat.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | TeamsTab.Create | TeamsTab.ReadWrite.All, TeamsTab.ReadWriteForChat, TeamsTab.ReadWriteSelfForChat |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | TeamsTab.Create | TeamsTab.Create.Chat, TeamsTab.ReadWrite.All, TeamsTab.ReadWrite.Chat, TeamsTab.ReadWriteForChat.All, TeamsTab.ReadWriteSelfForChat.All |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Teams
$params = @{
displayName = "My Contoso Tab"
"teamsApp@odata.bind" = "https://graph.microsoft.com/v1.0/appCatalogs/teamsApps/06805b9e-77e3-4b93-ac81-525eb87513b8"
configuration = @{
entityId = "2DCA2E6C7A10415CAF6B8AB6661B3154"
contentUrl = "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView"
websiteUrl = "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154"
removeUrl = "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/uninstallTab"
}
}
New-MgChatTab -ChatId $chatId -BodyParameter $params
This example shows how to use the New-MgChatTab Cmdlet.
To learn about permissions for this resource, see the permissions reference.
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
teamsTab To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphTeamsTab |
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 |
-Configuration
teamsTabConfiguration To construct, see NOTES section for CONFIGURATION properties and create a hash table.
Type: | IMicrosoftGraphTeamsTabConfiguration |
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 |
-DisplayName
Name of the tab.
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 |
-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 |
-WebUrl
Deep link URL of the tab instance. Read only.
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.IMicrosoftGraphTeamsTab
Microsoft.Graph.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTeamsTab
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 <IMicrosoftGraphTeamsTab>
: teamsTab
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[ContentUrl <String>]
: Url used for rendering tab contents in Teams. Required.[EntityId <String>]
: Identifier for the entity hosted by the tab provider.[RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.[WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
[DisplayName <String>]
: Name of the tab.[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.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.
[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.
[WebUrl <String>]
: Deep link URL of the tab instance. Read only.
CONFIGURATION <IMicrosoftGraphTeamsTabConfiguration>
: teamsTabConfiguration
[(Any) <Object>]
: This indicates any property can be added to this object.[ContentUrl <String>]
: Url used for rendering tab contents in Teams. Required.[EntityId <String>]
: Identifier for the entity hosted by the tab provider.[RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.[WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
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.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.
[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.
RELATED LINKS
https://learn.microsoft.com/powershell/module/microsoft.graph.teams/new-mgchattab
https://learn.microsoft.com/graph/api/chat-post-tabs?view=graph-rest-1.0