Git - Connect

Tjeneste:: Core

API-version:: v1

Opret forbindelse mellem et bestemt arbejdsområde og et git-lager og en forgrening.
Denne handling synkroniseres ikke mellem arbejdsområdet og den forbundne forgrening. Hvis du vil fuldføre synkroniseringen, skal du bruge handlingen Initialiser forbindelse og følge med handlingen Bekræft til Git eller Opdater fra Git .

Hvis du vil i gang med GitHub, skal du se: Kom i gang med Git-integration.

Hvis du vil hente forbindelses-id'et, skal du se Automatiser Git-integration.

Tilladelser

Den, der ringer op, skal have en administratorrolle for arbejdsområdet.

Hvis Git-legitimationsoplysningerne for konfigureret forbindelse er konfigureret, skal den, der ringer op, have tilladelse til forbindelsen.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Begrænsninger

Når du bruger kilden til automatiske legitimationsoplysninger, blokeres denne API for GitHub-udbyderen og tjenesteprincipalen.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Understøttes kun, når myGitCredentials.source er ConfiguredConnection

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
gitProviderDetails	True	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Oplysninger om Git-udbyderen.
myGitCredentials		GitCredentials: ConfiguredConnectionGitCredentials AutomaticGitCredentials	Brugerspecifikke Git-legitimationsoplysninger til godkendelse til GitProvider. Disse legitimationsoplysninger deles ikke med andre bidragydere til arbejdsområdet. Denne egenskab er påkrævet for GitHub. For AzureDevOps er denne egenskab valgfri. Hvis den ikke er angivet, er standarden AutomaticGitCredentials.

Svar

Name	Type	Beskrivelse
200 OK		Anmodningen blev fuldført.
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl. WorkspaceAlreadyConnectedToGit – Arbejdsområdet er allerede forbundet til git. WorkspaceHasNoCapacityAssigned – Der er ikke tildelt nogen kapacitet til arbejdsområdet. InsufficientPrivileges – Kalderen har ikke tilstrækkelige tilladelser til arbejdsområdet. PrincipalTypeNotSupported – Opkaldsidentitetstypen understøttes ikke.

Name

Type

Beskrivelse

200 OK

Anmodningen blev fuldført.

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.
WorkspaceAlreadyConnectedToGit – Arbejdsområdet er allerede forbundet til git.
WorkspaceHasNoCapacityAssigned – Der er ikke tildelt nogen kapacitet til arbejdsområdet.
InsufficientPrivileges – Kalderen har ikke tilstrækkelige tilladelser til arbejdsområdet.
PrincipalTypeNotSupported – Opkaldsidentitetstypen understøttes ikke.

Eksempler

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

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 200

Connect a workspace to Azure DevOps using configured connection example

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 200

Connect a workspace to GitHub example

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 200

Definitioner

Name	Beskrivelse
AutomaticGitCredentials	Automatiske Git-legitimationsoplysninger.
AzureDevOpsDetails	Oplysninger om Azure DevOps-udbyder.
ConfiguredConnectionGitCredentials	Git-legitimationsoplysninger for konfigureret forbindelse.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GitConnectRequest	Indeholder anmodningsdataene for Git Connect.
GitCredentialsSource	Kilden med Git-legitimationsoplysninger. Der kan tilføjes flere Git-legitimationsoplysninger over tid.
GitHubDetails	Oplysninger om GitHub-provider.
GitProviderType	En Git-providertype. Der kan tilføjes flere providertyper over tid.

AutomaticGitCredentials

Object

Automatiske Git-legitimationsoplysninger.

Name	Type	Beskrivelse
source	string: Automatic	Kilden med Git-legitimationsoplysninger.

AzureDevOpsDetails

Object

Oplysninger om Azure DevOps-udbyder.

Name	Type	Beskrivelse
branchName	string maxLength: 250	Forgreningsnavnet. Maksimumlængden er 250 tegn.
directoryName	string maxLength: 256	Den relative sti til mappen. Maksimumlængden er 256 tegn.
gitProviderType	string: AzureDevOps	En Git-providertype. Der kan tilføjes flere providertyper over tid.
organizationName	string maxLength: 100	Organisationsnavnet. Maksimumlængden er 100 tegn.
projectName	string maxLength: 100	Projektnavnet. Maksimumlængden er 100 tegn.
repositoryName	string maxLength: 128	Navnet på lageret. Maksimumlængden er 128 tegn.

ConfiguredConnectionGitCredentials

Object

Git-legitimationsoplysninger for konfigureret forbindelse.

Name	Type	Beskrivelse
connectionId	string (uuid)	Objekt-id'et for forbindelsen.
source	string: ConfiguredConnection	Kilden med Git-legitimationsoplysninger.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GitConnectRequest

Object

Indeholder anmodningsdataene for Git Connect.

Name	Type	Beskrivelse
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Oplysninger om Git-udbyderen.
myGitCredentials	GitCredentials: AutomaticGitCredentials ConfiguredConnectionGitCredentials	Brugerspecifikke Git-legitimationsoplysninger til godkendelse til GitProvider. Disse legitimationsoplysninger deles ikke med andre bidragydere til arbejdsområdet. Denne egenskab er påkrævet for GitHub. For AzureDevOps er denne egenskab valgfri. Hvis den ikke er angivet, er standarden AutomaticGitCredentials.

GitCredentialsSource

Optælling

Kilden med Git-legitimationsoplysninger. Der kan tilføjes flere Git-legitimationsoplysninger over tid.

Værdi	Beskrivelse
ConfiguredConnection	Git-legitimationsoplysningerne hentes via en konfigureret forbindelse.
Automatic	Git-legitimationsoplysningerne hentes automatisk af systemet ved hjælp af standardlegitimationsoplysninger, hvis de er tilgængelige.
None	Git-legitimationsoplysningerne er ikke konfigureret.

GitHubDetails

Object

Oplysninger om GitHub-provider.

Name	Type	Beskrivelse
branchName	string maxLength: 250	Forgreningsnavnet. Maksimumlængden er 250 tegn.
directoryName	string maxLength: 256	Den relative sti til mappen. Maksimumlængden er 256 tegn.
gitProviderType	string: GitHub	En Git-providertype. Der kan tilføjes flere providertyper over tid.
ownerName	string maxLength: 100	Ejerens navn. Maksimumlængden er 100 tegn.
repositoryName	string maxLength: 128	Navnet på lageret. Maksimumlængden er 128 tegn.

GitProviderType

Optælling

En Git-providertype. Der kan tilføjes flere providertyper over tid.

Værdi	Beskrivelse
AzureDevOps	Azure DevOps-udbyder
GitHub	GitHub-udbyder

Del via

Git - Connect

Tilladelser

Påkrævede delegerede områder

Begrænsninger

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Brødtekst for anmodning

Svar

Eksempler

Connect a workspace to Azure DevOps example

Eksempelanmodning

Eksempelsvar

Connect a workspace to Azure DevOps using configured connection example

Eksempelanmodning

Eksempelsvar

Connect a workspace to GitHub example

Eksempelanmodning

Eksempelsvar

Definitioner

AutomaticGitCredentials

AzureDevOpsDetails

ConfiguredConnectionGitCredentials

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GitConnectRequest

GitCredentialsSource

GitHubDetails

GitProviderType