Share via

Update-MgBetaUserMailboxSetting

Module:
Microsoft.Graph.Beta.Users Module

Update property mailboxSettings value.

Note

To view the v1.0 release of this cmdlet, view Update-MgUserMailboxSetting

Syntax

UpdateExpanded (Default) 

Update-MgBetaUserMailboxSetting
    -UserId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ArchiveFolder <String>]
    [-AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]
    [-DateFormat <String>]
    [-DelegateMeetingMessageDeliveryOptions <String>]
    [-Language <IMicrosoftGraphLocaleInfo>]
    [-TimeFormat <String>]
    [-TimeZone <String>]
    [-UserPurpose <String>]
    [-UserPurposeV2 <String>]
    [-WorkingHours <IMicrosoftGraphWorkingHours>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgBetaUserMailboxSetting
    -UserId <String>
    -BodyParameter <IMicrosoftGraphMailboxSettings>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgBetaUserMailboxSetting
    -InputObject <IUsersIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-ArchiveFolder <String>]
    [-AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]
    [-DateFormat <String>]
    [-DelegateMeetingMessageDeliveryOptions <String>]
    [-Language <IMicrosoftGraphLocaleInfo>]
    [-TimeFormat <String>]
    [-TimeZone <String>]
    [-UserPurpose <String>]
    [-UserPurposeV2 <String>]
    [-WorkingHours <IMicrosoftGraphWorkingHours>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgBetaUserMailboxSetting
    -InputObject <IUsersIdentity>
    -BodyParameter <IMicrosoftGraphMailboxSettings>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update property mailboxSettings value.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) MailboxSettings.ReadWrite,
Delegated (personal Microsoft account) MailboxSettings.ReadWrite,
Application MailboxSettings.ReadWrite,

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ArchiveFolder

Folder ID of an archive folder for the user. Read-only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AutomaticRepliesSetting

automaticRepliesSetting To construct, see NOTES section for AUTOMATICREPLIESSETTING properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphAutomaticRepliesSetting
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

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

Parameter properties

Type:IMicrosoftGraphMailboxSettings
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DateFormat

The date format for the user's mailbox.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DelegateMeetingMessageDeliveryOptions

delegateMeetingMessageDeliveryOptions

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IUsersIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Language

localeInfo To construct, see NOTES section for LANGUAGE properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphLocaleInfo
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TimeFormat

The time format for the user's mailbox.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TimeZone

The default time zone for the user's mailbox.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserId

The unique identifier of user

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserPurpose

userPurpose

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserPurposeV2

mailboxRecipientType

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkingHours

workingHours To construct, see NOTES section for WORKINGHOURS properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphWorkingHours
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMailboxSettings

Microsoft.Graph.Beta.PowerShell.Models.IUsersIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMailboxSettings

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.

AUTOMATICREPLIESSETTING <IMicrosoftGraphAutomaticRepliesSetting>: automaticRepliesSetting

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ExternalAudience <String>]: externalAudienceScope
  • [ExternalReplyMessage <String>]: The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.
  • [InternalReplyMessage <String>]: The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled.
  • [ScheduledEndDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.
    • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
  • [ScheduledStartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
  • [Status <String>]: automaticRepliesStatus

BODYPARAMETER <IMicrosoftGraphMailboxSettings>: mailboxSettings

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ArchiveFolder <String>]: Folder ID of an archive folder for the user. Read-only.
  • [AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]: automaticRepliesSetting
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [ExternalAudience <String>]: externalAudienceScope
    • [ExternalReplyMessage <String>]: The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.
    • [InternalReplyMessage <String>]: The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled.
    • [ScheduledEndDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.
      • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
    • [ScheduledStartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
    • [Status <String>]: automaticRepliesStatus
  • [DateFormat <String>]: The date format for the user's mailbox.
  • [DelegateMeetingMessageDeliveryOptions <String>]: delegateMeetingMessageDeliveryOptions
  • [Language <IMicrosoftGraphLocaleInfo>]: localeInfo
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: A name representing the user's locale in natural language, for example, 'English (United States)'.
    • [Locale <String>]: A locale representation for the user, which includes the user's preferred language and country/region. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.
  • [TimeFormat <String>]: The time format for the user's mailbox.
  • [TimeZone <String>]: The default time zone for the user's mailbox.
  • [UserPurpose <String>]: userPurpose
  • [UserPurposeV2 <String>]: mailboxRecipientType
  • [WorkingHours <IMicrosoftGraphWorkingHours>]: workingHours
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DaysOfWeek <String- []>]: The days of the week on which the user works.
    • [EndTime <String>]: The time of the day that the user stops working.
    • [StartTime <String>]: The time of the day that the user starts working.
    • [TimeZone <IMicrosoftGraphTimeZoneBase>]: timeZoneBase
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Name <String>]: The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone.

INPUTOBJECT <IUsersIdentity>: Identity Parameter

  • [AppId <String>]: Alternate key of servicePrincipal
  • [AttachmentBaseId <String>]: The unique identifier of attachmentBase
  • [AttachmentId <String>]: The unique identifier of attachment
  • [AttachmentSessionId <String>]: The unique identifier of attachmentSession
  • [ChecklistItemId <String>]: The unique identifier of checklistItem
  • [DirectoryObjectId <String>]: The unique identifier of directoryObject
  • [ExtensionId <String>]: The unique identifier of extension
  • [LicenseDetailsId <String>]: The unique identifier of licenseDetails
  • [LinkedResourceId <String>]: The unique identifier of linkedResource
  • [NotificationId <String>]: The unique identifier of notification
  • [OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant
  • [OutlookCategoryId <String>]: The unique identifier of outlookCategory
  • [OutlookTaskFolderId <String>]: The unique identifier of outlookTaskFolder
  • [OutlookTaskGroupId <String>]: The unique identifier of outlookTaskGroup
  • [OutlookTaskId <String>]: The unique identifier of outlookTask
  • [ProfilePhotoId <String>]: The unique identifier of profilePhoto
  • [ServicePrincipalId <String>]: The unique identifier of servicePrincipal
  • [ServiceStorageQuotaBreakdownId <String>]: The unique identifier of serviceStorageQuotaBreakdown
  • [SharedInsightId <String>]: The unique identifier of sharedInsight
  • [TimeZoneStandard <String>]: Usage: TimeZoneStandard='{TimeZoneStandard}'
  • [TodoTaskId <String>]: The unique identifier of todoTask
  • [TodoTaskListId <String>]: The unique identifier of todoTaskList
  • [TrendingId <String>]: The unique identifier of trending
  • [UsedInsightId <String>]: The unique identifier of usedInsight
  • [UserId <String>]: The unique identifier of user
  • [UserPrincipalName <String>]: Alternate key of user
  • [WindowsSettingId <String>]: The unique identifier of windowsSetting
  • [WindowsSettingInstanceId <String>]: The unique identifier of windowsSettingInstance

LANGUAGE <IMicrosoftGraphLocaleInfo>: localeInfo

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DisplayName <String>]: A name representing the user's locale in natural language, for example, 'English (United States)'.
  • [Locale <String>]: A locale representation for the user, which includes the user's preferred language and country/region. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.

WORKINGHOURS <IMicrosoftGraphWorkingHours>: workingHours

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DaysOfWeek <String- []>]: The days of the week on which the user works.
  • [EndTime <String>]: The time of the day that the user stops working.
  • [StartTime <String>]: The time of the day that the user starts working.
  • [TimeZone <IMicrosoftGraphTimeZoneBase>]: timeZoneBase
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Name <String>]: The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone.