Del via

Git - Connect

Tjeneste:
Core
API-versjon:
v1

Koble et bestemt arbeidsområde til et git-repositorium og en gren.
Denne operasjonen synkroniseres ikke mellom arbeidsområdet og den tilkoblede grenen. Hvis du vil fullføre synkroniseringen, bruker du Initialiser tilkobling-operasjonen og følger med operasjonen Utfør til Git eller Oppdater fra Git .

Hvis du vil komme i gang med GitHub, kan du se: Komme i gang med Git-integrering.

Hvis du vil ha tilkoblings-ID-en, kan du se Automatiser Git-integrasjon.

Tillatelser

Innringeren må ha en administratorrolle for arbeidsområdet.

For konfigurert git-legitimasjon for tilkobling må anroperen ha tillatelse til tilkoblingen.

Nødvendige delegerte omfang

Workspace.ReadWrite.All

Begrensninger

Når du bruker automatisk legitimasjonskilde, blokkeres denne API-en for GitHub-leverandøren og for tjenestekontohaver.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet Støtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Støttes bare når myGitCredentials.source er ConfiguredConnection

Grensesnitt

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn Obligatorisk Type Beskrivelse
gitProviderDetails True GitProviderDetails:

Git-leverandørdetaljene.
myGitCredentials GitCredentials:

Brukerspesifikk Git-legitimasjon for godkjenning til GitProvider. Denne legitimasjonen deles ikke med andre bidragsytere for arbeidsområdet. For GitHub kreves denne egenskapen. For AzureDevOps er denne egenskapen valgfri. Hvis ikke angitt, er standarden AutomaticGitCredentials.

Svar

Navn Type Beskrivelse
200 OK

Forespørselen er fullført.
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • UnknownError - Det oppstod en feil.

  • WorkspaceAlreadyConnectedToGit – arbeidsområdet er allerede koblet til git.

  • WorkspaceHasNoCapacityAssigned – ingen kapasitet tilordnet til arbeidsområdet.

  • InsufficientPrivileges – innringeren har ikke tilstrekkelige arbeidsområdetillatelser.

  • PrincipalTypeNotSupported – identitetstypen Anroper stø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

Eksempelforespørsel

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

Eksempelforespørsel

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

Eksempelforespørsel

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

Definisjoner

Navn Beskrivelse
AutomaticGitCredentials

Automatisk Git-legitimasjon.
AzureDevOpsDetails

Leverandørdetaljer for Azure DevOps.
ConfiguredConnectionGitCredentials

Konfigurert git-legitimasjon for tilkobling.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
GitConnectRequest

Inneholder forespørselsdataene for Git-tilkobling.
GitCredentialsSource

Git-legitimasjonskilden. Flere git-legitimasjonskilder kan legges til over tid.
GitHubDetails

GitHub-leverandørdetaljer.
GitProviderType

En Git-leverandørtype. Flere leverandørtyper kan legges til over tid.

AutomaticGitCredentials

Object

Automatisk Git-legitimasjon.

Navn Type Beskrivelse
source string:

Automatic

Git-legitimasjonskilden.

AzureDevOpsDetails

Object

Leverandørdetaljer for Azure DevOps.

Navn Type Beskrivelse
branchName

string

maxLength: 250

Grennavnet. Maksimal lengde er 250 tegn.
directoryName

string

maxLength: 256

Den relative banen til katalogen. Maksimal lengde er 256 tegn.
gitProviderType string:

AzureDevOps

En Git-leverandørtype. Flere leverandørtyper kan legges til over tid.
organizationName

string

maxLength: 100

Organisasjonsnavnet. Maksimal lengde er 100 tegn.
projectName

string

maxLength: 100

Prosjektnavnet. Maksimal lengde er 100 tegn.
repositoryName

string

maxLength: 128

Repositoriumnavnet. Maksimal lengde er 128 tegn.

ConfiguredConnectionGitCredentials

Object

Konfigurert git-legitimasjon for tilkobling.

Navn Type Beskrivelse
connectionId

string (uuid)

Objekt-ID-en for tilkoblingen.
source string:

ConfiguredConnection

Git-legitimasjonskilden.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

GitConnectRequest

Object

Inneholder forespørselsdataene for Git-tilkobling.

Navn Type Beskrivelse
gitProviderDetails GitProviderDetails:

Git-leverandørdetaljene.
myGitCredentials GitCredentials:

Brukerspesifikk Git-legitimasjon for godkjenning til GitProvider. Denne legitimasjonen deles ikke med andre bidragsytere for arbeidsområdet. For GitHub kreves denne egenskapen. For AzureDevOps er denne egenskapen valgfri. Hvis ikke angitt, er standarden AutomaticGitCredentials.

GitCredentialsSource

Opplisting

Git-legitimasjonskilden. Flere git-legitimasjonskilder kan legges til over tid.

Verdi Beskrivelse
ConfiguredConnection

Git-legitimasjonen hentes via en konfigurert tilkobling.
Automatic

Git-legitimasjonen hentes automatisk av systemet ved hjelp av standardlegitimasjon hvis tilgjengelig.
None

Git-legitimasjonen er ikke konfigurert.

GitHubDetails

Object

GitHub-leverandørdetaljer.

Navn Type Beskrivelse
branchName

string

maxLength: 250

Grennavnet. Maksimal lengde er 250 tegn.
directoryName

string

maxLength: 256

Den relative banen til katalogen. Maksimal lengde er 256 tegn.
gitProviderType string:

GitHub

En Git-leverandørtype. Flere leverandørtyper kan legges til over tid.
ownerName

string

maxLength: 100

Eiernavnet. Maksimal lengde er 100 tegn.
repositoryName

string

maxLength: 128

Repositoriumnavnet. Maksimal lengde er 128 tegn.

GitProviderType

Opplisting

En Git-leverandørtype. Flere leverandørtyper kan legges til over tid.

Verdi Beskrivelse
AzureDevOps

Azure DevOps-leverandør
GitHub

GitHub-leverandør