externalConnection resource type

Namespace: microsoft.graph.externalConnectors

A logical container to add content from an external source into Microsoft Graph.

Methods

Method	Return type	Description
Create externalConnection	externalConnection	Create a new externalConnection object.
List externalConnections	externalConnection collection	Get a list of the externalConnection objects and their properties.
Get externalConnection	externalConnection	Read the properties and relationships of an externalConnection object.
Update externalConnection	externalConnection	Update the properties of an externalConnection object.
Delete externalConnection	None	Deletes an externalConnection object.
Create schema	schema	Create a new schema object.
Create externalItem	externalItem	Create a new externalItem object.

Properties

Property	Type	Description
activitySettings	microsoft.graph.externalConnectors.activitySettings	Collects configurable settings related to activities involving connector content.
configuration	microsoft.graph.externalConnectors.configuration	Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. Optional.
connectorId	String	The Teams app ID. Optional.
description	String	Description of the connection displayed in the Microsoft 365 admin center. Optional.
id	String	Developer-provided unique ID of the connection within the Microsoft Entra tenant. Must be between 3 and 32 characters in length. Must only contain alphanumeric characters. Cannot begin with Microsoft or be one of the following values: None, Directory, Exchange, ExchangeArchive, LinkedIn, Mailbox, OneDriveBusiness, SharePoint, Teams, Yammer, Connectors, TaskFabric, PowerBI, Assistant, TopicEngine, MSFT_All_Connectors. Required.
name	String	The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required.
searchSettings	microsoft.graph.externalConnectors.searchSettings	The settings configuring the search experience for content in this connection, such as the display templates for search results.
state	microsoft.graph.externalConnectors.connectionState	Indicates the current state of the connection. Possible values are: draft, ready, obsolete, limitExceeded, unknownFutureValue.

Relationships

Relationship	Type	Description
items	microsoft.graph.externalConnectors.externalItem collection	Read-only. Nullable.
operations	microsoft.graph.externalConnectors.connectionOperation collection	Read-only. Nullable.
schema	microsoft.graph.externalConnectors.schema	Read-only. Nullable.

JSON representation

The following is a JSON representation of the resource.

{
  "activitySettings": {
    "@odata.type": "microsoft.graph.externalConnectors.activitySettings"
  },
  "configuration": {
    "@odata.type": "microsoft.graph.externalConnectors.configuration"
  },
  "connectorId": "String",
  "description": "String",
  "id": "String (identifier)",
  "name": "String",
  "searchSettings": {
    "@odata.type": "microsoft.graph.externalConnectors.searchSettings"
  },
  "state": "String"
}