Condividi tramite


Connettersi e disconnettere Dataverse da un repository Git usando il codice

Usare le API ConnectToGit e DisconnectFromGit per integrare programmaticamente l'ambiente Microsoft Dataverse con il controllo del codice sorgente Git. Usando queste API, è possibile connettere singole soluzioni o interi ambienti ai repository Git ospitati in Azure DevOps e gestire tali connessioni tramite il codice.

Importante

Azure DevOps è attualmente l'unico provider Git supportato.

Prerequisiti

Prima di usare queste API, assicurarsi di avere:

  • Accesso a un ambiente Microsoft Dataverse
  • Autorizzazioni di amministratore di sistema
  • Accesso in lettura e scrittura a un repository Git

ConnectToGit API

Crea una connessione tra una soluzione o un ambiente Dataverse e un repository Git. Usando questa connessione, è possibile gestire il controllo del codice sorgente per i componenti dataverse.

Parametri

L'API ConnectToGit accetta i parametri seguenti:

Parametro Tipo Obbligatorio Descrizione
GitFolder String Nome della cartella a cui si vuole associare la soluzione o l'ambiente.
Branch String Nome del ramo a cui connettersi.
ConnectionType Integer No Specifica a cosa connettersi. Vedere il parametro ConnectionType.
GitProvider Integer No Provider Git. Vedere Il parametro GitProvider.
Organization String No Nome dell'organizzazione a cui ci si vuole connettere.
Project String No Nome del progetto a cui ci si vuole connettere.
Repository String No Nome del repository a cui ci si vuole connettere.
RootFolder String No Nome della cartella radice in cui si trovano tutte le soluzioni nell'ambito della soluzione.
SolutionUniqueName String No Nome univoco della soluzione da connettere a Git.
UpstreamBranch String No Nome del ramo upstream a cui connettersi. L'impostazione predefinita corrisponde al ramo principale del repository.

Parametro ConnectionType

Il ConnectionType parametro controlla se connettersi all'intero ambiente Dataverse o a una soluzione specifica.

Valore Etichetta Descrizione
0 Soluzione Connette una soluzione Dataverse specifica a Git.
1 Ambiente Connette l'intero ambiente Dataverse a Git.

Parametro GitProvider

Usare il GitProvider parametro per specificare il tipo di provider Git in uso, Azure DevOps o GitHub.

Valore Etichetta Descrizione
0 Azure DevOps Utilizzare per i repository ospitati in Azure DevOps
1 GitHub Usare per i repository ospitati su GitHub

DisconnectFromGit API

Rimuove la connessione Git da una soluzione o un ambiente Dataverse e disabilita l'integrazione del controllo del codice sorgente.

Parametro

L'API DisconnectFromGit ha un solo parametro.

Parametro Tipo Obbligatorio Descrizione
SolutionUniqueName String No Nome univoco della soluzione che si vuole disconnettere da Git. Omettere di disconnettere tutte le soluzioni o l'ambiente.

Informazioni aggiuntive

Di seguito sono riportate alcune opzioni per il valore del parametro da specificare quando si richiama DisconnectFromGit.

  • Disconnettere una singola soluzione: fornire SolutionUniqueName per disconnettere una soluzione specifica.
  • Disconnettere tutte le soluzioni: non fornire parametri per disconnettere tutte le connessioni a livello di soluzione.
  • Disconnetti ambiente: non specificare parametri per disconnettere la connessione a livello di ambiente.

Examples

Gli esempi seguenti descrivono gli scenari per l'uso delle API ConnectToGit e DisconnectFromGit.

Connetti l'intero ambiente Dataverse a un repository di Azure DevOps

Questa connessione abilita il controllo del codice sorgente per tutte le configurazioni e i componenti a livello di ambiente.

Non usare questi parametri con questa connessione:

  • RootFolder
  • SolutionUniqueName
  • UpstreamBranch

Questo esempio illustra come usare l'azione ConnectToGit per connettere l'intero ambiente Dataverse a un repository Azure DevOps.

Richiedi

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

risposta

HTTP/1.1 204 No Content
OData-Version: 4.0

Informazioni su come richiamare le azioni dell'API Web

Disconnettere l'intero ambiente Dataverse dal controllo del codice sorgente Git

Questa azione rimuove la connessione Git a livello di ambiente. Non usare il SolutionUniqueName parametro per questa operazione. Dataverse identifica e rimuove automaticamente la connessione Git a livello di ambiente.

Questo esempio illustra come usare l'azione DisconnectFromGit per disconnettere l'intero ambiente Dataverse dal controllo del codice sorgente Git.

Richiedi

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

risposta

HTTP/1.1 204 No Content
OData-Version: 4.0

Informazioni su come richiamare le azioni dell'API Web

Connettere la prima soluzione a un repository Git

Questa connessione stabilisce il collegamento del repository e la struttura delle cartelle per il controllo del codice sorgente a livello di soluzione nella prima soluzione di un ambiente.

È necessario includere valori per questi parametri per specificare la soluzione:

  • RootFolder
  • SolutionUniqueName

Questo esempio illustra come usare l'azione ConnectToGit per connettere la prima soluzione a un repository Git.

Richiedi

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

risposta

HTTP/1.1 204 No Content
OData-Version: 4.0

Informazioni su come richiamare le azioni dell'API Web

Connettere soluzioni aggiuntive allo stesso repository Git dopo aver connesso la soluzione iniziale

Dopo aver connesso la prima soluzione, sono necessari solo i parametri specifici della soluzione. I dettagli della connessione del repository vengono ereditati dalla connessione iniziale.

Impostare solo questi parametri:

  • SolutionUniqueName
  • Branch
  • GitFolder

Importante

Prima di eseguire questa operazione, è necessario connettere la prima soluzione. Vedere Connettere la prima soluzione a un repository Git.

Questo esempio illustra come usare l'azione ConnectToGit per connettere le soluzioni successive a un repository Git.

Richiedi

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

risposta

HTTP/1.1 204 No Content
OData-Version: 4.0

Informazioni su come richiamare le azioni dell'API Web

Disconnettere una soluzione specifica dal controllo del codice sorgente Git mantenendo connesse altre soluzioni

Usare questo approccio per rimuovere il controllo del codice sorgente per una soluzione senza influire sugli altri.

In questo esempio viene illustrato come usare l'azione DisconnectFromGit per rimuovere il controllo del codice sorgente per una soluzione senza influire sugli altri.

Richiedi

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

risposta

HTTP/1.1 204 No Content
OData-Version: 4.0

Informazioni su come richiamare le azioni dell'API Web

Gestione degli errori

Né l'API ConnectToGit né l'API DisconnectFromGit restituisce un valore quando viene completato correttamente. Quando un'API non riesce, restituisce un errore.

Gli scenari di errore comuni includono:

  • Credenziali non valide: assicurarsi di disporre dell'autenticazione valida per il provider Git.
  • Repository non trovato: verifica i nomi dell'organizzazione, del progetto e del repository.
  • Autorizzazione negata: verificare che l'account Dataverse disponga delle autorizzazioni di gestione del controllo del codice sorgente.
  • Soluzione non trovata: verificare che SolutionUniqueName esista nel tuo ambiente.
  • Ramo non esistente: verificare che il ramo specificato esista nel repository.

Supporto e risorse aggiuntive

Per altre informazioni sull'integrazione del controllo del codice sorgente con Dataverse, vedere: