New-MgCommunicationCallParticipant

Module:

Microsoft.Graph.CloudCommunications Module

Create new navigation property to participants for communications

Note

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

Syntax

CreateExpanded (Default)

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 <long>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgCommunicationCallParticipant
    -CallId <string>
    -BodyParameter <IMicrosoftGraphParticipant>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded

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 <long>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentity

New-MgCommunicationCallParticipant
    -InputObject <ICloudCommunicationsIdentity>
    -BodyParameter <IMicrosoftGraphParticipant>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:	System.Collections.Hashtable
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-BodyParameter

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipant
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentity

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

Create

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

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-CallId

The unique identifier of call

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

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

Create

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
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

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	System.Collections.IDictionary
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

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-Info

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipantInfo
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
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:	Microsoft.Graph.PowerShell.Models.ICloudCommunicationsIdentity
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateViaIdentity

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

-IsInLobby

true if the participant is in lobby.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-IsMuted

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

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-MediaStreams

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMediaStream[]
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-Metadata

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

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-RecordingInfo

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphRecordingInfo
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-RemovedState

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphRemovedState
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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:	System.String
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

-RestrictedExperience

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphOnlineMeetingRestricted
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-RosterSequenceNumber

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

Parameter properties

Type:	System.Int64
Default value:	0
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

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

CreateExpanded

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

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
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

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.PowerShell.Models.ICloudCommunicationsIdentity

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipant

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipant

{{ Fill in the Description }}

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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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 [AdhocCallId <String>]: The unique identifier of adhocCall [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 [EngagementConversationMessageId <String>]: The unique identifier of engagementConversationMessage [EngagementConversationMessageId1 <String>]: The unique identifier of engagementConversationMessage [EngagementConversationMessageReactionId <String>]: The unique identifier of engagementConversationMessageReaction [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport [OnlineMeetingEngagementConversationId <String>]: The unique identifier of onlineMeetingEngagementConversation [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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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

Related Links

• New-MgCommunicationCallParticipant