Opret forbindelse til og frakoble Dataverse fra et Git-lager ved hjælp af kode

ConnectToGit Brug API'erne og DisconnectFromGit til programmeringsmæssigt at integrere dit Microsoft Dataverse-miljø med Git-kildekontrol. Ved hjælp af disse API'er kan du forbinde individuelle løsninger eller hele miljøer til Git-lagre, der hostes på Azure DevOps, og administrere disse forbindelser via kode.

Vigtigt

Azure DevOps er i øjeblikket den eneste understøttede Git-udbyder.

Forudsætninger

Før du bruger disse API'er, skal du sikre dig, at du har:

  • Adgang til et Microsoft Dataverse-miljø
  • Systemadministratortilladelser
  • Læse- og skriveadgang til et Git-lager

ConnectToGit API

Opretter en forbindelse mellem en Dataverse-løsning eller et miljø og et Git-lager. Ved hjælp af denne forbindelse kan du administrere kildestyring for dine Dataverse-komponenter.

Parametre

ConnectToGit API'en accepterer følgende parametre:

Parameter Type Påkrævet Beskrivende tekst
GitFolder Streng Ja Navnet på den mappe, du vil binde din løsning eller dit miljø til.
Branch Streng Ja Navnet på den forgrening, du vil oprette forbindelse til.
ConnectionType Heltal Nej Angiver, hvad der skal oprettes forbindelse til. Se ConnectionType-parameter.
GitProvider Heltal Nej Git-udbyderen. Se GitProvider-parameter.
Organization Streng Nej Navnet på den organisation, du vil oprette forbindelse til.
Project Streng Nej Navnet på det projekt, du vil oprette forbindelse til.
Repository Streng Nej Navnet på det lager, du vil oprette forbindelse til.
RootFolder Streng Nej Navnet på rodmappen, hvor alle dine løsninger er placeret i løsningsområdet.
SolutionUniqueName Streng Nej Det entydige navn på den løsning, du vil oprette forbindelse til git.
UpstreamBranch Streng Nej Navnet på den upstream-forgrening, du vil oprette forbindelse til. Standardindstilles til standardgrenen i repositoryet.

Parameteren ConnectionType

Parameteren ConnectionType styrer, om der skal oprettes forbindelse til hele Dataverse-miljøet eller en bestemt løsning.

Værdi Label Beskrivende tekst
0 Løsning Forbinder en bestemt Dataverse-løsning til Git.
1 Miljø Forbinder hele Dataverse-miljøet med Git.

GitProvider-parameter

GitProvider Brug parameteren til at angive den type Git-provider, du bruger, enten Azure DevOps eller GitHub.

Værdi Label Beskrivende tekst
0 Azure DevOps Bruges til lagre, der hostes på Azure DevOps
1 GitHub Bruges til lagre, der hostes på GitHub

DisconnectFromGit API

Fjerner Git-forbindelsen fra en Dataverse-løsning eller et datamiljø og deaktiverer integration af versionsstyring.

Parameter

API'en DisconnectFromGit har kun én parameter.

Parameter Type Påkrævet Beskrivende tekst
SolutionUniqueName Streng Nej Det entydige navn på den løsning, du vil afbryde forbindelsen til Git. Udelad forbindelsen til alle løsninger eller miljøet.

Flere oplysninger

Her er et par parameterværdiindstillinger, der skal angives, når der aktiveres DisconnectFromGit.

  • Afbryd forbindelsen til en enkelt løsning: Angiv SolutionUniqueName for at afbryde forbindelsen til en bestemt løsning.
  • Afbryd forbindelsen til alle løsninger: Angiv ingen parametre for at afbryde forbindelsen til alle forbindelser på løsningsniveau.
  • Afbryd forbindelsen til miljøet: Angiv ingen parametre for at afbryde forbindelsen på miljøniveau.

Eksempler

I følgende eksempler beskrives scenarier for brug og ConnectToGitDisconnectFromGit API'er:

Forbind hele dit Dataverse-miljø til et Azure DevOps-lager

Denne forbindelse muliggør kildestyring for alle konfigurationer og komponenter på miljøniveau.

Brug ikke disse parametre med denne forbindelse:

  • RootFolder
  • SolutionUniqueName
  • UpstreamBranch

I dette eksempel kan du se, hvordan du bruger handlingen ConnectToGit til at forbinde hele dit Dataverse-miljø til et Azure DevOps-lager.

Anmodning

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

Svar

HTTP/1.1 204 No Content
OData-Version: 4.0

Få mere at vide om, hvordan du aktiverer web-API-handlinger

Afbryd hele dit Dataverse-miljø fra Git-kildekontrol

Denne handling fjerner Git-forbindelsen på miljøniveau. Brug ikke SolutionUniqueName parameteren til denne handling. Dataverse identificerer og fjerner automatisk Git-forbindelsen på miljøniveau.

I dette eksempel kan du se, hvordan du bruger handlingen DisconnectFromGit til at afbryde forbindelsen mellem hele dit Dataverse-miljø og Git-kildekontrolelementet.

Anmodning

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

Svar

HTTP/1.1 204 No Content
OData-Version: 4.0

Få mere at vide om, hvordan du aktiverer web-API-handlinger

Forbind den første løsning til et Git-lager

Denne forbindelse etablerer lagerlinket og mappestrukturen for versionsstyring på løsningsniveau til den første løsning i et miljø.

Du skal inkludere værdier for disse parametre for at angive løsningen:

  • RootFolder
  • SolutionUniqueName

I dette eksempel kan du se, hvordan du bruger handlingen ConnectToGit til at oprette forbindelse mellem den første løsning og et Git-lager.

Anmodning

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

Svar

HTTP/1.1 204 No Content
OData-Version: 4.0

Få mere at vide om, hvordan du aktiverer web-API-handlinger

Forbind ekstra løsninger til det samme Git-lager, når du har oprettet forbindelse til den indledende løsning

Når du har oprettet forbindelse til den første løsning, skal du kun bruge de løsningsspecifikke parametre. Du nedarver oplysningerne om lagerforbindelsen fra den indledende forbindelse.

Angiv kun disse parametre:

  • SolutionUniqueName
  • Branch
  • GitFolder

Vigtigt

Du skal først oprette forbindelse til den første løsning, før dette fungerer. Se Opret forbindelse mellem den første løsning og et Git-lager.

I dette eksempel kan du se, hvordan du bruger handlingen ConnectToGit til at oprette forbindelse mellem efterfølgende løsninger og et Git-lager.

Anmodning

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

Svar

HTTP/1.1 204 No Content
OData-Version: 4.0

Få mere at vide om, hvordan du aktiverer web-API-handlinger

Afbryd forbindelsen mellem en bestemt løsning og Git-kildestyringen, samtidig med at andre løsninger er tilsluttet

Brug denne fremgangsmåde til at fjerne kildekontrol for én løsning, uden at det påvirker andre.

I dette eksempel kan du se, hvordan du bruger handlingen AfbrydFraGit til at fjerne kildekontrol for én løsning uden at påvirke andre.

Anmodning

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

Svar

HTTP/1.1 204 No Content
OData-Version: 4.0

Få mere at vide om, hvordan du aktiverer web-API-handlinger

Fejlhåndtering

Hverken API'en ConnectToGitDisconnectFromGit eller returnerer en værdi, når den fuldføres. Når en API mislykkes, returneres der en fejl.

Almindelige fejlscenarier omfatter:

  • Ugyldige legitimationsoplysninger: Kontrollér, at du har gyldig godkendelse til Git-udbyderen.
  • Lageret blev ikke fundet: Kontrollér navnene på organisationen, projektet og lageret.
  • Tilladelse nægtet: Kontrollér, at din Dataverse-konto har tilladelser til administration af kildekontrol.
  • Løsningen blev ikke fundet: Kontrollér, at SolutionUniqueName findes i dit miljø.
  • Forgreningen findes ikke: Bekræft, at den angivne forgrening findes i lageret.

Support og yderligere ressourcer

Du kan få flere oplysninger om integration af versionsstyring med Dataverse i: