Dataverse csatlakoztatása és leválasztása Git-adattárból kód használatával

A ConnectToGit és DisconnectFromGit API-k segítségével programozottan integrálhatja a Microsoft Dataverse környezetet a Git forrásvezérlővel. Ezen API-k használatával egyes megoldásokat vagy teljes környezeteket csatlakoztathat az Azure DevOpsban üzemeltetett Git-adattárakhoz, és kóddal kezelheti ezeket a kapcsolatokat.

Important

Jelenleg az Azure DevOps az egyetlen támogatott Git-szolgáltató.

Prerequisites

Az API-k használata előtt győződjön meg arról, hogy a következőkre van szüksége:

  • Hozzáférés Microsoft Dataverse-környezethez
  • Rendszergazdai engedélyek
  • Git-adattárhoz való olvasási és írási hozzáférés

ConnectToGit API

Kapcsolatot hoz létre egy Dataverse-megoldás vagy -környezet és egy Git-adattár között. Ezzel a kapcsolattal kezelheti a Dataverse-összetevők forrásvezérlését.

Parameters

Az ConnectToGit API a következő paramétereket fogadja el:

Paraméter Típus Szükséges Description
GitFolder String Igen Annak a mappának a neve, amelyhez a megoldást vagy a környezetet hozzá szeretné kötni.
Branch String Igen Annak az ágnak a neve, amelyhez csatlakozni szeretne.
ConnectionType Integer No Meghatározza, hogy mihez kell csatlakozni. Lásd ConnectionType paraméter.
GitProvider Integer No A Git-szolgáltató. Lásd: GitProvider paraméter.
Organization String No Annak a szervezetnek a neve, amelyhez csatlakozni szeretne.
Project String No Annak a projektnek a neve, amelyhez csatlakozni szeretne.
Repository String No Annak az adattárnak a neve, amelyhez csatlakozni szeretne.
RootFolder String No Annak a gyökérmappának a neve, amelyben az összes megoldás a megoldás hatókörében található.
SolutionUniqueName String No A githez csatlakozni kívánt megoldás egyedi neve.
UpstreamBranch String No Annak a felső ágnak a neve, amelyhez csatlakozni szeretne. Alapértelmezésben az adattár alapértelmezett elágazása.

ConnectionType paraméter

A ConnectionType paraméter azt szabályozza, hogy a teljes Dataverse-környezethez vagy egy adott megoldáshoz csatlakozik-e.

Érték Címke Description
0 Megoldás Egy adott Dataverse-megoldást csatlakoztat a Githez.
1 Környezet A teljes Dataverse-környezetet összekapcsolja a Gittel.

GitProvider paraméter

A paraméterrel GitProvider megadhatja a használt Git-szolgáltató típusát, akár az Azure DevOps, akár a GitHub.

Érték Címke Description
0 Azure DevOps Az Azure DevOpsban üzemeltetett adattárakhoz használható
1 GitHub GitHubon üzemeltetett adattárakhoz használható

DisconnectFromGit API

Eltávolítja a Git-kapcsolatot egy Dataverse-megoldásból vagy -környezetből, és letiltja a forrásvezérlés integrációját.

Paraméter

Az DisconnectFromGit API-nak csak egy paramétere van.

Paraméter Típus Szükséges Description
SolutionUniqueName String No A Gittől leválasztani kívánt megoldás egyedi neve. Ne végezze el az összes megoldás vagy környezet leválasztását.

További információk

Íme néhány paraméterérték-beállítás, amelyeket meg kell adni a meghíváskor DisconnectFromGit.

  • Egyetlen megoldás leválasztása: Adja meg a(z) SolutionUniqueName elemet egy adott megoldás leválasztásához.
  • Az összes megoldás leválasztása: Ne adjon meg paramétereket az összes megoldásszintű kapcsolat leválasztásához.
  • Környezet leválasztása: Ne adjon meg paramétereket a környezeti szintű kapcsolat leválasztásához.

Példák

Az alábbi példák a használati ConnectToGit forgatókönyveket és DisconnectFromGit API-kat írják le:

A teljes Dataverse-környezet csatlakoztatása egy Azure DevOps-adattárhoz

Ez a kapcsolat lehetővé teszi a forrásvezérlést az összes környezeti szintű konfigurációhoz és összetevőhöz.

Ne használja ezeket a paramétereket ezzel a kapcsolattal:

  • RootFolder
  • SolutionUniqueName
  • UpstreamBranch

Ez a példa bemutatja, hogyan csatlakoztathatja a teljes Dataverse-környezetet egy Azure DevOps-adattárhoz a ConnectToGit művelettel .

kérelem

POST [Organization URI]/api/data/v9.2/ConnectToGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "GitFolder": "yourGitfolderName",
   "Branch": "yourBranchName",
   "ConnectionType": 1,
   "GitProvider": 0,
   "Organization": "yourOrganizationName",
   "Project": "yourProjectName",
   "Repository": "yourRepositoryName"
}

Válasz

HTTP/1.1 204 No Content
OData-Version: 4.0

A webes API-műveletek meghívásának ismertetése

Válassza le a teljes Dataverse-környezetet a Git forrásvezérlésről

Ez a művelet eltávolítja a környezetszintű Git-kapcsolatot. Ehhez a művelethez ne használja a SolutionUniqueName paramétert. A Dataverse automatikusan azonosítja és eltávolítja a környezetszintű Git-kapcsolatot.

Ez a példa bemutatja, hogyan lehet a DisconnectFromGit művelettel leválasztani a teljes Dataverse-környezetet a Git-forrásvezérlőről.

kérelem

POST [Organization URI]/api/data/v9.2/DisconnectFromGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

Válasz

HTTP/1.1 204 No Content
OData-Version: 4.0

A webes API-műveletek meghívásának ismertetése

Az első megoldás csatlakoztatása Egy Git-adattárhoz

Ez a kapcsolat létrehozza az adattárhivatkozást és a mappastruktúrát a megoldásszintű forrásvezérléshez a környezet első megoldásához.

A megoldás megadásához meg kell adnia az alábbi paraméterek értékeit:

  • RootFolder
  • SolutionUniqueName

Ez a példa bemutatja, hogyan csatlakoztathatja az első megoldást egy Git-adattárhoz a ConnectToGit művelettel .

kérelem

POST [Organization URI]/api/data/v9.2/ConnectToGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "GitFolder": "yourGitfolderName",
   "Branch": "yourBranchName",
   "ConnectionType": 1,
   "GitProvider": 0,
   "Organization": "yourOrganizationName",
   "Project": "yourProjectName",
   "Repository": "yourRepositoryName",
   "RootFolder": "yourRootFolderName",
   "SolutionUniqueName": "yourSolutionUniqueName"
}

Válasz

HTTP/1.1 204 No Content
OData-Version: 4.0

A webes API-műveletek meghívásának ismertetése

További megoldások csatlakoztatása ugyanahhoz a Git-adattárhoz a kezdeti megoldás csatlakoztatása után

Az első megoldás csatlakoztatása után csak a megoldásspecifikus paraméterekre lesz szüksége. Az adattár kapcsolati adatait a kezdeti kapcsolattól örökli.

Csak ezeket a paramétereket állítsa be:

  • SolutionUniqueName
  • Branch
  • GitFolder

Important

Először csatlakoztatnia kell az első megoldást, mielőtt ez működik. Lásd : Az első megoldás csatlakoztatása egy Git-adattárhoz.

Ez a példa bemutatja, hogyan csatlakoztathat további megoldásokat egy Git-adattárhoz a ConnectToGit művelettel .

kérelem

POST [Organization URI]/api/data/v9.2/ConnectToGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "GitFolder": "yourGitfolderName",
   "Branch": "yourBranchName",
   "SolutionUniqueName": "yourSolutionUniqueName"
}

Válasz

HTTP/1.1 204 No Content
OData-Version: 4.0

A webes API-műveletek meghívásának ismertetése

Egy adott megoldás leválasztása a Git-forrásvezérlőről más megoldások csatlakoztatása mellett

Ezzel a módszerrel eltávolíthatja az egyik megoldás forrásvezérlését anélkül, hogy másokat érintenének.

Ez a példa bemutatja, hogyan távolíthatja el az egyik megoldás forrásvezérlőjét a DisconnectFromGit művelet használatával anélkül, hogy másokat érintenének.

kérelem

POST [Organization URI]/api/data/v9.2/DisconnectFromGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "SolutionUniqueName": "yourSolutionUniqueName"
}

Válasz

HTTP/1.1 204 No Content
OData-Version: 4.0

A webes API-műveletek meghívásának ismertetése

Hibakezelés

Sem a ConnectToGit, sem a DisconnectFromGit API nem ad vissza értéket, amikor sikeresen befejeződik. Ha egy API meghibásodik, hibát ad vissza.

A gyakori hibaesetek a következők:

  • Érvénytelen hitelesítő adatok: Győződjön meg arról, hogy érvényes hitelesítést használ a Git-szolgáltatóhoz.
  • Az adattár nem található: Ellenőrizze a szervezet, a projekt és az adattár nevét.
  • Engedély megtagadva: Győződjön meg arról, hogy Dataverse-fiókja rendelkezik forrásvezérlési felügyeleti engedélyekkel.
  • A megoldás nem található: Ellenőrizze, hogy létezik-e a SolutionUniqueName környezetben.
  • Az ág nem létezik: Ellenőrizze, hogy a megadott ág létezik-e az adattárban.

Támogatás és további erőforrások

A Dataversevel való forráskövetési integrációval kapcsolatos további információkért lásd: