Märkus.
Juurdepääs sellele lehele nõuab autoriseerimist. Võite proovida sisse logida või kausta vahetada.
Juurdepääs sellele lehele nõuab autoriseerimist. Võite proovida kausta vahetada.
Kasuta ConnectToGit ja DisconnectFromGit API-sid, et programmiliselt integreerida oma Microsoft Dataverse'i keskkond Git lähtekoodihaldusega. Nende API-de abil saad ühendada üksikuid lahendusi või terveid keskkondi Azure DevOpsis majutatud Git-repositooriumidega ning hallata neid ühendusi koodi kaudu.
Oluline
Azure DevOps on praegu ainus toetatud Git-teenuse pakkuja.
Eeltingimused
Enne nende API-de kasutamist veendu, et sul on:
- Juurdepääs Microsoft Dataverse'i keskkonnale
- Süsteemiadministraatori õigused
- Lugemis- ja kirjutamisligipääs Git-repositooriumile
ConnectToGit API
Loob ühenduse Dataverse'i lahenduse või keskkonna ja Git-hoidla vahel. Selle ühenduse abil saad hallata oma Dataverse'i komponentide lähtekoodihaldust.
Parameetrid
API ConnectToGit aktsepteerib järgmisi parameetreid:
| Parameeter | Tüüp | Nõutav | Kirjeldus |
|---|---|---|---|
GitFolder |
String | Jah | Kausta nimi, kuhu soovid oma lahenduse või keskkonna siduda. |
Branch |
String | Jah | Haru nimi, millega soovid ühenduda. |
ConnectionType |
Täisarv | Nr | Määrab, millega ühenduda. Vaata ConnectionType parameetrit. |
GitProvider |
Täisarv | Nr | Git-teenuse pakkuja. Vaata GitProvider parameetrit. |
Organization |
String | Nr | Organisatsiooni nimi, kellega soovid ühendust võtta. |
Project |
String | Nr | Projekti nimi, millega soovid ühenduda. |
Repository |
String | Nr | Andmehoidla nimi, millega soovid ühenduda. |
RootFolder |
String | Nr | Juurkausta nimi, kus kõik sinu lahendused lahenduste ulatuses asuvad. |
SolutionUniqueName |
String | Nr | Lahenduse ainulaadne nimi, millega soovid ühendada. |
UpstreamBranch |
String | Nr | Ülemharu nimi, millega soovid ühenduda. Vaikimisi on hoidla vaikimisi haru. |
ConnectionType parameeter
Parameeter ConnectionType määrab, kas ühendada kogu Dataverse'i keskkonnaga või konkreetse lahendusega.
| Väärtus | Silt | Kirjeldus |
|---|---|---|
| 0 | Lahendus | Ühendab konkreetse Dataverse'i lahenduse Gitiga. |
| 1 | Keskkond | Ühendab kogu Dataverse'i keskkonna Gitiga. |
GitProvider parameeter
Kasuta parameetrit GitProvider , et määrata, millist Git-teenuse pakkujat kasutad, kas Azure DevOps või GitHub.
| Väärtus | Silt | Kirjeldus |
|---|---|---|
| 0 | Azure DevOps | Use for repositories hosted on Azure DevOps |
| 1 | GitHub | Kasutus GitHubis majutatud repositooriumitele |
DisconnectFromGit API
Eemaldab Git-ühenduse Dataverse'i lahendusest või keskkonnast ning keelab lähtekoodihalduse integratsiooni.
Parameeter
API-l DisconnectFromGit on ainult üks parameeter.
| Parameeter | Tüüp | Nõutav | Kirjeldus |
|---|---|---|---|
SolutionUniqueName |
String | Nr | Lahenduse unikaalne nimi, mida soovid Gitist lahti ühendada. Ära katkesta kõigi lahenduste või keskkonna katkestamist. |
Lisateave
Siin on mõned parameetri väärtuse valikud, mida määrata kutsumisel DisconnectFromGit.
-
Ühenda lahti üks lahendus: Paku
SolutionUniqueNamekonkreetse lahenduse lahtiühendamist. - Katkesta kõik lahendused: Ära anna parameetreid kõigi lahendustaseme ühenduste lahtiühendamiseks.
- Ühenduse katkestamise keskkond: Ei paku parameetreid keskkonnataseme ühenduse katkestamiseks.
Näited
Järgnevad näited kirjeldavad stsenaariume API-de kasutamiseks ConnectToGitDisconnectFromGit :
- Ühenda kogu oma Dataverse'i keskkond Azure DevOps repositooriumiga
- Katkesta kogu oma Dataverse'i keskkond Git lähtekoodihaldusest
- Ühenda esimene lahendus Git-repositooriumiga
- Ühenda lisalahendused samasse Giti hoidla pärast esialgse lahenduse ühendamist
- Ühenda konkreetne lahendus Giti lähtehaldusest, hoides samal ajal teisi lahendusi ühendatuna
Ühenda kogu oma Dataverse'i keskkond Azure DevOps repositooriumiga
See ühendus võimaldab lähtekoodihaldust kõigi keskkonnataseme konfiguratsioonide ja komponentide jaoks.
Ära kasuta neid parameetreid selle seosega:
RootFolderSolutionUniqueNameUpstreamBranch
See näide näitab, kuidas kasutada ConnectToGit tegevust , et ühendada kogu oma Dataverse'i keskkond Azure DevOps hoidlaga.
Taotlus
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"
}
Vastus
HTTP/1.1 204 No Content
OData-Version: 4.0
Katkesta kogu oma Dataverse'i keskkond Git lähtekoodihaldusest
See tegevus eemaldab keskkonnataseme Git-ühenduse. Ära kasuta seda SolutionUniqueName parameetrit selle operatsiooni jaoks. Dataverse tuvastab ja eemaldab automaatselt keskkonnataseme Git-ühenduse.
See näide näitab, kuidas kasutada DisconnectFromGit tegevust , et katkestada kogu oma Dataverse'i keskkond Git lähtekoodihaldusest.
Taotlus
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
Vastus
HTTP/1.1 204 No Content
OData-Version: 4.0
Ühenda esimene lahendus Git-repositooriumiga
See ühendus loob hoidla lingi ja kaustastruktuuri lahendustaseme lähtekoodihalduse jaoks esimese lahenduseni keskkonnas.
Lahenduse määramiseks tuleb lisada nende parameetrite väärtused:
RootFolderSolutionUniqueName
See näide näitab, kuidas kasutada ConnectToGit tegevust , et ühendada esimene lahendus Giti hoidlaga.
Taotlus
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"
}
Vastus
HTTP/1.1 204 No Content
OData-Version: 4.0
Ühenda lisalahendused samasse Giti hoidla pärast esialgse lahenduse ühendamist
Pärast esimese lahenduse ühendamist on vaja ainult lahendusspetsiifilisi parameetreid. Sa pärid hoidla ühenduse andmed algsest ühendusest.
Sea ainult need parameetrid:
SolutionUniqueNameBranchGitFolder
Oluline
Enne kui see töötab, pead esmalt ühendama esimese lahenduse. Vaata Ühenda esimene lahendus Giti hoidlaga.
See näide näitab, kuidas kasutada ConnectToGit tegevust , et ühendada järgmised lahendused Git-hoidlaga.
Taotlus
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"
}
Vastus
HTTP/1.1 204 No Content
OData-Version: 4.0
Ühenda konkreetne lahendus Giti lähtehaldusest, hoides samal ajal teisi lahendusi ühendatuna
Kasuta seda lähenemist, et eemaldada ühe lahenduse lähtekoodikontroll ilma teisi mõjutamata.
See näide näitab, kuidas kasutada DisconnectFromGit tegevust , et eemaldada ühe lahenduse lähtekood ilma teisi mõjutamata.
Taotlus
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"
}
Vastus
HTTP/1.1 204 No Content
OData-Version: 4.0
Tõrketöötlus
Ei API ConnectToGit ega DisconnectFromGit API tagasta väärtust, kui see edukalt lõpetatakse. Kui API ebaõnnestub, tagastab see vea.
Levinumad vea stsenaariumid on:
- Kehtetud mandaadiandmed: Veendu, et sul on Giti teenusepakkujale kehtiv autentimine.
- Hoidla ei leitud: Kontrolli organisatsiooni, projekti ja hoidla nimed.
- Luba keelatud: Veenduge, et teie Dataverse'i kontol on lähtekoodihalduse õigused.
-
Lahendus ei leitud: Kontrolli, et need
SolutionUniqueNameeksisteerivad sinu keskkonnas. - Haru ei eksisteeri: Kinnita, et määratud haru eksisteerib hoidlas.
Toetus ja täiendavad ressursid
Lisateabe saamiseks lähtekoodihalduse integratsiooni kohta Dataverse'iga vaata: