Workspaces - List Git Connections

Tjeneste:
Admin
API-versjon:
v1

Returnerer en liste over Git-tilkoblinger.

Note

Denne API-en er en del av en forhåndsversjon, og er bare tilgjengelig for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk.

Denne API-en støtter paginering. Maksimalt 1000 poster kan returneres per forespørsel. Med det kontinuerlige tokenet som er angitt i svaret, kan du få de neste 1000 postene.

Permissions

Innringeren må være en Fabric-administrator eller godkjenne ved hjelp av en tjenestekontohaver.

Nødvendige delegerte omfang

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maksimalt 25 forespørsler per minutt.

Microsoft Entra-støttede identiteter

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

Identity Support
User Yes
tjenestekontohaver og administrerte identiteter Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/discoverGitConnections
Med valgfrie parametere: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces/discoverGitConnections?continuationToken={continuationToken}

URI-parametere

Navn I Obligatorisk Type Beskrivelse
continuationToken
 query

string

Et token for å hente neste side med resultater.

Svar

Navn Type Beskrivelse
200 OK

GitConnections

Operasjonen var vellykket.
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • InsufficientPrivileges – Innringeren har ikke tillatelse til å kalle API-en.

Eksempler

Get a list of Git connections for tenant example

Eksempelforespørsel

GET https://api.fabric.microsoft.com/v1/admin/workspaces/discoverGitConnections

Eksempelsvar

Statuskode:
200 
{
  "value": [
    {
      "workspaceId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "gitProviderDetails": {
        "organizationName": "Test Organization",
        "projectName": "Test Project",
        "gitProviderType": "AzureDevOps",
        "repositoryName": "Test Repo",
        "branchName": "Test Branch",
        "directoryName": "/Test Directory"
      }
    },
    {
      "workspaceId": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
      "gitProviderDetails": {
        "ownerName": "Test Owner",
        "gitProviderType": "GitHub",
        "repositoryName": "Test Repo",
        "branchName": "Test Branch",
        "directoryName": "/"
      }
    },
    {
      "workspaceId": "e2c1a8b2-1234-4e56-9876-abcdef123456",
      "gitProviderDetails": {
        "ownerName": "Enterprise Org",
        "customDomainName": "my-enterprise.ghe.com",
        "gitProviderType": "GitHub",
        "repositoryName": "Enterprise Repo",
        "branchName": "main",
        "directoryName": "/Enterprise/Dir"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces/discoverGitConnections?continuationToken=eyJMYXN0U2VlbkNvbm5lY3Rpb25JZCI6NX0=",
  "continuationToken": "eyJMYXN0U2VlbkNvbm5lY3Rpb25JZCI6NX0="
}

Definisjoner

Navn Beskrivelse
AzureDevOpsDetails

Leverandørdetaljer for Azure DevOps.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
GitConnectionDetails

Representerer detaljene for en Git-tilkobling for et arbeidsområde.
GitConnections

En svarbryting for en liste over alle Git-tilkoblingene for en gitt leier med et kontinuerlig token.
GitHubDetails

GitHub-leverandørdetaljer.
GitProviderType

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

AzureDevOpsDetails

Objekt

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.

ErrorRelatedResource

Objekt

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

Objekt

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

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

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

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.

GitConnectionDetails

Objekt

Representerer detaljene for en Git-tilkobling for et arbeidsområde.

Navn Type Beskrivelse
gitProviderDetails GitProviderDetails:

Leverandørdetaljene.
workspaceId

string (uuid)

Arbeidsområde-ID-en.

GitConnections

Objekt

En svarbryting for en liste over alle Git-tilkoblingene for en gitt leier med et kontinuerlig token.

Navn Type Beskrivelse
continuationToken

string

Tokenet for den neste resultatsettgruppen. Hvis det ikke er flere poster, fjernes den fra svaret.
continuationUri

string

URI-en for neste satsvise resultatsett. Hvis det ikke er flere poster, fjernes den fra svaret.
value

GitConnectionDetails[]

Listen over Git-tilkoblinger for en gitt leier.

GitHubDetails

Objekt

GitHub-leverandørdetaljer.

Navn Type Beskrivelse
branchName

string

maxLength: 250

Grennavnet. Maksimal lengde er 250 tegn.
customDomainName

string

maxLength: 100

Navnet på virksomhetsdomenet GitHub hvis det ikke er github.com. Bare GitHub Enterprise med datalagringsdomener (ghe.com) støttes. Maksimal lengde er 100 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