Dataverse savienojuma izveide un atvienošana no Git repozitorija, izmantojot kodu

Izmantojiet ConnectToGit un DisconnectFromGit API, lai programmiski integrētu savu Microsoft Dataverse vidi ar Git avota vadīklu. Izmantojot šos API, varat savienot atsevišķus risinājumus vai veselas vides ar Git krātuvēm, kas viesotas Azure DevOps, un pārvaldīt šos savienojumus, izmantojot kodu.

Svarīgi

Azure DevOps pašlaik ir vienīgais atbalstītais Git nodrošinātājs.

Priekšnosacījumi

Pirms šo API izmantošanas pārliecinieties, vai jums ir:

  • Piekļuve Microsoft Dataverse videi
  • Sistēmas administratora atļaujas
  • Lasīšanas un rakstīšanas piekļuve Git repozitorijam

ConnectToGit API

Izveido savienojumu starp Dataverse risinājumu vai vidi un Git repozitoriju. Izmantojot šo savienojumu, varat pārvaldīt avota kontroli saviem Dataverse komponentiem.

Parametri

API ConnectToGit akceptē šādus parametrus:

Parametrs Tips Obligāts Apraksts
GitFolder Virkne Tās mapes nosaukums, kurai vēlaties piesaistīt risinājumu vai vidi.
Branch Virkne Tās filiāles nosaukums, ar kuru vēlaties izveidot savienojumu.
ConnectionType Integer Nē. Norāda, ar ko izveidot savienojumu. Skatiet parametru ConnectionType.
GitProvider Integer Nē. Git pakalpojumu sniedzējs. Skatiet parametru GitProvider.
Organization Virkne Nē. Organizācijas nosaukums, ar kuru vēlaties izveidot savienojumu.
Project Virkne Nē. Projekta nosaukums, ar kuru vēlaties izveidot savienojumu.
Repository Virkne Nē. Repozitorija nosaukums, ar kuru vēlaties izveidot savienojumu.
RootFolder Virkne Nē. Tās saknes mapes nosaukums, kurā visi risinājumi atrodas risinājuma tvērumā.
SolutionUniqueName Virkne Nē. Risinājuma unikālais nosaukums, kuru vēlaties izveidot ar git.
UpstreamBranch Virkne Nē. Augšupējā filiāle, ar kuru vēlaties izveidot savienojumu, nosaukums. Noklusējums ir repozitorija noklusējuma filiāle.

ConnectionType parametrs

Parametrs ConnectionType kontrolē, vai izveidot savienojumu ar visu Dataverse vidi vai konkrētu risinājumu.

Vērtība Etiķete Apraksts
0 Risinājums Savieno konkrētu Dataverse risinājumu ar Git.
1 Vide Savieno visu Dataverse vidi ar Git.

GitProvider parametrs

Izmantojiet parametru GitProvider , lai norādītu izmantotā Git nodrošinātāja tipu — Azure DevOps vai GitHub.

Vērtība Etiķete Apraksts
0 Azure DevOps Izmantojiet repozitorijiem, kas tiek viesoti Azure DevOps
1 GitHub Izmantojiet GitHub viesotiem repozitorijiem

DisconnectFromGit API

Noņem Git savienojumu no Dataverse risinājuma vai vides un atspējo avota kontroles integrāciju.

Parametrs

API DisconnectFromGit ir tikai viens parametrs.

Parametrs Tips Obligāts Apraksts
SolutionUniqueName Virkne Nē. Risinājuma unikālais nosaukums, kuru vēlaties atvienot no Git. Izlaist, lai atvienotu visus risinājumus vai vidi.

Papildinformācija

Tālāk ir norādītas dažas parametru vērtības opcijas, kas jānorāda, izsaucot DisconnectFromGit.

  • Atvienot vienu risinājumu: nodrošiniet SolutionUniqueName konkrēta risinājuma atvienošanu.
  • Atvienot visus risinājumus: nenorādiet parametrus, lai atvienotu visus risinājuma līmeņa savienojumus.
  • Atvienot vidi: nenorādiet parametrus, lai atvienotu vides līmeņa savienojumu.

Piemēri

Tālāk sniegtajos piemēros ir ConnectToGit aprakstīti API lietošanas DisconnectFromGit scenāriji:

Visas Dataverse vides savienošana ar Azure DevOps repozitoriju

Šis savienojums iespējo avota kontroli visām vides līmeņa konfigurācijām un komponentiem.

Neizmantojiet šos parametrus ar šo savienojumu:

  • RootFolder
  • SolutionUniqueName
  • UpstreamBranch

Šajā piemērā parādīts, kā izmantot darbību ConnectToGit , lai savienotu visu Dataverse vidi ar Azure DevOps repozitoriju.

Pieprasījums

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

Atbilde

HTTP/1.1 204 No Content
OData-Version: 4.0

Uzziniet, kā izsaukt tīmekļa API darbības

Visas Dataverse vides atvienošana no Git avota vadīklas

Šī darbība noņem vides līmeņa Git savienojumu. Šai operācijai neizmantojiet parametru SolutionUniqueName . Dataverse automātiski identificē un noņem vides līmeņa Git savienojumu.

Šajā piemērā parādīts, kā izmantot darbību DisconnectFromGit , lai atvienotu visu Dataverse vidi no Git avota vadīklas.

Pieprasījums

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

Atbilde

HTTP/1.1 204 No Content
OData-Version: 4.0

Uzziniet, kā izsaukt tīmekļa API darbības

Pirmā risinājuma savienošana ar Git repozitoriju

Šis savienojums izveido repozitorija saiti un mapju struktūru risinājuma līmeņa avota vadībai uz pirmo risinājumu vidē.

Lai norādītu risinājumu, ir jāiekļauj šo parametru vērtības:

  • RootFolder
  • SolutionUniqueName

Šajā piemērā ir parādīts, kā izmantot darbību ConnectToGit , lai savienotu pirmo risinājumu ar Git repozitoriju.

Pieprasījums

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

Atbilde

HTTP/1.1 204 No Content
OData-Version: 4.0

Uzziniet, kā izsaukt tīmekļa API darbības

Papildu risinājumu savienošana ar to pašu Git repozitoriju pēc sākotnējā risinājuma pievienošanas

Pēc pirmā risinājuma pievienošanas ir nepieciešami tikai risinājumam specifiskie parametri. Repozitorija savienojuma detaļas tiek mantotas no sākotnējā savienojuma.

Iestatiet tikai šos parametrus:

  • SolutionUniqueName
  • Branch
  • GitFolder

Svarīgi

Vispirms ir jāpievieno pirmais risinājums, pirms tas darbojas. Skatiet sadaļu Pirmā risinājuma savienošana ar Git repozitoriju.

Šajā piemērā ir parādīts, kā izmantot darbību ConnectToGit , lai savienotu turpmākos risinājumus ar Git repozitoriju.

Pieprasījums

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

Atbilde

HTTP/1.1 204 No Content
OData-Version: 4.0

Uzziniet, kā izsaukt tīmekļa API darbības

Konkrēta risinājuma atvienošana no Git avota vadīklas, vienlaikus saglabājot citu risinājumu savienojumu

Izmantojiet šo pieeju, lai noņemtu avota kontroli vienam risinājumam, neietekmējot citus.

Šajā piemērā ir parādīts, kā izmantot darbību DisconnectFromGit , lai noņemtu avota kontroli vienam risinājumam, neietekmējot citus.

Pieprasījums

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

Atbilde

HTTP/1.1 204 No Content
OData-Version: 4.0

Uzziniet, kā izsaukt tīmekļa API darbības

Kļūdu apstrāde

Ne the , ConnectToGit ne API DisconnectFromGit neatgriež vērtību, kad tā ir veiksmīgi pabeigta. Ja API neizdodas, tas atgriež kļūdu.

Bieži sastopamie kļūdu scenāriji ir šādi:

  • Nederīgi akreditācijas dati: pārliecinieties, vai jums ir derīga autentifikācija Git pakalpojumu sniedzējam.
  • Repozitorijs nav atrasts: pārbaudiet organizācijas, projekta un repozitoriju nosaukumus.
  • Atļauja liegta: pārliecinieties, vai jūsu Dataverse kontam ir avota kontroles pārvaldības atļaujas.
  • Risinājums nav atrasts: pārbaudiet, vai SolutionUniqueName tas pastāv jūsu vidē.
  • Filiāle nepastāv: apstipriniet, ka norādītā filiāle pastāv repozitorijā.

Atbalsts un papildu resursi

Papildinformāciju par avota vadības integrāciju ar Dataverse skatiet šeit: