New-MgBookingBusinessAppointment
Create a new bookingAppointment for the specified bookingBusiness.
Note
To view the beta release of this cmdlet, view New-MgBetaBookingBusinessAppointment
Syntax
New-MgBookingBusinessAppointment
-BookingBusinessId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalInformation <String>]
[-AdditionalProperties <Hashtable>]
[-AnonymousJoinWebUrl <String>]
[-CustomerTimeZone <String>]
[-Customers <IMicrosoftGraphBookingCustomerInformationBase[]>]
[-EndDateTime <IMicrosoftGraphDateTimeZone>]
[-Id <String>]
[-IsLocationOnline]
[-JoinWebUrl <String>]
[-MaximumAttendeesCount <Int32>]
[-OptOutOfCustomerEmail]
[-PostBuffer <TimeSpan>]
[-PreBuffer <TimeSpan>]
[-Price <Double>]
[-PriceType <BookingPriceType>]
[-Reminders <IMicrosoftGraphBookingReminder[]>]
[-SelfServiceAppointmentId <String>]
[-ServiceId <String>]
[-ServiceLocation <IMicrosoftGraphLocation>]
[-ServiceName <String>]
[-ServiceNotes <String>]
[-SmsNotificationsEnabled]
[-StaffMemberIds <String[]>]
[-StartDateTime <IMicrosoftGraphDateTimeZone>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgBookingBusinessAppointment
-BookingBusinessId <String>
-BodyParameter <IMicrosoftGraphBookingAppointment>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgBookingBusinessAppointment
-InputObject <IBookingsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalInformation <String>]
[-AdditionalProperties <Hashtable>]
[-AnonymousJoinWebUrl <String>]
[-CustomerTimeZone <String>]
[-Customers <IMicrosoftGraphBookingCustomerInformationBase[]>]
[-EndDateTime <IMicrosoftGraphDateTimeZone>]
[-Id <String>]
[-IsLocationOnline]
[-JoinWebUrl <String>]
[-MaximumAttendeesCount <Int32>]
[-OptOutOfCustomerEmail]
[-PostBuffer <TimeSpan>]
[-PreBuffer <TimeSpan>]
[-Price <Double>]
[-PriceType <BookingPriceType>]
[-Reminders <IMicrosoftGraphBookingReminder[]>]
[-SelfServiceAppointmentId <String>]
[-ServiceId <String>]
[-ServiceLocation <IMicrosoftGraphLocation>]
[-ServiceName <String>]
[-ServiceNotes <String>]
[-SmsNotificationsEnabled]
[-StaffMemberIds <String[]>]
[-StartDateTime <IMicrosoftGraphDateTimeZone>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgBookingBusinessAppointment
-InputObject <IBookingsIdentity>
-BodyParameter <IMicrosoftGraphBookingAppointment>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create a new bookingAppointment for the specified bookingBusiness.
Parameters
-AdditionalInformation
Additional information that is sent to the customer when an appointment is confirmed.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AnonymousJoinWebUrl
The URL of the meeting to join anonymously.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
Represents a booked appointment of a service by a customer in a business. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphBookingAppointment |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BookingBusinessId
The unique identifier of bookingBusiness
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-Customers
A collection of customer properties for an appointment. An appointment contains a list of customer information and each unit will indicate the properties of a customer who is part of that appointment. Optional.
| Type: | IMicrosoftGraphBookingCustomerInformationBase[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomerTimeZone
The time zone of the customer. For a list of possible values, see dateTimeTimeZone.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndDateTime
dateTimeTimeZone To construct, see NOTES section for ENDDATETIME properties and create a hash table.
| Type: | IMicrosoftGraphDateTimeZone |
| 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: | IBookingsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsLocationOnline
If true, indicates that the appointment will be held online. Default value is false.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JoinWebUrl
The URL of the online meeting for the appointment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumAttendeesCount
The maximum number of customers allowed in an appointment. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OptOutOfCustomerEmail
If true indicates that the bookingCustomer for this appointment doesn't wish to receive a confirmation for this appointment.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PostBuffer
The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in ISO8601 format.
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreBuffer
The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in ISO8601 format.
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Price
The regular price for an appointment for the specified bookingService.
| Type: | Double |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PriceType
Represents the type of pricing of a booking service.
| Type: | BookingPriceType |
| 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 |
-Reminders
The collection of customer reminders sent for this appointment. The value of this property is available only when reading this bookingAppointment by its ID. To construct, see NOTES section for REMINDERS properties and create a hash table.
| Type: | IMicrosoftGraphBookingReminder[] |
| 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 |
-SelfServiceAppointmentId
An additional tracking ID for the appointment, if the appointment has been created directly by the customer on the scheduling page, as opposed to by a staff member on the behalf of the customer. Only supported for appointment if maxAttendeeCount is 1.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceId
The ID of the bookingService associated with this appointment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceLocation
location To construct, see NOTES section for SERVICELOCATION properties and create a hash table.
| Type: | IMicrosoftGraphLocation |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceName
The name of the bookingService associated with this appointment.This property is optional when creating a new appointment. If not specified, it's computed from the service associated with the appointment by the serviceId property.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceNotes
Notes from a bookingStaffMember. The value of this property is available only when reading this bookingAppointment by its ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SmsNotificationsEnabled
If true, indicates SMS notifications will be sent to the customers for the appointment. Default value is false.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StaffMemberIds
The ID of each bookingStaffMember who is scheduled in this appointment.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartDateTime
dateTimeTimeZone To construct, see NOTES section for STARTDATETIME properties and create a hash table.
| Type: | IMicrosoftGraphDateTimeZone |
| 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.IBookingsIdentity
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphBookingAppointment
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphBookingAppointment
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 <IMicrosoftGraphBookingAppointment>: Represents a booked appointment of a service by a customer in a business.
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[AdditionalInformation <String>]: Additional information that is sent to the customer when an appointment is confirmed.[AnonymousJoinWebUrl <String>]: The URL of the meeting to join anonymously.[CustomerTimeZone <String>]: The time zone of the customer. For a list of possible values, see dateTimeTimeZone.[Customers <IMicrosoftGraphBookingCustomerInformationBase-[]>]: A collection of customer properties for an appointment. An appointment contains a list of customer information and each unit will indicate the properties of a customer who is part of that appointment. Optional.[EndDateTime <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, 2017-08-29T04:00:00.0000000).[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
[IsLocationOnline <Boolean?>]: If true, indicates that the appointment will be held online. Default value is false.[JoinWebUrl <String>]: The URL of the online meeting for the appointment.[MaximumAttendeesCount <Int32?>]: The maximum number of customers allowed in an appointment. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.[OptOutOfCustomerEmail <Boolean?>]: If true indicates that the bookingCustomer for this appointment doesn't wish to receive a confirmation for this appointment.[PostBuffer <TimeSpan?>]: The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in ISO8601 format.[PreBuffer <TimeSpan?>]: The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in ISO8601 format.[Price <Double?>]: The regular price for an appointment for the specified bookingService.[PriceType <BookingPriceType?>]: Represents the type of pricing of a booking service.[Reminders <IMicrosoftGraphBookingReminder-[]>]: The collection of customer reminders sent for this appointment. The value of this property is available only when reading this bookingAppointment by its ID.[Message <String>]: The message in the reminder.[Offset <TimeSpan?>]: The amount of time before the start of an appointment that the reminder should be sent. It's denoted in ISO 8601 format.[Recipients <String>]: bookingReminderRecipients
[SelfServiceAppointmentId <String>]: An additional tracking ID for the appointment, if the appointment has been created directly by the customer on the scheduling page, as opposed to by a staff member on the behalf of the customer. Only supported for appointment if maxAttendeeCount is 1.[ServiceId <String>]: The ID of the bookingService associated with this appointment.[ServiceLocation <IMicrosoftGraphLocation>]: location[(Any) <Object>]: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]: physicalAddress[(Any) <Object>]: This indicates any property can be added to this object.[City <String>]: The city.[CountryOrRegion <String>]: The country or region. It's a free-format string value, for example, 'United States'.[PostalCode <String>]: The postal code.[State <String>]: The state.[Street <String>]: The street.
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]: outlookGeoCoordinates[(Any) <Object>]: This indicates any property can be added to this object.[Accuracy <Double?>]: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]: The altitude of the location.[AltitudeAccuracy <Double?>]: The accuracy of the altitude.[Latitude <Double?>]: The latitude of the location.[Longitude <Double?>]: The longitude of the location.
[DisplayName <String>]: The name associated with the location.[LocationEmailAddress <String>]: Optional email address of the location.[LocationType <String>]: locationType[LocationUri <String>]: Optional URI representing the location.[UniqueId <String>]: For internal use only.[UniqueIdType <String>]: locationUniqueIdType
[ServiceName <String>]: The name of the bookingService associated with this appointment.This property is optional when creating a new appointment. If not specified, it's computed from the service associated with the appointment by the serviceId property.[ServiceNotes <String>]: Notes from a bookingStaffMember. The value of this property is available only when reading this bookingAppointment by its ID.[SmsNotificationsEnabled <Boolean?>]: If true, indicates SMS notifications will be sent to the customers for the appointment. Default value is false.[StaffMemberIds <String-[]>]: The ID of each bookingStaffMember who is scheduled in this appointment.[StartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
ENDDATETIME <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, 2017-08-29T04:00:00.0000000).[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
INPUTOBJECT <IBookingsIdentity>: Identity Parameter
[AttendanceRecordId <String>]: The unique identifier of attendanceRecord[BookingAppointmentId <String>]: The unique identifier of bookingAppointment[BookingBusinessId <String>]: The unique identifier of bookingBusiness[BookingCurrencyId <String>]: The unique identifier of bookingCurrency[BookingCustomQuestionId <String>]: The unique identifier of bookingCustomQuestion[BookingCustomerBaseId <String>]: The unique identifier of bookingCustomerBase[BookingServiceId <String>]: The unique identifier of bookingService[BookingStaffMemberBaseId <String>]: The unique identifier of bookingStaffMemberBase[MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport[Role <String>]: Usage: role='{role}'[UserId <String>]: Usage: userId='{userId}'[VirtualEventId <String>]: The unique identifier of virtualEvent[VirtualEventRegistrationId <String>]: The unique identifier of virtualEventRegistration[VirtualEventSessionId <String>]: The unique identifier of virtualEventSession[VirtualEventWebinarId <String>]: The unique identifier of virtualEventWebinar
REMINDERS <IMicrosoftGraphBookingReminder- []>: The collection of customer reminders sent for this appointment.
The value of this property is available only when reading this bookingAppointment by its ID.
[Message <String>]: The message in the reminder.[Offset <TimeSpan?>]: The amount of time before the start of an appointment that the reminder should be sent. It's denoted in ISO 8601 format.[Recipients <String>]: bookingReminderRecipients
SERVICELOCATION <IMicrosoftGraphLocation>: location
[(Any) <Object>]: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]: physicalAddress[(Any) <Object>]: This indicates any property can be added to this object.[City <String>]: The city.[CountryOrRegion <String>]: The country or region. It's a free-format string value, for example, 'United States'.[PostalCode <String>]: The postal code.[State <String>]: The state.[Street <String>]: The street.
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]: outlookGeoCoordinates[(Any) <Object>]: This indicates any property can be added to this object.[Accuracy <Double?>]: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]: The altitude of the location.[AltitudeAccuracy <Double?>]: The accuracy of the altitude.[Latitude <Double?>]: The latitude of the location.[Longitude <Double?>]: The longitude of the location.
[DisplayName <String>]: The name associated with the location.[LocationEmailAddress <String>]: Optional email address of the location.[LocationType <String>]: locationType[LocationUri <String>]: Optional URI representing the location.[UniqueId <String>]: For internal use only.[UniqueIdType <String>]: locationUniqueIdType
STARTDATETIME <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, 2017-08-29T04:00:00.0000000).[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
RELATED LINKS
https://learn.microsoft.com/graph/api/bookingbusiness-post-appointments?view=graph-rest-1.0