Espaço de nomes: microsoft.graph.externalConnectors
Crie um novo objeto externalConnection.
Esta API está disponível nas seguintes implementações de cloud nacionais.
| Serviço global |
US Government L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
| Tipo de permissão |
Permissões com menos privilégios |
Permissões com privilégios superiores |
| Delegado (conta corporativa ou de estudante) |
ExternalConnection.ReadWrite.OwnedBy |
ExternalConnection.ReadWrite.All |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
ExternalConnection.ReadWrite.OwnedBy |
ExternalConnection.ReadWrite.All |
Solicitação HTTP
POST /external/connections
| Nome |
Descrição |
| Autorização |
{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type |
application/json. Obrigatório. |
Corpo da solicitação
No corpo do pedido, forneça uma representação JSON do objeto externalConnection .
Pode especificar as seguintes propriedades ao criar uma ExternalConnection.
| Propriedade |
Tipo |
Descrição |
| id |
Cadeia de caracteres |
O ID da ligação. Obrigatório. |
| nome |
Cadeia de caracteres |
O nome da ligação. Obrigatório. |
| description |
Cadeia de caracteres |
A descrição da ligação. Obrigatório. |
| configuração |
microsoft.graph.externalConnectors.configuration |
As configurações de ligação. Opcional. |
Resposta
Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto externalConnection no corpo da resposta.
Nota: Quando cria uma ligação externa com uma card adaptável quebrada para o esquema de resultados, a primeira chamada falhará com um 503 Service Unavailable. Quando tentar a chamada novamente, a segunda chamada falhará com uma 409 Conflict resposta que indica que já existe uma ligação com o mesmo nome. Isto acontece porque a ligação foi criada, apesar de a primeira chamada ter falhado com 503 Service Unavailable. Para obter mais detalhes, veja Problemas conhecidos.
Exemplos
Solicitação
POST https://graph.microsoft.com/v1.0/external/connections
Content-Type: application/json
{
"id": "contosohr",
"name": "Contoso HR",
"description": "Connection to index Contoso HR system"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models.ExternalConnectors;
var requestBody = new ExternalConnection
{
Id = "contosohr",
Name = "Contoso HR",
Description = "Connection to index Contoso HR system",
};
// 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.PostAsync(requestBody);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// 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()
id := "contosohr"
requestBody.SetId(&id)
name := "Contoso HR"
requestBody.SetName(&name)
description := "Connection to index Contoso HR system"
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().Post(context.Background(), requestBody, nil)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// 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.setId("contosohr");
externalConnection.setName("Contoso HR");
externalConnection.setDescription("Connection to index Contoso HR system");
com.microsoft.graph.models.externalconnectors.ExternalConnection result = graphClient.external().connections().post(externalConnection);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
const options = {
authProvider,
};
const client = Client.init(options);
const externalConnection = {
id: 'contosohr',
name: 'Contoso HR',
description: 'Connection to index Contoso HR system'
};
await client.api('/external/connections')
.post(externalConnection);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ExternalConnectors\ExternalConnection;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ExternalConnection();
$requestBody->setId('contosohr');
$requestBody->setName('Contoso HR');
$requestBody->setDescription('Connection to index Contoso HR system');
$result = $graphServiceClient->external()->connections()->post($requestBody)->wait();
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
# 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(
id = "contosohr",
name = "Contoso HR",
description = "Connection to index Contoso HR system",
)
result = await graph_client.external.connections.post(request_body)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Resposta
O exemplo a seguir mostra a resposta. Tenha em atenção que as propriedades do ID, do nome e da descrição no payload de resposta são geradas pelo sistema e são diferentes das que estão na ligação que foi criada.
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "0a4f4e74-4e74-0a4f-744e-4f0a744e4f0a",
"name": "String",
"description": "String",
"state": "ready",
"configuration": {
"authorizedAppIds": [
"d310d35d-72ec-47dd-92f2-fb9c40936555"
]
}
}