获取连接
本文内容
命名空间：microsoft.graph.externalConnectors
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
检索 externalConnection 的属性和关系。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
❌
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时 ，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型 。 要了解有关这些权限的详细信息，请参阅 权限参考 。
权限类型
最低特权权限
更高特权权限
委派（工作或学校帐户）
ExternalConnection.ReadWrite.OwnedBy
ExternalConnection.Read.All、ExternalConnection.ReadWrite.All
委派（个人 Microsoft 帐户）
不支持。
不支持。
应用程序
ExternalConnection.ReadWrite.OwnedBy
ExternalConnection.Read.All、ExternalConnection.ReadWrite.All
HTTP 请求
GET /external/connections/{id}
可选的查询参数
此方法支持使用 OData 查询参数 来帮助自定义响应。
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
请求正文
请勿提供此方法的请求正文。
响应
如果成功，此方法在响应正文中返回响应 200 OK 代码和 externalConnection 对象。
示例
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/external/connections/contosohr
// Code snippets are only available for the latest version. Current version is 5.x
// 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}"].GetAsync();
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta external connections get --external-connection-id {externalConnection-id}
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
connections, err := graphClient.External().Connections().ByExternalConnectionId("externalConnection-id").Get(context.Background(), nil)
// 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 result = graphClient.external().connections().byExternalConnectionId("{externalConnection-id}").get();
const options = {
authProvider,
};
const client = Client.init(options);
let externalConnection = await client.api('/external/connections/contosohr')
.version('beta')
.get();
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->external()->connections()->byExternalConnectionId('externalConnection-id')->get()->wait();
Import-Module Microsoft.Graph.Beta.Search
Get-MgBetaExternalConnection -ExternalConnectionId $externalConnectionId
from msgraph import GraphServiceClient
graph_client = GraphServiceClient(credentials, scopes)
result = await graph_client.external.connections.by_external_connection_id('externalConnection-id').get()
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "contosohr",
"ingestedItemsCount": 700000,
"name": "Contoso HR",
"description": "Connection to index Contoso HR system",
"state": "ready",
"configuration": {
"authorizedAppIds": [
"d310d35d-72ec-47dd-92f2-fb9c40936555"
]
}
}