Git - Connect

Servizio:: Core

Versione API:: v1

Connettere un'area di lavoro specifica a un repository Git e a un ramo.
Questa operazione non viene sincronizzata tra l'area di lavoro e il ramo connesso. Per completare la sincronizzazione, usare l'operazione Inizializza connessione e seguire l'operazione Commit in Git o Update From Git .

Per iniziare a usare GitHub, vedere Introduzione all'integrazione con Git.

Per ottenere l'ID connessione, vedere Automatizzare l'integrazione di Git.

Autorizzazioni

Il chiamante deve avere un ruolo di amministratore per l'area di lavoro.

Per le credenziali Git di connessione configurate, il chiamante deve disporre dell'autorizzazione per la connessione.

Ambiti delegati obbligatori

SpazioDiLavoro.LetturaScrittura.Tutti

Limitazioni

Quando si usa l'origine delle credenziali automatiche, questa API viene bloccata per il provider GitHub e per l'entità servizio.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
Entità servizio e Identità gestite	Supportato solo quando myGitCredentials.source è ConfiguredConnection

Interfaccia

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connect

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
gitProviderDetails	True	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Dettagli del provider Git.
myGitCredentials		GitCredentials: ConfiguredConnectionGitCredentials AutomaticGitCredentials	Credenziali Git specifiche dell'utente per l'autenticazione in GitProvider. Queste credenziali non vengono condivise con altri collaboratori dell'area di lavoro. Per GitHub, questa proprietà è obbligatoria. Per AzureDevOps, questa proprietà è facoltativa. Se non è impostato, il valore predefinito è AutomaticGitCredentials.

Risposte

Nome	Tipo	Descrizione
200 OK		Richiesta completata correttamente.
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore. WorkspaceAlreadyConnectedToGit: l'area di lavoro è già connessa a Git. WorkspaceHasNoCapacityAssigned: nessuna capacità assegnata all'area di lavoro. InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro. PrincipalTypeNotSupported: il tipo di identità del chiamante non è supportato.

Nome

Tipo

Descrizione

200 OK

Richiesta completata correttamente.

Other Status Codes

ErrorResponse

Codici di errore comuni:

UnknownError: si è verificato un errore.
WorkspaceAlreadyConnectedToGit: l'area di lavoro è già connessa a Git.
WorkspaceHasNoCapacityAssigned: nessuna capacità assegnata all'area di lavoro.
InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro.
PrincipalTypeNotSupported: il tipo di identità del chiamante non è supportato.

Esempio

Connect a workspace to Azure DevOps example

Connect a workspace to Azure DevOps using configured connection example

Connect a workspace to GitHub example

Connect a workspace to Azure DevOps example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/connect

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory"
  }
}

Risposta di esempio

Codice di stato:: 200

Connect a workspace to Azure DevOps using configured connection example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/connect

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Risposta di esempio

Codice di stato:: 200

Connect a workspace to GitHub example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/connect

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

Risposta di esempio

Codice di stato:: 200

Definizioni

Nome	Descrizione
AutomaticGitCredentials	Credenziali Git automatiche.
AzureDevOpsDetails	Dettagli del provider Azure DevOps.
ConfiguredConnectionGitCredentials	Credenziali Git di connessione configurate.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GitConnectRequest	Contiene i dati della richiesta di connessione Git.
GitCredentialsSource	Origine delle credenziali Git. È possibile aggiungere altre origini credenziali Git nel tempo.
GitHubDetails	Dettagli del provider GitHub.
GitProviderType	Tipo di provider Git. È possibile aggiungere altri tipi di provider nel tempo.

AutomaticGitCredentials

Object

Credenziali Git automatiche.

Nome	Tipo	Descrizione
source	string: Automatic	Origine delle credenziali Git.

AzureDevOpsDetails

Object

Dettagli del provider Azure DevOps.

Nome	Tipo	Descrizione
branchName	string maxLength: 250	Nome del ramo. La lunghezza massima è di 250 caratteri.
directoryName	string maxLength: 256	Percorso relativo della directory. La lunghezza massima consentita è di 256 caratteri.
gitProviderType	string: AzureDevOps	Tipo di provider Git. È possibile aggiungere altri tipi di provider nel tempo.
organizationName	string maxLength: 100	Nome dell'organizzazione. La lunghezza massima è di 100 caratteri.
projectName	string maxLength: 100	Nome del progetto. La lunghezza massima è di 100 caratteri.
repositoryName	string maxLength: 128	Nome del repository. La lunghezza massima consentita è di 128 caratteri.

ConfiguredConnectionGitCredentials

Object

Credenziali Git di connessione configurate.

Nome	Tipo	Descrizione
connectionId	string (uuid)	ID oggetto della connessione.
source	string: ConfiguredConnection	Origine delle credenziali Git.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

GitConnectRequest

Object

Contiene i dati della richiesta di connessione Git.

Nome	Tipo	Descrizione
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Dettagli del provider Git.
myGitCredentials	GitCredentials: AutomaticGitCredentials ConfiguredConnectionGitCredentials	Credenziali Git specifiche dell'utente per l'autenticazione in GitProvider. Queste credenziali non vengono condivise con altri collaboratori dell'area di lavoro. Per GitHub, questa proprietà è obbligatoria. Per AzureDevOps, questa proprietà è facoltativa. Se non è impostato, il valore predefinito è AutomaticGitCredentials.

GitCredentialsSource

Enumerazione

Origine delle credenziali Git. È possibile aggiungere altre origini credenziali Git nel tempo.

Valore	Descrizione
ConfiguredConnection	Le credenziali Git vengono ottenute tramite una connessione configurata.
Automatic	Le credenziali Git vengono ottenute automaticamente dal sistema, usando le credenziali predefinite, se disponibili.
None	Le credenziali Git non sono configurate.

GitHubDetails

Object

Dettagli del provider GitHub.

Nome	Tipo	Descrizione
branchName	string maxLength: 250	Nome del ramo. La lunghezza massima è di 250 caratteri.
directoryName	string maxLength: 256	Percorso relativo della directory. La lunghezza massima consentita è di 256 caratteri.
gitProviderType	string: GitHub	Tipo di provider Git. È possibile aggiungere altri tipi di provider nel tempo.
ownerName	string maxLength: 100	Nome del proprietario. La lunghezza massima è di 100 caratteri.
repositoryName	string maxLength: 128	Nome del repository. La lunghezza massima consentita è di 128 caratteri.

GitProviderType

Enumerazione

Tipo di provider Git. È possibile aggiungere altri tipi di provider nel tempo.

Valore	Descrizione
AzureDevOps	Provider Azure DevOps
GitHub	Provider GitHub

Condividi tramite

Git - Connect

Autorizzazioni

Ambiti delegati obbligatori

Limitazioni

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Connect a workspace to Azure DevOps example

Esempio di richiesta

Risposta di esempio

Connect a workspace to Azure DevOps using configured connection example

Esempio di richiesta

Risposta di esempio

Connect a workspace to GitHub example

Esempio di richiesta

Risposta di esempio

Definizioni

AutomaticGitCredentials

AzureDevOpsDetails

ConfiguredConnectionGitCredentials

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GitConnectRequest

GitCredentialsSource

GitHubDetails

GitProviderType