Dataverse verbinden en loskoppelen van een Git-opslagplaats met behulp van code

Gebruik de ConnectToGit en DisconnectFromGit API's om uw Microsoft Dataverse-omgeving programmatisch te integreren met Git-broncodebeheer. Met behulp van deze API's kunt u afzonderlijke oplossingen of hele omgevingen verbinden met Git-opslagplaatsen die worden gehost in Azure DevOps en deze verbindingen beheren via code.

Belangrijk

Azure DevOps is momenteel de enige ondersteunde Git-provider.

Vereiste voorwaarden

Voordat u deze API's gebruikt, moet u het volgende doen:

  • Toegang tot een Microsoft Dataverse-omgeving
  • Systeembeheerdersmachtigingen
  • Lees- en schrijftoegang tot een Git-opslagplaats

ConnectToGit-API

Hiermee maakt u een verbinding tussen een Dataverse-oplossing of -omgeving en een Git-opslagplaats. Met deze verbinding kunt u broncodebeheer voor uw Dataverse-onderdelen beheren.

Parameters

De ConnectToGit API accepteert de volgende parameters:

Parameter Type Verplicht Beschrijving
GitFolder Tekenreeks Ja De naam van de map waaraan u uw oplossing of omgeving wilt koppelen.
Branch Tekenreeks Ja Naam van de tak waarmee u wilt verbinden.
ConnectionType Integer Nee Hiermee geeft u op waarmee verbinding moet worden gemaakt. Zie ConnectionType-parameter.
GitProvider Integer Nee De Git-provider. Zie de GitProvider-parameter.
Organization Tekenreeks Nee De naam van de organisatie waarmee u verbinding wilt maken.
Project Tekenreeks Nee Naam van het project waarmee u verbinding wilt maken.
Repository Tekenreeks Nee Naam van de opslagplaats waarmee u verbinding wilt maken.
RootFolder Tekenreeks Nee Naam van de hoofdmap waarin al uw oplossingen zich in het oplossingsbereik bevinden.
SolutionUniqueName Tekenreeks Nee De unieke naam van de oplossing die u wilt verbinden met Git.
UpstreamBranch Tekenreeks Nee Naam van de upstream-vertakking waarmee u verbinding wilt maken. Standaardinstellingen voor de standaardbranch van de opslagplaats.

ConnectionType-parameter

De ConnectionType parameter bepaalt of er verbinding moet worden gemaakt met de hele Dataverse-omgeving of een specifieke oplossing.

Waarde Etiket Beschrijving
0 Oplossing Hiermee wordt een specifieke Dataverse-oplossing verbonden met Git.
1 Omgeving Hiermee verbindt u de hele Dataverse-omgeving met Git.

GitProvider-parameter

Gebruik de GitProvider parameter om het type Git-provider op te geven dat u gebruikt, Azure DevOps of GitHub.

Waarde Etiket Beschrijving
0 Azure DevOps Gebruik voor repositories die worden gehost in Azure DevOps
1 GitHub Gebruik voor repositories die op GitHub worden gehost

DisconnectFromGit-API

Hiermee verwijdert u de Git-verbinding uit een Dataverse-oplossing of -omgeving en schakelt u de integratie van broncodebeheer uit.

Parameter

De DisconnectFromGit API heeft slechts één parameter.

Parameter Type Verplicht Beschrijving
SolutionUniqueName Tekenreeks Nee De unieke naam van de oplossing die u wilt loskoppelen van Git. Niet alle oplossingen of de omgeving loskoppelen.

Aanvullende gegevens

Hier volgen enkele opties voor parameterwaarden die moeten worden opgegeven bij het aanroepen DisconnectFromGit.

  • Verbinding verbreken met één oplossing: geef SolutionUniqueName aan om de verbinding met een specifieke oplossing te verbreken.
  • Alle oplossingen loskoppelen: geef geen parameters op om alle verbindingen op oplossingsniveau te verbreken.
  • Omgeving verbreken: geef geen parameters op om de verbinding op omgevingsniveau te verbreken.

Voorbeelden

In de volgende voorbeelden worden scenario's beschreven voor het gebruik van ConnectToGit en DisconnectFromGit API's:

Uw hele Dataverse-omgeving verbinden met een Azure DevOps-opslagplaats

Deze verbinding maakt broncodebeheer mogelijk voor alle configuraties en onderdelen op omgevingsniveau.

Gebruik deze parameters niet met deze verbinding:

  • RootFolder
  • SolutionUniqueName
  • UpstreamBranch

In dit voorbeeld ziet u hoe u de actie ConnectToGit gebruikt om uw hele Dataverse-omgeving te verbinden met een Azure DevOps-opslagplaats.

Aanvragen

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

Respons

HTTP/1.1 204 No Content
OData-Version: 4.0

Meer informatie over het aanroepen van web-API-acties

Uw volledige Dataverse-omgeving loskoppelen van Git-broncodebeheer

Met deze actie wordt de Git-verbinding op omgevingsniveau verwijderd. Gebruik de SolutionUniqueName parameter niet voor deze bewerking. Dataverse identificeert en verwijdert automatisch de Git-verbinding op omgevingsniveau.

In dit voorbeeld ziet u hoe u de actie DisconnectFromGit gebruikt om de volledige Dataverse-omgeving los te koppelen van Git-broncodebeheer.

Aanvragen

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

Respons

HTTP/1.1 204 No Content
OData-Version: 4.0

Meer informatie over het aanroepen van web-API-acties

De eerste oplossing verbinden met een Git-opslagplaats

Met deze verbinding maakt u de koppeling naar de opslagplaats en mapstructuur voor bronbeheer op oplossingsniveau naar de eerste oplossing in een omgeving.

U moet waarden voor deze parameters opnemen om de oplossing op te geven:

  • RootFolder
  • SolutionUniqueName

In dit voorbeeld ziet u hoe u de actie ConnectToGit gebruikt om de eerste oplossing te verbinden met een Git-opslagplaats.

Aanvragen

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

Respons

HTTP/1.1 204 No Content
OData-Version: 4.0

Meer informatie over het aanroepen van web-API-acties

Extra oplossingen verbinden met dezelfde Git-opslagplaats nadat u de eerste oplossing hebt verbonden

Nadat u de eerste oplossing hebt verbonden, hebt u alleen de oplossingsspecifieke parameters nodig. U neemt de verbindingsgegevens van de opslagplaats over van de eerste verbinding.

Stel alleen deze parameters in:

  • SolutionUniqueName
  • Branch
  • GitFolder

Belangrijk

U moet eerst de eerste oplossing verbinden voordat dit werkt. Zie De eerste oplossing verbinden met een Git-opslagplaats.

In dit voorbeeld ziet u hoe u de actie ConnectToGit gebruikt om volgende oplossingen te verbinden met een Git-opslagplaats.

Aanvragen

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

Respons

HTTP/1.1 204 No Content
OData-Version: 4.0

Meer informatie over het aanroepen van web-API-acties

Een specifieke oplossing loskoppelen van Git-broncodebeheer terwijl andere oplossingen verbonden blijven

Gebruik deze methode om broncodebeheer voor één oplossing te verwijderen zonder dat dit van invloed is op andere oplossingen.

In dit voorbeeld ziet u hoe u de actie DisconnectFromGit gebruikt om broncodebeheer voor één oplossing te verwijderen zonder dat dit van invloed is op andere.

Aanvragen

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

Respons

HTTP/1.1 204 No Content
OData-Version: 4.0

Meer informatie over het aanroepen van web-API-acties

Foutafhandeling

Noch de ConnectToGit noch de DisconnectFromGit API retourneert een waarde wanneer deze succesvol is voltooid. Wanneer een API mislukt, wordt er een fout geretourneerd.

Veelvoorkomende foutscenario's:

  • Ongeldige referenties: zorg ervoor dat u geldige verificatie hebt voor de Git-provider.
  • De opslagplaats is niet gevonden: controleer de namen van de organisatie, het project en de opslagplaats.
  • Machtiging geweigerd: Zorg ervoor dat uw Dataverse-account machtigingen voor broncodebeheer heeft.
  • Oplossing niet gevonden: Controleer of de SolutionUniqueName oplossing bestaat in uw omgeving.
  • Vertakking bestaat niet: Controleer of de opgegeven vertakking bestaat in de opslagplaats.

Ondersteuning en aanvullende bronnen

Zie voor meer informatie over de integratie van broncodebeheer met Dataverse: