Update-MgTeamworkWorkforceIntegration

  • Reference
Module:
Microsoft.Graph.Teams

Update the properties of a workforceIntegration object.

Note

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

Syntax

Update-MgTeamworkWorkforceIntegration
      -WorkforceIntegrationId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ApiVersion <Int32>]
      [-DisplayName <String>]
      [-Encryption <IMicrosoftGraphWorkforceIntegrationEncryption>]
      [-Id <String>]
      [-IsActive]
      [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
      [-SupportedEntities <String>]
      [-Url <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgTeamworkWorkforceIntegration
      -WorkforceIntegrationId <String>
      -BodyParameter <IMicrosoftGraphWorkforceIntegration>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgTeamworkWorkforceIntegration
      -InputObject <ITeamsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ApiVersion <Int32>]
      [-DisplayName <String>]
      [-Encryption <IMicrosoftGraphWorkforceIntegrationEncryption>]
      [-Id <String>]
      [-IsActive]
      [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
      [-SupportedEntities <String>]
      [-Url <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgTeamworkWorkforceIntegration
      -InputObject <ITeamsIdentity>
      -BodyParameter <IMicrosoftGraphWorkforceIntegration>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the properties of a workforceIntegration object.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) WorkforceIntegration.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Teams

$params = @{
	displayName = "displayName-value"
	apiVersion = 99
	encryption = @{
		protocol = "protocol-value"
		secret = "secret-value"
	}
	isActive = $true
	url = "url-value"
	supportedEntities = "supportedEntities-value"
}

Update-MgTeamworkWorkforceIntegration -WorkforceIntegrationId $workforceIntegrationId -BodyParameter $params

This example shows how to use the Update-MgTeamworkWorkforceIntegration Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

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

-ApiVersion

API version for the call back URL. Start with 1.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

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

Type:IMicrosoftGraphWorkforceIntegration
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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 workforce integration.

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

-Encryption

workforceIntegrationEncryption To construct, see NOTES section for ENCRYPTION properties and create a hash table.

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

-IsActive

Indicates whether this workforce integration is currently active and available.

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

-LastModifiedBy

identitySet To construct, see NOTES section for LASTMODIFIEDBY properties and create a hash table.

Type:IMicrosoftGraphIdentitySet
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-SupportedEntities

workforceIntegrationSupportedEntities

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

-Url

Workforce Integration URL for callbacks from the Shifts service.

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

-WorkforceIntegrationId

The unique identifier of workforceIntegration

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

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphWorkforceIntegration

Microsoft.Graph.PowerShell.Models.ITeamsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphWorkforceIntegration

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 <IMicrosoftGraphWorkforceIntegration>: workforceIntegration

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [LastModifiedBy <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
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ApiVersion <Int32?>]: API version for the call back URL. Start with 1.
  • [DisplayName <String>]: Name of the workforce integration.
  • [Encryption <IMicrosoftGraphWorkforceIntegrationEncryption>]: workforceIntegrationEncryption
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Protocol <String>]: workforceIntegrationEncryptionProtocol
    • [Secret <String>]: Encryption shared secret.
  • [IsActive <Boolean?>]: Indicates whether this workforce integration is currently active and available.
  • [SupportedEntities <String>]: workforceIntegrationSupportedEntities
  • [Url <String>]: Workforce Integration URL for callbacks from the Shifts service.

ENCRYPTION <IMicrosoftGraphWorkforceIntegrationEncryption>: workforceIntegrationEncryption

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Protocol <String>]: workforceIntegrationEncryptionProtocol
  • [Secret <String>]: Encryption shared secret.

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

LASTMODIFIEDBY <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