Condividi tramite

Git - Get Connection

Servizio:
Core
Versione API:
v1

Restituisce i dettagli della connessione Git per l'area di lavoro specificata.

Autorizzazioni

Il chiamante deve avere un ruolo di collaboratore o superiore dell'area di lavoro.

Ambiti delegati obbligatori

Workspace.Read.All o Workspace.ReadWrite.All

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 Sì

Interfaccia

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connection

Parametri dell'URI

Nome In Necessario Tipo Descrizione
workspaceId
 path True

string (uuid)

ID dell'area di lavoro.

Risposte

Nome Tipo Descrizione
200 OK

GitConnection

Richiesta completata correttamente.
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • UnknownError: si è verificato un errore.

  • InsufficientPrivileges: il chiamante non dispone di autorizzazioni sufficienti per l'area di lavoro.

Esempio

Get Git connection details example
Workspace not connected to git example

Get Git connection details example

Esempio di richiesta

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Risposta di esempio

Codice di stato:
200 
{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": ""
  },
  "gitSyncDetails": {
    "head": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
    "lastSyncTime": "2021-11-20T09:26:43.153"
  },
  "gitConnectionState": "ConnectedAndInitialized"
}

Workspace not connected to git example

Esempio di richiesta

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

Risposta di esempio

Codice di stato:
200 
{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Definizioni

Nome Descrizione
AzureDevOpsDetails

Dettagli del provider Azure DevOps.
ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
GitConnection

Contiene i dettagli della connessione Git.
GitConnectionState

Stato della connessione Git. È possibile aggiungere altri tipi di stato di connessione nel tempo.
GitHubDetails

Dettagli del provider GitHub.
GitProviderType

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

Contiene i dettagli di sincronizzazione.

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.

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.

GitConnection

Object

Contiene i dettagli della connessione Git.

Nome Tipo Descrizione
gitConnectionState

GitConnectionState

Stato della connessione Git. È possibile aggiungere altri tipi di stato di connessione nel tempo.
gitProviderDetails GitProviderDetails:

Dettagli del provider Git.
gitSyncDetails

GitSyncDetails

Contiene i dettagli di sincronizzazione.

GitConnectionState

Enumerazione

Stato della connessione Git. È possibile aggiungere altri tipi di stato di connessione nel tempo.

Valore Descrizione
NotConnected

Stato non connesso.
Connected

Stato connesso.
ConnectedAndInitialized

Stato connesso e inizializzato.

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

GitSyncDetails

Object

Contiene i dettagli di sincronizzazione.

Nome Tipo Descrizione
head

string

Full Secure Hash Algorithm 1 (SHA-1) dell'ID commit sincronizzato.
lastSyncTime

string (date-time)

Data e ora dell'ultimo stato di sincronizzazione.