Bagikan melalui


Git - Connect

Sambungkan ruang kerja tertentu ke repositori dan cabang git.
Operasi ini tidak disinkronkan antara ruang kerja dan cabang yang tersambung. Untuk menyelesaikan sinkronisasi, gunakan operasi Inisialisasi Koneksi dan ikuti dengan operasi Terapkan Ke Git atau Perbarui Dari Git .

Untuk mulai menggunakan GitHub, lihat: Mulai menggunakan integrasi Git.

Untuk mendapatkan ID koneksi, lihat Mengotomatiskan integrasi Git.

Hak akses

Pemanggil harus memiliki peran admin untuk ruang kerja.

Untuk kredensial Git koneksi yang dikonfigurasi, pemanggil harus memiliki izin untuk koneksi.

Cakupan yang Didelegasikan yang Diperlukan

Workspace.ReadWrite.All

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas Dukungan
Pengguna Ya
Prinsipal Layanan dan Identitas Terkelola Tidak didukung ketika penyedia Git adalah AzureDevOps dan kredensial adalah Otomatis

Antarmuka

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
workspaceId
path True

string (uuid)

ID ruangkerja.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
gitProviderDetails True GitProviderDetails:

Detail penyedia Git.

myGitCredentials GitCredentials:

Kredensial Git khusus pengguna untuk autentikasi ke GitProvider. Kredensial ini tidak dibagikan dengan kontributor ruang kerja lainnya. Untuk GitHub, properti ini diperlukan. Untuk AzureDevOps, properti ini bersifat opsional. Jika tidak diatur, defaultnya adalah AutomaticGitCredentials.

Respons

Nama Jenis Deskripsi
200 OK

Permintaan berhasil diselesaikan.

Other Status Codes

ErrorResponse

Kode kesalahan umum:

  • UnknownError - Terjadi kesalahan.

  • WorkspaceAlreadyConnectedToGit - Ruang kerja sudah tersambung ke git.

  • WorkspaceHasNoCapacityAssigned - Tidak ada kapasitas yang ditetapkan ke ruang kerja.

  • InsufficientPrivileges - Penelepon memiliki izin ruang kerja yang tidak memadai.

  • PrincipalTypeNotSupported - Jenis identitas pemanggil tidak didukung.

Contoh

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

Permintaan sampel

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

Respon sampel

Connect a workspace to Azure DevOps using configured connection example

Permintaan sampel

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

Respon sampel

Connect a workspace to GitHub example

Permintaan sampel

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

Respon sampel

Definisi

Nama Deskripsi
AutomaticGitCredentials

Kredensial Git otomatis.

AzureDevOpsDetails

Detail penyedia Azure DevOps.

ConfiguredConnectionGitCredentials

Kredensial Git koneksi yang dikonfigurasi.

ErrorRelatedResource

Objek detail sumber daya terkait kesalahan.

ErrorResponse

Respons kesalahan.

ErrorResponseDetails

Detail respons kesalahan.

GitConnectRequest

Berisi data permintaan sambungkan Git.

GitCredentialsSource

Sumber kredensial Git. Sumber kredensial Git tambahan dapat ditambahkan dari waktu ke waktu.

GitHubDetails

Detail penyedia GitHub.

GitProviderType

Jenis penyedia Git. Jenis penyedia tambahan dapat ditambahkan dari waktu ke waktu.

AutomaticGitCredentials

Kredensial Git otomatis.

Nama Jenis Deskripsi
source string:

Automatic

Sumber kredensial Git.

AzureDevOpsDetails

Detail penyedia Azure DevOps.

Nama Jenis Deskripsi
branchName

string

maxLength: 250

Nama cabang. Panjang maksimum adalah 250 karakter.

directoryName

string

maxLength: 256

Jalur relatif ke direktori. Panjang maksimum adalah 256 karakter.

gitProviderType string:

AzureDevOps

Jenis penyedia Git. Jenis penyedia tambahan dapat ditambahkan dari waktu ke waktu.

organizationName

string

maxLength: 100

Nama organisasi. Panjang maksimum adalah 100 karakter.

projectName

string

maxLength: 100

Nama proyek. Panjang maksimum adalah 100 karakter.

repositoryName

string

maxLength: 128

Nama repositori. Panjang maksimum adalah 128 karakter.

ConfiguredConnectionGitCredentials

Kredensial Git koneksi yang dikonfigurasi.

Nama Jenis Deskripsi
connectionId

string (uuid)

ID objek koneksi.

source string:

ConfiguredConnection

Sumber kredensial Git.

ErrorRelatedResource

Objek detail sumber daya terkait kesalahan.

Nama Jenis Deskripsi
resourceId

string

ID sumber daya yang terlibat dalam kesalahan.

resourceType

string

Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.

message

string

Representasi kesalahan yang dapat dibaca manusia.

moreDetails

ErrorResponseDetails[]

Daftar detail kesalahan tambahan.

relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.

requestId

string

ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Detail respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.

message

string

Representasi kesalahan yang dapat dibaca manusia.

relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.

GitConnectRequest

Berisi data permintaan sambungkan Git.

Nama Jenis Deskripsi
gitProviderDetails GitProviderDetails:

Detail penyedia Git.

myGitCredentials GitCredentials:

Kredensial Git khusus pengguna untuk autentikasi ke GitProvider. Kredensial ini tidak dibagikan dengan kontributor ruang kerja lainnya. Untuk GitHub, properti ini diperlukan. Untuk AzureDevOps, properti ini bersifat opsional. Jika tidak diatur, defaultnya adalah AutomaticGitCredentials.

GitCredentialsSource

Sumber kredensial Git. Sumber kredensial Git tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
Automatic

Kredensial Git secara otomatis diperoleh oleh sistem, menggunakan kredensial default jika tersedia.

ConfiguredConnection

Info masuk Git diperoleh melalui koneksi yang dikonfigurasi.

None

Kredensial Git tidak dikonfigurasi.

GitHubDetails

Detail penyedia GitHub.

Nama Jenis Deskripsi
branchName

string

maxLength: 250

Nama cabang. Panjang maksimum adalah 250 karakter.

directoryName

string

maxLength: 256

Jalur relatif ke direktori. Panjang maksimum adalah 256 karakter.

gitProviderType string:

GitHub

Jenis penyedia Git. Jenis penyedia tambahan dapat ditambahkan dari waktu ke waktu.

ownerName

string

maxLength: 100

Nama pemilik. Panjang maksimum adalah 100 karakter.

repositoryName

string

maxLength: 128

Nama repositori. Panjang maksimum adalah 128 karakter.

GitProviderType

Jenis penyedia Git. Jenis penyedia tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
AzureDevOps

Penyedia Azure DevOps

GitHub

Penyedia GitHub