New-MgCommunicationCallParticipant

Create new navigation property to participants for communications

Note

To view the beta release of this cmdlet, view New-MgBetaCommunicationCallParticipant

Syntax

New-MgCommunicationCallParticipant
   -CallId <String>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-Id <String>]
   [-Info <IMicrosoftGraphParticipantInfo>]
   [-IsInLobby]
   [-IsMuted]
   [-MediaStreams <IMicrosoftGraphMediaStream[]>]
   [-Metadata <String>]
   [-RecordingInfo <IMicrosoftGraphRecordingInfo>]
   [-RemovedState <IMicrosoftGraphRemovedState>]
   [-RestrictedExperience <IMicrosoftGraphOnlineMeetingRestricted>]
   [-RosterSequenceNumber <Int64>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgCommunicationCallParticipant
   -CallId <String>
   -BodyParameter <IMicrosoftGraphParticipant>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgCommunicationCallParticipant
   -InputObject <ICloudCommunicationsIdentity>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-Id <String>]
   [-Info <IMicrosoftGraphParticipantInfo>]
   [-IsInLobby]
   [-IsMuted]
   [-MediaStreams <IMicrosoftGraphMediaStream[]>]
   [-Metadata <String>]
   [-RecordingInfo <IMicrosoftGraphRecordingInfo>]
   [-RemovedState <IMicrosoftGraphRemovedState>]
   [-RestrictedExperience <IMicrosoftGraphOnlineMeetingRestricted>]
   [-RosterSequenceNumber <Int64>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgCommunicationCallParticipant
   -InputObject <ICloudCommunicationsIdentity>
   -BodyParameter <IMicrosoftGraphParticipant>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create new navigation property to participants for communications

Parameters

-AdditionalProperties

Additional Parameters

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

-BodyParameter

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

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

-CallId

The unique identifier of call

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

-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

-Info

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

Type:IMicrosoftGraphParticipantInfo
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:ICloudCommunicationsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IsInLobby

true if the participant is in lobby.

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

-IsMuted

true if the participant is muted (client or server muted).

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

-MediaStreams

The list of media streams. To construct, see NOTES section for MEDIASTREAMS properties and create a hash table.

Type:IMicrosoftGraphMediaStream[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Metadata

A blob of data provided by the participant in the roster.

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

-RecordingInfo

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

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

-RemovedState

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

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

-RestrictedExperience

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

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

-RosterSequenceNumber

Indicates the roster sequence number in which the participant was last updated.

Type:Int64
Position:Named
Default value:0
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.ICloudCommunicationsIdentity

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipant

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipant

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 <IMicrosoftGraphParticipant>: participant

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Info <IMicrosoftGraphParticipantInfo>]: participantInfo
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [CountryCode <String>]: The ISO 3166-1 Alpha-2 country code of the participant's best estimated physical location at the start of the call. Read-only.
    • [EndpointType <String>]: endpointType
    • [Identity <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
    • [LanguageId <String>]: The language culture string. Read-only.
    • [ParticipantId <String>]: The participant ID of the participant. Read-only.
    • [Region <String>]: The home region of the participant. This can be a country, a continent, or a larger geographic region. This doesn't change based on the participant's current physical location. Read-only.
  • [IsInLobby <Boolean?>]: true if the participant is in lobby.
  • [IsMuted <Boolean?>]: true if the participant is muted (client or server muted).
  • [MediaStreams <IMicrosoftGraphMediaStream- []>]: The list of media streams.
    • [Direction <String>]: mediaDirection
    • [Label <String>]: The media stream label.
    • [MediaType <String>]: modality
    • [ServerMuted <Boolean?>]: If the media is muted by the server.
    • [SourceId <String>]: The source ID.
  • [Metadata <String>]: A blob of data provided by the participant in the roster.
  • [RecordingInfo <IMicrosoftGraphRecordingInfo>]: recordingInfo
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Initiator <IMicrosoftGraphIdentitySet>]: identitySet
    • [RecordingStatus <String>]: recordingStatus
  • [RemovedState <IMicrosoftGraphRemovedState>]: removedState
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Reason <String>]: The removal reason for the participant resource.
  • [RestrictedExperience <IMicrosoftGraphOnlineMeetingRestricted>]: onlineMeetingRestricted
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [ContentSharingDisabled <String>]: onlineMeetingContentSharingDisabledReason
    • [VideoDisabled <String>]: onlineMeetingVideoDisabledReason
  • [RosterSequenceNumber <Int64?>]: Indicates the roster sequence number in which the participant was last updated.

INFO <IMicrosoftGraphParticipantInfo>: participantInfo

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [CountryCode <String>]: The ISO 3166-1 Alpha-2 country code of the participant's best estimated physical location at the start of the call. Read-only.
  • [EndpointType <String>]: endpointType
  • [Identity <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
  • [LanguageId <String>]: The language culture string. Read-only.
  • [ParticipantId <String>]: The participant ID of the participant. Read-only.
  • [Region <String>]: The home region of the participant. This can be a country, a continent, or a larger geographic region. This doesn't change based on the participant's current physical location. Read-only.

INPUTOBJECT <ICloudCommunicationsIdentity>: Identity Parameter

  • [AttendanceRecordId <String>]: The unique identifier of attendanceRecord
  • [AudioRoutingGroupId <String>]: The unique identifier of audioRoutingGroup
  • [CallId <String>]: The unique identifier of call
  • [CallRecordId <String>]: The unique identifier of callRecord
  • [CallRecordingId <String>]: The unique identifier of callRecording
  • [CallTranscriptId <String>]: The unique identifier of callTranscript
  • [CommsOperationId <String>]: The unique identifier of commsOperation
  • [ContentSharingSessionId <String>]: The unique identifier of contentSharingSession
  • [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport
  • [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
  • [ParticipantId <String>]: The unique identifier of participant
  • [PresenceId <String>]: The unique identifier of presence
  • [SessionId <String>]: The unique identifier of session
  • [UserId <String>]: The unique identifier of user

MEDIASTREAMS <IMicrosoftGraphMediaStream- []>: The list of media streams.

  • [Direction <String>]: mediaDirection
  • [Label <String>]: The media stream label.
  • [MediaType <String>]: modality
  • [ServerMuted <Boolean?>]: If the media is muted by the server.
  • [SourceId <String>]: The source ID.

RECORDINGINFO <IMicrosoftGraphRecordingInfo>: recordingInfo

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Initiator <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
  • [RecordingStatus <String>]: recordingStatus

REMOVEDSTATE <IMicrosoftGraphRemovedState>: removedState

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Reason <String>]: The removal reason for the participant resource.

RESTRICTEDEXPERIENCE <IMicrosoftGraphOnlineMeetingRestricted>: onlineMeetingRestricted

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ContentSharingDisabled <String>]: onlineMeetingContentSharingDisabledReason
  • [VideoDisabled <String>]: onlineMeetingVideoDisabledReason