Créer externalConnection

Espace de noms : microsoft.graph.externalConnectors

Créez un objet externalConnection.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All

Requête HTTP

POST /external/connections

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet externalConnection .

Vous pouvez spécifier les propriétés suivantes lors de la création d’une externalConnection.

Propriété Type Description
id Chaîne ID de connexion. Obligatoire.
nom Chaîne Nom de la connexion. Obligatoire.
description Chaîne Description de la connexion. Obligatoire.
configuration microsoft.graph.externalConnectors.configuration Configurations de connexion. Facultatif.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet externalConnection dans le corps de la réponse.

Note: Lorsque vous créez une connexion externe avec un carte adaptatif rompu pour la disposition des résultats, le premier appel échoue avec un 503 Service Unavailable. Lorsque vous réessayez l’appel, le deuxième appel échoue avec une 409 Conflict réponse indiquant qu’une connexion portant le même nom existe déjà. Cela se produit parce que la connexion a été créée même si le premier appel a échoué avec 503 Service Unavailable. Pour plus d’informations, consultez Problèmes connus.

Exemples

Demande

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

Réponse

L’exemple suivant illustre la réponse. Notez que les propriétés id, name et description dans la charge utile de réponse sont générées par le système et sont différentes de celles qui se trouvent dans la connexion qui a été créée.

HTTP/1.1 200 Created
Content-Type: application/json

{
  "id": "0a4f4e74-4e74-0a4f-744e-4f0a744e4f0a",
  "name": "String",
  "description": "String",
  "state": "ready",
  "configuration": {
    "authorizedAppIds": [
      "d310d35d-72ec-47dd-92f2-fb9c40936555"
    ]
  }
}