Compartilhar via


Criar externalConnection

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

Cabeçalhos de solicitação

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"
}

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"
    ]
  }
}