Git - Get Connection

Service:

Core

API-versie:

v1

Retourneert git-verbindingsgegevens voor de opgegeven werkruimte.

Machtigingen

De aanroeper moet een inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

Workspace.Read.All of Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

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

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

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

URI-parameters

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

Antwoorden

Name	Type	Description
200 OK	GitConnection	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden. InsufficientPrivileges : de aanroeper beschikt niet over voldoende werkruimtemachtigingen.

Voorbeelden

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
AzureDevOpsDetails	Azure DevOps-providerdetails.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GitConnection	Bevat de Details van de Git-verbinding.
GitConnectionState	Git-verbindingsstatus. Er kunnen in de loop van de tijd extra verbindingsstatustypen worden toegevoegd.
GitHubDetails	Details van GitHub-provider.
GitProviderType	Een Git-providertype. Er kunnen in de loop van de tijd extra providertypen worden toegevoegd.
GitSyncDetails	Bevat de synchronisatiedetails.

AzureDevOpsDetails

Object

Azure DevOps-providerdetails.

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

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

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

Name	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.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	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.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GitConnection

Object

Bevat de Details van de Git-verbinding.

Name	Type	Description
gitConnectionState	GitConnectionState	Git-verbindingsstatus. Er kunnen in de loop van de tijd extra verbindingsstatustypen worden toegevoegd.
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Details van de Git-provider.
gitSyncDetails	GitSyncDetails	Bevat de synchronisatiedetails.

GitConnectionState

Inventarisatie

Git-verbindingsstatus. Er kunnen in de loop van de tijd extra verbindingsstatustypen worden toegevoegd.

Waarde	Description
Connected	Verbonden status.
ConnectedAndInitialized	Verbonden en geïnitialiseerde status.
NotConnected	Niet verbonden status.

GitHubDetails

Object

Details van GitHub-provider.

Name	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: 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

Inventarisatie

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

Waarde	Description
AzureDevOps	Azure DevOps-provider
GitHub	GitHub-provider

GitSyncDetails

Object

Bevat de synchronisatiedetails.

Name	Type	Description
head	string	Het volledige Secure Hash Algorithm 1 (SHA-1) van de gesynchroniseerde doorvoer-id.
lastSyncTime	string (date-time)	De datum en tijd van de laatste synchronisatiestatus.