Skip to content

Latest commit

 

History

History
464 lines (386 loc) · 16.9 KB

Update-MgChatTab.md

File metadata and controls

464 lines (386 loc) · 16.9 KB
Raw
external help file Module Name online version schema
Microsoft.Graph.Teams-help.xml
Microsoft.Graph.Teams
2.0.0

Update-MgChatTab

SYNOPSIS

Update the properties of the specified tab in a chat. This can be used to configure the content of the tab.

Note

To view the beta release of this cmdlet, view Update-MgBetaChatTab

SYNTAX

UpdateExpanded (Default)

Update-MgChatTab -ChatId <String> -TeamsTabId <String> [-ResponseHeadersVariable <String>]
 [-AdditionalProperties <Hashtable>] [-Configuration <IMicrosoftGraphTeamsTabConfiguration>]
 [-DisplayName <String>] [-Id <String>] [-TeamsApp <IMicrosoftGraphTeamsApp>] [-WebUrl <String>]
 [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Update

Update-MgChatTab -ChatId <String> -TeamsTabId <String> -BodyParameter <IMicrosoftGraphTeamsTab>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgChatTab -InputObject <ITeamsIdentity> [-ResponseHeadersVariable <String>]
 [-AdditionalProperties <Hashtable>] [-Configuration <IMicrosoftGraphTeamsTabConfiguration>]
 [-DisplayName <String>] [-Id <String>] [-TeamsApp <IMicrosoftGraphTeamsApp>] [-WebUrl <String>]
 [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

UpdateViaIdentity

Update-MgChatTab -InputObject <ITeamsIdentity> -BodyParameter <IMicrosoftGraphTeamsTab>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Update the properties of the specified tab in a chat. This can be used to configure the content of the tab.

EXAMPLES

Example 1: Update the name of a tab in a chat

Import-Module Microsoft.Graph.Teams

$params = @{
	displayName = "My Contoso Tab - updated again"
}

Update-MgChatTab -ChatId $chatId -TeamsTabId $teamsTabId -BodyParameter $params

This example will update the name of a tab in a chat

PARAMETERS

-AdditionalProperties

Additional Parameters

Type: Hashtable
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: Update, UpdateViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ChatId

The unique identifier of chat

Type: String
Parameter Sets: UpdateExpanded, Update
Aliases:

Required: True
Position: Named
Default value: None
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
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

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

-DisplayName

Name of the tab.

Type: String
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

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

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Id

The unique identifier for an entity. Read-only.

Type: String
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

Required: False
Position: Named
Default value: None
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
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

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

-TeamsTabId

The unique identifier of teamsTab

Type: String
Parameter Sets: UpdateExpanded, Update
Aliases:

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

-WebUrl

Deep link URL of the tab instance. Read only.

Type: String
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

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

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.teams/update-mgchattab

https://learn.microsoft.com/graph/api/chat-patch-tabs?view=graph-rest-1.0