Namespace: microsoft.graph.externalConnectors
Update the properties of an externalConnection object.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type |
Least privileged permissions |
Higher privileged permissions |
Delegated (work or school account) |
ExternalConnection.ReadWrite.OwnedBy |
ExternalConnection.ReadWrite.All |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
ExternalConnection.ReadWrite.OwnedBy |
ExternalConnection.ReadWrite.All |
HTTP request
PATCH /external/connections/{connectionsId}
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. The following properties can be updated.
Property |
Type |
Description |
configuration |
microsoft.graph.externalConnectors.configuration |
Specifies additional application IDs that are allowed to manage the connection and to index content in the connection. |
description |
String |
Description of the connection displayed in the Microsoft 365 admin center. |
name |
String |
The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. |
Response
If successful, this method returns a 204 No Content
response code.
Examples
Request
PATCH https://graph.microsoft.com/v1.0/external/connections/contosohr
Content-type: application/json
{
"name": "Contoso HR Service Tickets",
"description": "Connection to index HR service tickets"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models.ExternalConnectors;
var requestBody = new ExternalConnection
{
Name = "Contoso HR Service Tickets",
Description = "Connection to index HR service tickets",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.External.Connections["{externalConnection-id}"].PatchAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc external connections patch --external-connection-id {externalConnection-id} --body '{\
"name": "Contoso HR Service Tickets",\
"description": "Connection to index HR service tickets"\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodelsexternalconnectors "github.com/microsoftgraph/msgraph-sdk-go/models/externalconnectors"
//other-imports
)
requestBody := graphmodelsexternalconnectors.NewExternalConnection()
name := "Contoso HR Service Tickets"
requestBody.SetName(&name)
description := "Connection to index HR service tickets"
requestBody.SetDescription(&description)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
connections, err := graphClient.External().Connections().ByExternalConnectionId("externalConnection-id").Patch(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.externalconnectors.ExternalConnection externalConnection = new com.microsoft.graph.models.externalconnectors.ExternalConnection();
externalConnection.setName("Contoso HR Service Tickets");
externalConnection.setDescription("Connection to index HR service tickets");
com.microsoft.graph.models.externalconnectors.ExternalConnection result = graphClient.external().connections().byExternalConnectionId("{externalConnection-id}").patch(externalConnection);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const externalConnection = {
name: 'Contoso HR Service Tickets',
description: 'Connection to index HR service tickets'
};
await client.api('/external/connections/contosohr')
.update(externalConnection);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ExternalConnectors\ExternalConnection;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ExternalConnection();
$requestBody->setName('Contoso HR Service Tickets');
$requestBody->setDescription('Connection to index HR service tickets');
$result = $graphServiceClient->external()->connections()->byExternalConnectionId('externalConnection-id')->patch($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Search
$params = @{
name = "Contoso HR Service Tickets"
description = "Connection to index HR service tickets"
}
Update-MgExternalConnection -ExternalConnectionId $externalConnectionId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.external_connectors.external_connection import ExternalConnection
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ExternalConnection(
name = "Contoso HR Service Tickets",
description = "Connection to index HR service tickets",
)
result = await graph_client.external.connections.by_external_connection_id('externalConnection-id').patch(request_body)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Response
The following example shows the response.
HTTP/1.1 204 No Content