Partager via

Git - Get Connection

Service:
Core
Version de l’API:
v1

Retourne les détails de connexion Git pour l’espace de travail spécifié.

Autorisations

L’appelant doit avoir un contributeur ou un rôle d’espace de travail supérieur.

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
principal de service et identités managées Oui

Interface

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

Paramètres d’URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Réponses

Nom Type Description
200 OK

GitConnection

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

  • InsufficientPrivileges : l’appelant ne dispose pas des autorisations d’espace de travail suffisantes.

Exemples

Get Git connection details example
Workspace not connected to git example

Get Git connection details example

Demande d’échantillon

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

Exemple de réponse

Code d’état:
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

Demande d’échantillon

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

Exemple de réponse

Code d’état:
200 
{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Définitions

Nom Description
AzureDevOpsDetails

Détails du fournisseur Azure DevOps.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
GitConnection

Contient les détails de la connexion Git.
GitConnectionState

État de connexion Git. Des types d’état de connexion supplémentaires peuvent être ajoutés au fil du temps.
GitHubDetails

Détails du fournisseur GitHub.
GitProviderType

Type de fournisseur Git. Des types de fournisseurs supplémentaires peuvent être ajoutés au fil du temps.
GitSyncDetails

Contient les détails de synchronisation.

AzureDevOpsDetails

Objet

Détails du fournisseur Azure DevOps.

Nom Type Description
branchName

string

maxLength: 250

Nom de la branche. La longueur maximale est de 250 caractères.
directoryName

string

maxLength: 256

Chemin d’accès relatif au répertoire. La longueur maximale est de 256 caractères.
gitProviderType string:

AzureDevOps

Type de fournisseur Git. Des types de fournisseurs supplémentaires peuvent être ajoutés au fil du temps.
organizationName

string

maxLength: 100

Nom de l’organisation. La longueur maximale est de 100 caractères.
projectName

string

maxLength: 100

Nom du projet. La longueur maximale est de 100 caractères.
repositoryName

string

maxLength: 128

Nom du référentiel. La longueur maximale est de 128 caractères.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

GitConnection

Objet

Contient les détails de la connexion Git.

Nom Type Description
gitConnectionState

GitConnectionState

État de connexion Git. Des types d’état de connexion supplémentaires peuvent être ajoutés au fil du temps.
gitProviderDetails GitProviderDetails:

Détails du fournisseur Git.
gitSyncDetails

GitSyncDetails

Contient les détails de synchronisation.

GitConnectionState

Énumération

État de connexion Git. Des types d’état de connexion supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
NotConnected

État non connecté.
Connected

État connecté.
ConnectedAndInitialized

État connecté et initialisé.

GitHubDetails

Objet

Détails du fournisseur GitHub.

Nom Type Description
branchName

string

maxLength: 250

Nom de la branche. La longueur maximale est de 250 caractères.
customDomainName

string

maxLength: 100

Note

La prise en charge de GitHub Enterprise avec résidence des données (ghe.com) est actuellement en préversion. (en savoir plus).

Nom du domaine github d’entreprise s’il n’est pas github.com. Seuls GitHub Enterprise avec des domaines de résidence de données (ghe.com) sont pris en charge. La longueur maximale est de 100 caractères.
directoryName

string

maxLength: 256

Chemin d’accès relatif au répertoire. La longueur maximale est de 256 caractères.
gitProviderType string:

GitHub

Type de fournisseur Git. Des types de fournisseurs supplémentaires peuvent être ajoutés au fil du temps.
ownerName

string

maxLength: 100

Nom du propriétaire. La longueur maximale est de 100 caractères.
repositoryName

string

maxLength: 128

Nom du référentiel. La longueur maximale est de 128 caractères.

GitProviderType

Énumération

Type de fournisseur Git. Des types de fournisseurs supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
AzureDevOps

Fournisseur Azure DevOps
GitHub

Fournisseur GitHub

GitSyncDetails

Objet

Contient les détails de synchronisation.

Nom Type Description
head

string

Algorithme de hachage sécurisé complet 1 (SHA-1) de l’ID de validation synchronisé.
lastSyncTime

string (date-time)

Date et heure de la dernière synchronisation.