Set-MgExternalConnectionItem

Module:

Microsoft.Graph.Search

Update the properties of an externalItem object.

Note

To view the beta release of this cmdlet, view Set-MgBetaExternalConnectionItem

Syntax

Set-MgExternalConnectionItem
   -ExternalConnectionId <String>
   -ExternalItemId <String>
   [-ResponseHeadersVariable <String>]
   [-Acl <IMicrosoftGraphExternalConnectorsAcl[]>]
   [-Activities <IMicrosoftGraphExternalConnectorsExternalActivity[]>]
   [-AdditionalProperties <Hashtable>]
   [-Content <IMicrosoftGraphExternalConnectorsExternalItemContent>]
   [-Id <String>]
   [-Properties <Hashtable>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgExternalConnectionItem
   -ExternalConnectionId <String>
   -ExternalItemId <String>
   -BodyParameter <IMicrosoftGraphExternalConnectorsExternalItem>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgExternalConnectionItem
   -InputObject <ISearchIdentity>
   [-ResponseHeadersVariable <String>]
   [-Acl <IMicrosoftGraphExternalConnectorsAcl[]>]
   [-Activities <IMicrosoftGraphExternalConnectorsExternalActivity[]>]
   [-AdditionalProperties <Hashtable>]
   [-Content <IMicrosoftGraphExternalConnectorsExternalItemContent>]
   [-Id <String>]
   [-Properties <Hashtable>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-MgExternalConnectionItem
   -InputObject <ISearchIdentity>
   -BodyParameter <IMicrosoftGraphExternalConnectorsExternalItem>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Update the properties of an externalItem object.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All,

Examples

Example: Create a custom item

Import-Module Microsoft.Graph.Search

$params = @{
	acl = @(
		@{
			type = "user"
			value = "e811976d-83df-4cbd-8b9b-5215b18aa874"
			accessType = "grant"
		}
		@{
			type = "externalGroup"
			value = "14m1b9c38qe647f6a"
			accessType = "deny"
		}
	)
	properties = @{
		title = "Error in the payment gateway"
		priority = 
		assignee = "john@contoso.com"
	}
	content = @{
		value = "Error in payment gateway..."
		type = "text"
	}
}

Set-MgExternalConnectionItem -ExternalConnectionId $externalConnectionId -ExternalItemId $externalItemId -BodyParameter $params

This example will create a custom item

Parameters

-Acl

An array of access control entries. Each entry specifies the access granted to a user or group. Required. To construct, see NOTES section for ACL properties and create a hash table.

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

-Activities

Returns a list of activities performed on the item. Write-only. To construct, see NOTES section for ACTIVITIES properties and create a hash table.

Type:	IMicrosoftGraphExternalConnectorsExternalActivity[]
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

-BodyParameter

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

Type:	IMicrosoftGraphExternalConnectorsExternalItem
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-Content

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

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

-ExternalConnectionId

The unique identifier of externalConnection

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

-ExternalItemId

The unique identifier of externalItem

Type:	String
Position:	Named
Default value:	None
Required:	True
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:	ISearchIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-Properties

properties

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

-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.IMicrosoftGraphExternalConnectorsExternalItem

Microsoft.Graph.PowerShell.Models.ISearchIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphExternalConnectorsExternalItem

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.

ACL <IMicrosoftGraphExternalConnectorsAcl- []>: An array of access control entries. Each entry specifies the access granted to a user or group. Required.

• [AccessType <String>]: accessType
• [Type <String>]: aclType
• [Value <String>]: The unique identifer of the identity. For Microsoft Entra identities, value is set to the object identifier of the user, group or tenant for types user, group and everyone (and everyoneExceptGuests) respectively. For external groups value is set to the ID of the externalGroup

ACTIVITIES <IMicrosoftGraphExternalConnectorsExternalActivity- []>: Returns a list of activities performed on the item. Write-only.

• [Id <String>]: The unique identifier for an entity. Read-only.
• [PerformedBy <IMicrosoftGraphExternalConnectorsIdentity>]: identity
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Type <String>]: identityType
• [StartDateTime <DateTime?>]: The date and time when the particular activity occurred. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
• [Type <String>]: externalActivityType

BODYPARAMETER <IMicrosoftGraphExternalConnectorsExternalItem>: externalItem

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Id <String>]: The unique identifier for an entity. Read-only.
• [Acl <IMicrosoftGraphExternalConnectorsAcl- []>]: An array of access control entries. Each entry specifies the access granted to a user or group. Required.
  • [AccessType <String>]: accessType
  • [Type <String>]: aclType
  • [Value <String>]: The unique identifer of the identity. For Microsoft Entra identities, value is set to the object identifier of the user, group or tenant for types user, group and everyone (and everyoneExceptGuests) respectively. For external groups value is set to the ID of the externalGroup
• [Activities <IMicrosoftGraphExternalConnectorsExternalActivity- []>]: Returns a list of activities performed on the item. Write-only.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [PerformedBy <IMicrosoftGraphExternalConnectorsIdentity>]: identity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Type <String>]: identityType
  • [StartDateTime <DateTime?>]: The date and time when the particular activity occurred. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
  • [Type <String>]: externalActivityType
• [Content <IMicrosoftGraphExternalConnectorsExternalItemContent>]: externalItemContent
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Type <String>]: externalItemContentType
  • [Value <String>]: The content for the externalItem. Required.
• [Properties <IMicrosoftGraphExternalConnectorsProperties>]: properties
  • [(Any) <Object>]: This indicates any property can be added to this object.

CONTENT <IMicrosoftGraphExternalConnectorsExternalItemContent>: externalItemContent

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Type <String>]: externalItemContentType
• [Value <String>]: The content for the externalItem. Required.

INPUTOBJECT <ISearchIdentity>: Identity Parameter

• [AcronymId <String>]: The unique identifier of acronym
• [BookmarkId <String>]: The unique identifier of bookmark
• [ConnectionOperationId <String>]: The unique identifier of connectionOperation
• [ExternalActivityId <String>]: The unique identifier of externalActivity
• [ExternalConnectionId <String>]: The unique identifier of externalConnection
• [ExternalGroupId <String>]: The unique identifier of externalGroup
• [ExternalItemId <String>]: The unique identifier of externalItem
• [IdentityId <String>]: The unique identifier of identity
• [QnaId <String>]: The unique identifier of qna

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.search/set-mgexternalconnectionitem
• https://learn.microsoft.com/graph/api/externalconnectors-externalitem-update?view=graph-rest-1.0