Git - Connect

Service:: Core

API-versie:: v1

Een specifieke werkruimte verbinden met een Git-opslagplaats en -vertakking.
Deze bewerking wordt niet gesynchroniseerd tussen de werkruimte en de verbonden vertakking. Als u de synchronisatie wilt voltooien, gebruikt u de bewerking Verbinding initialiseren en volgt u de bewerking Doorvoeren naar Git of Bijwerken vanuit Git .

Zie: Aan de slag met Git-integratie om aan de slag te gaan met GitHub.

Zie Git-integratie automatiseren om de verbindings-id op te halen.

Machtigingen

De beller moet een beheerdersrol hebben voor de werkruimte.

Voor geconfigureerde Git-referenties voor de verbinding moet de aanroeper gemachtigd zijn voor de verbinding.

Vereiste gedelegeerde bereiken

Workspace.ReadWrite.All

Beperkingen

Wanneer u de bron voor automatische referenties gebruikt, wordt deze API geblokkeerd voor de GitHub-provider en voor de service-principal.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Alleen ondersteund wanneer myGitCredentials.source is GeconfigureerdConnection

gebruikersinterface

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

URI-parameters

Naam	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-id.

Aanvraagbody

Naam	Vereist	Type	Description
gitProviderDetails	True	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Details van de Git-provider.
connectionSettings		GitConnectionSettings	Optionele verbindingsinstellingen die moeten worden toegepast op het tijdstip van de verbinding. Als u dit weglaat, zijn de standaardwaarden van toepassing.
myGitCredentials		GitCredentials: ConfiguredConnectionGitCredentials AutomaticGitCredentials	Gebruikersspecifieke Git-referenties voor verificatie bij de GitProvider. Deze referenties worden niet gedeeld met andere inzenders voor werkruimten. Voor GitHub is deze eigenschap vereist. Voor AzureDevOps is deze eigenschap optioneel. Als dit niet is ingesteld, is de standaardwaarde AutomaticGitCredentials.

Antwoorden

Naam Type Description

200 OK

Naam	Type	Description
200 OK		De aanvraag is voltooid.
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden. WorkspaceAlreadyConnectedToGit - Werkruimte is al verbonden met Git. WorkspaceHasNoCapacityAssigned : er is geen capaciteit toegewezen aan de werkruimte. InsufficientPrivileges - Aanroeper heeft onvoldoende werkruimtemachtigingen. PrincipalTypeNotSupported - Identiteitstype beller wordt niet ondersteund.

De aanvraag is voltooid.

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError: er is een fout opgetreden.
WorkspaceAlreadyConnectedToGit - Werkruimte is al verbonden met Git.
WorkspaceHasNoCapacityAssigned : er is geen capaciteit toegewezen aan de werkruimte.
InsufficientPrivileges - Aanroeper heeft onvoldoende werkruimtemachtigingen.
PrincipalTypeNotSupported - Identiteitstype beller wordt niet ondersteund.

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

Connect a workspace to Azure DevOps using configured connection example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

Connect a workspace to Azure DevOps with connection settings example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

Connect a workspace to GitHub example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

Definities

Naam	Description
AutomaticGitCredentials	Automatische Git-referenties.
AzureDevOpsDetails	Azure DevOps-providerdetails.
ConfiguredConnectionGitCredentials	Geconfigureerde Git-referenties voor verbinding.
ErrorParameter	Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GitAdditionalBranchChangingRoles	De extra werkruimterollen buiten de beheerder die de verbonden Git-vertakking mogen wijzigen. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.
GitConnectionSettings	Bevat de Git-verbindingsinstellingen.
GitConnectRequest	Bevat de gegevens van de Git Connect-aanvraag.
GitCredentialsSource	De Git-referentiebron. Er kunnen na verloop van tijd extra Git-referentiesbronnen worden toegevoegd.
GitHubDetails	Details van GitHub-provider.
GitProviderType	Een Git-providertype. Er kunnen in de loop van de tijd extra providertypen worden toegevoegd.

AutomaticGitCredentials

Object

Automatische Git-referenties.

Naam	Type	Description
source	string: Automatic	De Git-referentiebron.

AzureDevOpsDetails

Object

Azure DevOps-providerdetails.

Naam	Type	Description
branchName	string maxLength: 250	De naam van de vertakking. De maximale lengte is 250 tekens.
directoryName	string maxLength: 256	Het relatieve pad naar de map. De maximale lengte is 256 tekens.
gitProviderType	string: AzureDevOps	Een Git-providertype. Er kunnen in de loop van de tijd extra providertypen worden toegevoegd.
organizationName	string maxLength: 100	De naam van de organisatie. De maximale lengte is 100 tekens.
projectName	string maxLength: 100	De projectnaam. De maximale lengte is 100 tekens.
repositoryName	string maxLength: 128	De naam van de opslagplaats. De maximale lengte is 128 tekens.

ConfiguredConnectionGitCredentials

Object

Geconfigureerde Git-referenties voor verbinding.

Naam	Type	Description
connectionId	string (uuid)	De object-id van de verbinding.
source	string: ConfiguredConnection	De Git-referentiebron.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam	Type	Description
message	string	Een door mensen leesbare beschrijving van de betekenis van de parameter.
name	string	De parameter-id.
value	string	De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GitAdditionalBranchChangingRoles

Opsomming

De extra werkruimterollen buiten de beheerder die de verbonden Git-vertakking mogen wijzigen. Er kunnen in de loop van de tijd extra waarden worden toegevoegd.

Waarde	Description
None	Geen extra rollen buiten de beheerder kunnen vertakkingen wijzigen. Dit is de standaardwaarde.
MemberAndContributor	Leden en inzenders kunnen naast beheerders ook vertakkingen wijzigen.

GitConnectionSettings

Object

Bevat de Git-verbindingsinstellingen.

Naam	Type	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	De extra werkruimterollen buiten de beheerder die de verbonden Git-vertakking mogen wijzigen.

GitConnectRequest

Object

Bevat de gegevens van de Git Connect-aanvraag.

Naam	Type	Description
connectionSettings	GitConnectionSettings	Optionele verbindingsinstellingen die moeten worden toegepast op het tijdstip van de verbinding. Als u dit weglaat, zijn de standaardwaarden van toepassing.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Details van de Git-provider.
myGitCredentials	GitCredentials: AutomaticGitCredentials ConfiguredConnectionGitCredentials	Gebruikersspecifieke Git-referenties voor verificatie bij de GitProvider. Deze referenties worden niet gedeeld met andere inzenders voor werkruimten. Voor GitHub is deze eigenschap vereist. Voor AzureDevOps is deze eigenschap optioneel. Als dit niet is ingesteld, is de standaardwaarde AutomaticGitCredentials.

GitCredentialsSource

Opsomming

De Git-referentiebron. Er kunnen na verloop van tijd extra Git-referentiesbronnen worden toegevoegd.

Waarde	Description
ConfiguredConnection	De Git-referenties worden verkregen via een geconfigureerde verbinding.
Automatic	De Git-referenties worden automatisch door het systeem verkregen met behulp van standaardreferenties, indien beschikbaar.
None	De Git-referenties zijn niet geconfigureerd.

GitHubDetails

Object

Details van GitHub-provider.

Naam	Type	Description
branchName	string maxLength: 250	De naam van de vertakking. De maximale lengte is 250 tekens.
customDomainName	string maxLength: 100	De naam van het ondernemingsdomein GitHub als dit niet github.com is. Alleen GitHub Enterprise met gegevenslocatiedomeinen (ghe.com) worden ondersteund. De maximale lengte is 100 tekens.
directoryName	string maxLength: 256	Het relatieve pad naar de map. De maximale lengte is 256 tekens.
gitProviderType	string: GitHub	Een Git-providertype. Er kunnen in de loop van de tijd extra providertypen worden toegevoegd.
ownerName	string maxLength: 100	De naam van de eigenaar. De maximale lengte is 100 tekens.
repositoryName	string maxLength: 128	De naam van de opslagplaats. De maximale lengte is 128 tekens.

GitProviderType

Opsomming

Een Git-providertype. Er kunnen in de loop van de tijd extra providertypen worden toegevoegd.

Waarde	Description
AzureDevOps	Azure DevOps-provider
GitHub	GitHub-provider