Skip to content

Latest commit

 

History

History
398 lines (323 loc) · 12.8 KB

File metadata and controls

398 lines (323 loc) · 12.8 KB
external help file Module Name online version schema ms.subservice
Microsoft.Graph.Beta.Users.Actions-help.xml
Microsoft.Graph.Beta.Users.Actions
2.0.0
outlook

Invoke-MgBetaDeclineUserEvent

SYNOPSIS

Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

Note

To view the v1.0 release of this cmdlet, view Invoke-MgDeclineUserEvent

SYNTAX

DeclineExpanded (Default)

Invoke-MgBetaDeclineUserEvent -EventId <String> -UserId <String> [-ResponseHeadersVariable <String>]
 [-AdditionalProperties <Hashtable>] [-Comment <String>] [-ProposedNewTime <IMicrosoftGraphTimeSlot>]
 [-SendResponse] [-Headers <IDictionary>] [-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Decline

Invoke-MgBetaDeclineUserEvent -EventId <String> -UserId <String>
 -BodyParameter <IPathsT4Hh9DUsersUserIdEventsEventIdMicrosoftGraphDeclinePostRequestbodyContentApplicationJsonSchema>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-PassThru] [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DeclineViaIdentityExpanded

Invoke-MgBetaDeclineUserEvent -InputObject <IUsersActionsIdentity> [-ResponseHeadersVariable <String>]
 [-AdditionalProperties <Hashtable>] [-Comment <String>] [-ProposedNewTime <IMicrosoftGraphTimeSlot>]
 [-SendResponse] [-Headers <IDictionary>] [-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DeclineViaIdentity

Invoke-MgBetaDeclineUserEvent -InputObject <IUsersActionsIdentity>
 -BodyParameter <IPathsT4Hh9DUsersUserIdEventsEventIdMicrosoftGraphDeclinePostRequestbodyContentApplicationJsonSchema>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-PassThru] [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

Permissions [!INCLUDE permissions-table]

EXAMPLES

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Users.Actions

$params = @{
	comment = "I won't be able to make this week. How about next week?"
	sendResponse = $true
	proposedNewTime = @{
		start = @{
			dateTime = "2019-12-02T18:00:00"
			timeZone = "Pacific Standard Time"
		}
		end = @{
			dateTime = "2019-12-02T19:00:00"
			timeZone = "Pacific Standard Time"
		}
	}
}

# A UPN can also be used as -UserId.
Invoke-MgBetaDeclineUserEvent -UserId $userId -EventId $eventId -BodyParameter $params

This example shows how to use the Invoke-MgBetaDeclineUserEvent Cmdlet.

PARAMETERS

-AdditionalProperties

Additional Parameters

Type: Hashtable
Parameter Sets: DeclineExpanded, DeclineViaIdentityExpanded
Aliases:

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

-BodyParameter

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

Type: IPathsT4Hh9DUsersUserIdEventsEventIdMicrosoftGraphDeclinePostRequestbodyContentApplicationJsonSchema
Parameter Sets: Decline, DeclineViaIdentity
Aliases:

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

-Comment

.

Type: String
Parameter Sets: DeclineExpanded, DeclineViaIdentityExpanded
Aliases:

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

-EventId

The unique identifier of event

Type: String
Parameter Sets: DeclineExpanded, Decline
Aliases:

Required: True
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

-InputObject

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

Type: IUsersActionsIdentity
Parameter Sets: DeclineViaIdentityExpanded, DeclineViaIdentity
Aliases:

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

-PassThru

Returns true when the command succeeds

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ProposedNewTime

timeSlot To construct, see NOTES section for PROPOSEDNEWTIME properties and create a hash table.

Type: IMicrosoftGraphTimeSlot
Parameter Sets: DeclineExpanded, DeclineViaIdentityExpanded
Aliases:

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

-SendResponse

.

Type: SwitchParameter
Parameter Sets: DeclineExpanded, DeclineViaIdentityExpanded
Aliases:

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

-UserId

The unique identifier of user

Type: String
Parameter Sets: DeclineExpanded, Decline
Aliases:

Required: True
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.Beta.PowerShell.Models.IPathsT4Hh9DUsersUserIdEventsEventIdMicrosoftGraphDeclinePostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.Beta.PowerShell.Models.IUsersActionsIdentity

System.Collections.IDictionary

OUTPUTS

System.Boolean

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 <IPathsT4Hh9DUsersUserIdEventsEventIdMicrosoftGraphDeclinePostRequestbodyContentApplicationJsonSchema>: .

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Comment <String>]:
  • [ProposedNewTime <IMicrosoftGraphTimeSlot>]: timeSlot
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [End <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.
    • [Start <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
  • [SendResponse <Boolean?>]:

INPUTOBJECT <IUsersActionsIdentity>: Identity Parameter

  • [AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance
  • [AccessReviewStageId <String>]: The unique identifier of accessReviewStage
  • [AppLogCollectionRequestId <String>]: The unique identifier of appLogCollectionRequest
  • [AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
  • [CalendarId <String>]: The unique identifier of calendar
  • [ChatId <String>]: The unique identifier of chat
  • [ChatMessageId <String>]: The unique identifier of chatMessage
  • [ChatMessageId1 <String>]: The unique identifier of chatMessage
  • [CloudPcId <String>]: The unique identifier of cloudPC
  • [ContentTypeId <String>]: The unique identifier of contentType
  • [DeviceEnrollmentConfigurationId <String>]: The unique identifier of deviceEnrollmentConfiguration
  • [DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
  • [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
  • [DriveId <String>]: The unique identifier of drive
  • [DriveItemId <String>]: The unique identifier of driveItem
  • [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
  • [EventId <String>]: The unique identifier of event
  • [EventId1 <String>]: The unique identifier of event
  • [JoinWebUrl <String>]: Alternate key of onlineMeeting
  • [ListItemId <String>]: The unique identifier of listItem
  • [ListItemVersionId <String>]: The unique identifier of listItemVersion
  • [MailFolderId <String>]: The unique identifier of mailFolder
  • [MailFolderId1 <String>]: The unique identifier of mailFolder
  • [ManagedDeviceId <String>]: The unique identifier of managedDevice
  • [MessageId <String>]: The unique identifier of message
  • [MobileAppTroubleshootingEventId <String>]: The unique identifier of mobileAppTroubleshootingEvent
  • [NotebookId <String>]: The unique identifier of notebook
  • [OnenotePageId <String>]: The unique identifier of onenotePage
  • [OnenoteSectionId <String>]: The unique identifier of onenoteSection
  • [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
  • [OutlookTaskFolderId <String>]: The unique identifier of outlookTaskFolder
  • [OutlookTaskGroupId <String>]: The unique identifier of outlookTaskGroup
  • [OutlookTaskId <String>]: The unique identifier of outlookTask
  • [PermissionId <String>]: The unique identifier of permission
  • [PlannerPlanId <String>]: The unique identifier of plannerPlan
  • [SensitivityLabelId <String>]: The unique identifier of sensitivityLabel
  • [SubscriptionId <String>]: The unique identifier of subscription
  • [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
  • [TodoTaskId <String>]: The unique identifier of todoTask
  • [TodoTaskListId <String>]: The unique identifier of todoTaskList
  • [UserId <String>]: The unique identifier of user

PROPOSEDNEWTIME <IMicrosoftGraphTimeSlot>: timeSlot

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [End <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.
  • [Start <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.beta.users.actions/invoke-mgbetadeclineuserevent

https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-beta