Del via


Koble til og koble datavers fra et Git-repositorium ved hjelp av kode

ConnectToGit Bruk API-ene og DisconnectFromGit API-ene til å integrere Microsoft Dataverse-miljøet programmatisk med Git-kildekontrollen. Ved hjelp av disse API-ene kan du koble individuelle løsninger eller hele miljøer til Git-repositorier som driftes på Azure DevOps, og administrere disse tilkoblingene via kode.

Viktig!

Azure DevOps er for øyeblikket den eneste støttede Git-leverandøren.

Forutsetninger

Før du bruker disse API-ene, må du kontrollere at du har:

  • Tilgang til et Microsoft Dataverse-miljø
  • Systemansvarligs tillatelser
  • Lese og skrive tilgang til et Git-repositorium

ConnectToGit API

Oppretter en tilkobling mellom en datavers løsning eller et miljø og et Git-repositorium. Ved hjelp av denne tilkoblingen kan du administrere kildekontroll for dataverskomponentene.

Parametere

ConnectToGit API-en godtar følgende parametere:

Parameter Type Påkrevd Beskrivelse
GitFolder String Ja Navnet på mappen du vil binde løsningen eller miljøet til.
Branch String Ja Navnet på grenen du vil koble til.
ConnectionType Integer Nei Angir hva du skal koble til. Se ConnectionType-parameteren.
GitProvider Integer Nei Git-leverandøren. Se GitProvider-parameteren.
Organization String Nei Navnet på organisasjonen du vil koble til.
Project String Nei Navnet på prosjektet du vil koble til.
Repository String Nei Navnet på repositoriet du vil koble til.
RootFolder String Nei Navnet på rotmappen der alle løsningene ligger i løsningsomfanget.
SolutionUniqueName String Nei Det unike navnet på løsningen du vil koble til git.
UpstreamBranch String Nei Navnet på oppstrømsgreningen du vil koble til. Angis til standardgrenen for repositorium.

ConnectionType-parameter

Parameteren ConnectionType kontrollerer om du vil koble til hele dataversmiljøet eller en bestemt løsning.

Verdi Etikett Beskrivelse
0 Løsning Kobler en bestemt dataversløsning til Git.
1 Miljø Kobler hele dataversmiljøet til Git.

GitProvider-parameter

Bruk parameteren GitProvider til å angi hvilken type Git-leverandør du bruker, enten Azure DevOps eller GitHub.

Verdi Etikett Beskrivelse
0 Azure DevOps Bruk for repositorier som driftes på Azure DevOps
1 GitHub Bruk for repositorier som driftes på GitHub

DisconnectFromGit API

Fjerner Git-tilkoblingen fra en datavers løsning eller et miljø, og deaktiverer kildekontrollintegrering.

Parameter

DisconnectFromGit API-en har bare én parameter.

Parameter Type Påkrevd Beskrivelse
SolutionUniqueName String Nei Det unike navnet på løsningen du vil koble fra Git. Utelate å koble fra alle løsninger eller miljøet.

Tilleggsinformasjon

Her er noen alternativer for parameterverdi du kan angi når du aktiverer DisconnectFromGit.

  • Koble fra én enkelt løsning: Angi SolutionUniqueName at du skal koble fra en bestemt løsning.
  • Koble fra alle løsninger: Gir ingen parametere for å koble fra alle tilkoblinger på løsningsnivå.
  • Frakoblingsmiljø: Gir ingen parametere for å koble fra tilkoblingen på miljønivå.

Eksempler

Eksemplene nedenfor beskriver scenarioer for bruk ConnectToGit og DisconnectFromGit API-er:

Koble hele dataversmiljøet til et Azure DevOps-repositorium

Denne tilkoblingen aktiverer kildekontroll for alle konfigurasjoner og komponenter på miljønivå.

Ikke bruk disse parameterne med denne tilkoblingen:

  • RootFolder
  • SolutionUniqueName
  • UpstreamBranch

Dette eksemplet viser hvordan du bruker Handlingen ConnectToGit til å koble hele dataversmiljøet til et Azure DevOps-repositorium.

Be om

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

Finn ut hvordan du aktiverer web-API-handlinger

Koble fra hele Dataverse-miljøet fra Git-versjonskontroll

Denne handlingen fjerner git-tilkoblingen på miljønivå. Ikke bruk parameteren SolutionUniqueName for denne operasjonen. Datavers identifiserer og fjerner automatisk Git-tilkoblingen på miljønivå.

Dette eksemplet viser hvordan du bruker handlingen DisconnectFromGit til å koble hele dataversmiljøet fra Git-kildekontrollen.

Be om

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

Finn ut hvordan du aktiverer web-API-handlinger

Koble den første løsningen til et Git-repositorium

Denne tilkoblingen etablerer repositoriumkoblingen og mappestrukturen for kildekontroll på løsningsnivå til den første løsningen i et miljø.

Du må inkludere verdier for disse parameterne for å angi løsningen:

  • RootFolder
  • SolutionUniqueName

Dette eksemplet viser hvordan du bruker handlingen ConnectToGit til å koble den første løsningen til et Git-repositorium.

Be om

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

Finn ut hvordan du aktiverer web-API-handlinger

Koble ekstra løsninger til samme Git-repositorium etter at du har koblet til den opprinnelige løsningen

Når du har koblet til den første løsningen, trenger du bare de løsningsspesifikke parameterne. Du arver tilkoblingsdetaljene for repositoriet fra den første tilkoblingen.

Angi bare disse parameterne:

  • SolutionUniqueName
  • Branch
  • GitFolder

Viktig!

Du må først koble til den første løsningen før dette fungerer. Se Koble den første løsningen til et Git-repositorium.

Dette eksemplet viser hvordan du bruker handlingen ConnectToGit til å koble etterfølgende løsninger til et Git-repositorium.

Be om

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

Finn ut hvordan du aktiverer web-API-handlinger

Koble fra en bestemt løsning fra Git-kildekontrollen samtidig som andre løsninger er tilkoblet

Bruk denne fremgangsmåten til å fjerne kildekontroll for én løsning uten å påvirke andre.

Dette eksemplet viser hvordan du bruker handlingen DisconnectFromGit til å fjerne kildekontroll for én løsning uten å påvirke andre.

Be om

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

Finn ut hvordan du aktiverer web-API-handlinger

Feilbehandling

Verken ConnectToGit eller DisconnectFromGit API-en returnerer en verdi når de er fullført. Når en API mislykkes, returnerer den en feil.

Vanlige feilscenarioer inkluderer:

  • Ugyldig legitimasjon: Kontroller at du har gyldig godkjenning til Git-leverandøren.
  • Finner ikke repositorium: Kontroller organisasjonen, prosjektet og repositoriumnavnene.
  • Ingen tillatelse: Kontroller at Dataverse-kontoen har tillatelser for kildekontrolladministrasjon.
  • Finner ikke løsningen: Kontroller at det SolutionUniqueName finnes i miljøet.
  • Grenen finnes ikke: Bekreft at den angitte grenen finnes i repositoriet.

Støtte og tilleggsressurser

Hvis du vil ha mer informasjon om kildekontrollintegrering med Datavers, kan du se: