Git - Get Connection

Tjeneste:

Core

API-version:

v1

Returnerer oplysninger om git-forbindelse for det angivne arbejdsområde.

Tilladelser

Den, der ringer op, skal have en bidragyder eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

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	Ja

Grænseflade

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

URI-parametre

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

Svar

Name	Type	Beskrivelse
200 OK	GitConnection	Anmodningen blev fuldført.
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl. InsufficientPrivileges – Den kaldende bruger har ikke tilstrækkelige tilladelser til arbejdsområdet.

Eksempler

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:

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

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:

200

{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

Definitioner

Name	Beskrivelse
AzureDevOpsDetails	Oplysninger om Azure DevOps-udbyder.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GitConnection	Indeholder oplysninger om Git-forbindelsen.
GitConnectionState	Git-forbindelsestilstand. Der kan tilføjes flere forbindelsestilstandstyper over tid.
GitHubDetails	Oplysninger om GitHub-provider.
GitProviderType	En Git-providertype. Der kan tilføjes flere providertyper over tid.
GitSyncDetails	Indeholder synkroniseringsoplysningerne.

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.

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.

GitConnection

Object

Indeholder oplysninger om Git-forbindelsen.

Name	Type	Beskrivelse
gitConnectionState	GitConnectionState	Git-forbindelsestilstand. Der kan tilføjes flere forbindelsestilstandstyper over tid.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Oplysninger om Git-udbyderen.
gitSyncDetails	GitSyncDetails	Indeholder synkroniseringsoplysningerne.

GitConnectionState

Optælling

Git-forbindelsestilstand. Der kan tilføjes flere forbindelsestilstandstyper over tid.

Værdi	Beskrivelse
NotConnected	Ikke forbundet tilstand.
Connected	Tilsluttet tilstand.
ConnectedAndInitialized	Tilsluttet og initialiseret tilstand.

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

GitSyncDetails

Object

Indeholder synkroniseringsoplysningerne.

Name	Type	Beskrivelse
head	string	Den fulde Secure Hash Algorithm 1 (SHA-1) for det synkroniserede bekræftelses-id.
lastSyncTime	string (date-time)	Dato og klokkeslæt for seneste synkroniseringstilstand.