Git - Connect

Service:
Core
Version d’API:
v1

Connectez un espace de travail spécifique à un dépôt git et à une branche.
Cette opération ne se synchronise pas entre l’espace de travail et la branche connectée. Pour terminer la synchronisation, utilisez l’opération Initialiser la connexion et suivez l’opération Commit To Git ou Update From Git .

Pour bien démarrer avec GitHub, consultez : Bien démarrer avec l’intégration de Git.

Pour obtenir l’ID de connexion, consultez Automatiser l’intégration git.

Autorisations

L’appelant doit avoir un rôle d’administrateur pour l’espace de travail.

Pour les informations d’identification Git de connexion configurées, l’appelant doit disposer de l’autorisation pour la connexion.

Étendues déléguées requises

Workspace.ReadWrite.All

Limites

Lorsque vous utilisez la source d’informations d’identification automatiques, cette API est bloquée pour le fournisseur GitHub et pour le principal de service.

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 Pris en charge uniquement lorsque myGitCredentials.source est ConfigureConnection

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

Nom Obligatoire Type Description
gitProviderDetails True GitProviderDetails:

Détails du fournisseur Git.
connectionSettings

GitConnectionSettings

Paramètres de connexion facultatifs à appliquer au moment de la connexion. S’il est omis, les valeurs par défaut s’appliquent.
myGitCredentials GitCredentials:

Informations d’identification Git spécifiques à l’utilisateur pour l’authentification auprès de GitProvider. Ces informations d’identification ne sont pas partagées avec d’autres contributeurs d’espace de travail. Pour GitHub, cette propriété est requise. Pour AzureDevOps, cette propriété est facultative. S’il n’est pas défini, la valeur par défaut est AutomaticGitCredentials.

Réponses

Nom Type Description
200 OK

La demande s’est terminée avec succès.
429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

  • WorkspaceAlreadyConnectedToGit : l’espace de travail est déjà connecté à git.

  • WorkspaceHasNoCapacityAssigned : aucune capacité affectée à l’espace de travail.

  • InsufficientPrivileges : l’appelant dispose d’autorisations d’espace de travail insuffisantes.

  • PrincipalTypeNotSupported : le type d’identité de l’appelant n’est pas pris en charge.

Exemples

Connect a workspace to Azure DevOps example
Connect a workspace to Azure DevOps using configured connection example
Connect a workspace to Azure DevOps with connection settings example
Connect a workspace to GitHub example
Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Connect a workspace to Azure DevOps example

Exemple de requête

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

Exemple de réponse

Code d’état:
200

Connect a workspace to Azure DevOps using configured connection example

Exemple de requête

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

Exemple de réponse

Code d’état:
200

Connect a workspace to Azure DevOps with connection settings example

Exemple de requête

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"
  },
  "connectionSettings": {
    "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
  }
}

Exemple de réponse

Code d’état:
200

Connect a workspace to GitHub example

Exemple de requête

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

Exemple de réponse

Code d’état:
200

Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Exemple de requête

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

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

Exemple de réponse

Code d’état:
200

Définitions

Nom Description
AutomaticGitCredentials

Informations d’identification Git automatiques.
AzureDevOpsDetails

Détails du fournisseur Azure DevOps.
ConfiguredConnectionGitCredentials

Informations d’identification Git de connexion configurées.
ErrorParameter

Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.
GitConnectionSettings

Contient les paramètres de connexion Git.
GitConnectRequest

Contient les données de demande de connexion Git.
GitCredentialsSource

Source des informations d’identification Git. Des sources d’informations d’identification Git supplémentaires peuvent être ajoutées 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.

AutomaticGitCredentials

Objet

Informations d’identification Git automatiques.

Nom Type Description
source string:

Automatic

Source des informations d’identification Git.

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.

ConfiguredConnectionGitCredentials

Objet

Informations d’identification Git de connexion configurées.

Nom Type Description
connectionId

string (uuid)

ID d’objet de la connexion.
source string:

ConfiguredConnection

Source des informations d’identification Git.

ErrorParameter

Objet

Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.

Nom Type Description
message

string

Description lisible par l’homme de la signification du paramètre.
name

string

L’identifiant de paramètre.
value

string

Représente la valeur du paramètre.

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.
isRetriable

boolean

Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête Retry-After de réponse pour déterminer le délai, le cas échéant.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

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

ErrorParameter[]

Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource

ErrorRelatedResource

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

string (uuid)

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.
parameters

ErrorParameter[]

Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource

ErrorRelatedResource

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

GitAdditionalBranchChangingRoles

Énumération

Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée. Des valeurs supplémentaires peuvent être ajoutées au fil du temps.

Valeur Description
None

Aucun rôle supplémentaire au-delà de l’administrateur ne peut modifier les branches. Il s’agit de la valeur par défaut.
MemberAndContributor

Les membres et les contributeurs peuvent également modifier les branches en plus des administrateurs.

GitConnectionSettings

Objet

Contient les paramètres de connexion Git.

Nom Type Description
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

Les rôles d’espace de travail supplémentaires au-delà de l’administrateur autorisés à modifier la branche Git connectée.

GitConnectRequest

Objet

Contient les données de demande de connexion Git.

Nom Type Description
connectionSettings

GitConnectionSettings

Paramètres de connexion facultatifs à appliquer au moment de la connexion. S’il est omis, les valeurs par défaut s’appliquent.
gitProviderDetails GitProviderDetails:

Détails du fournisseur Git.
myGitCredentials GitCredentials:

Informations d’identification Git spécifiques à l’utilisateur pour l’authentification auprès de GitProvider. Ces informations d’identification ne sont pas partagées avec d’autres contributeurs d’espace de travail. Pour GitHub, cette propriété est requise. Pour AzureDevOps, cette propriété est facultative. S’il n’est pas défini, la valeur par défaut est AutomaticGitCredentials.

GitCredentialsSource

Énumération

Source des informations d’identification Git. Des sources d’informations d’identification Git supplémentaires peuvent être ajoutées au fil du temps.

Valeur Description
ConfiguredConnection

Les informations d’identification Git sont obtenues via une connexion configurée.
Automatic

Les informations d’identification Git sont obtenues automatiquement par le système, à l’aide des informations d’identification par défaut si elles sont disponibles.
None

Les informations d’identification Git ne sont pas configurées.

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

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