Share via

Remove-MgExternalConnectionGroup

  • Reference
Module:
Microsoft.Graph.Search

Delete an externalGroup object.

Note

To view the beta release of this cmdlet, view Remove-MgBetaExternalConnectionGroup

Syntax

Remove-MgExternalConnectionGroup
      -ExternalConnectionId <String>
      -ExternalGroupId <String>
      [-IfMatch <String>]
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-MgExternalConnectionGroup
      -InputObject <ISearchIdentity>
      [-IfMatch <String>]
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Delete an externalGroup object.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) ExternalItem.ReadWrite.OwnedBy ExternalItem.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application ExternalItem.ReadWrite.OwnedBy ExternalItem.ReadWrite.All

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Search

Remove-MgExternalConnectionGroup -ExternalConnectionId $externalConnectionId -ExternalGroupId $externalGroupId

This example shows how to use the Remove-MgExternalConnectionGroup Cmdlet.

Parameters

-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

-ExternalConnectionId

The unique identifier of externalConnection

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

-ExternalGroupId

The unique identifier of externalGroup

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

-IfMatch

ETag

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

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:False
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

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

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.

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