Git - Commit To Git

Layanan:: Core

Versi API:: v1

Menerapkan perubahan yang dibuat di ruang kerja ke cabang jarak jauh yang tersambung.
API ini mendukung operasi jangka panjang (LRO).

Untuk menggunakan API ini, kredensial Git penelepon harus dikonfigurasi menggunakan Update My Git Credentials API. Anda dapat menggunakan Get My Git Credentials API untuk memeriksa konfigurasi kredensial Git.

Anda dapat memilih untuk menerapkan semua perubahan, item tertentu, atau file tertentu dalam item menggunakan mode FileLevelSelective. Untuk menyinkronkan ruang kerja untuk pertama kalinya, gunakan API ini setelah API Sambungkan dan Inisialisasi Koneksi .

Hak akses

Pemanggil harus memiliki kontributor atau peran ruang kerja yang lebih tinggi.

Cakupan yang Didelegasikan yang Diperlukan

Workspace.GitCommit.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	Hanya didukung ketika semua item yang terlibat dalam operasi mendukung perwakilan layanan

Antarmuka

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
workspaceId	path	True	string (uuid)	ID ruangkerja.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
mode	True	CommitMode	Mode untuk operasi penerapan.
comment		string maxLength: 300	Komentar bebas penelepon untuk penerapan ini. Panjang maksimum adalah 300 karakter. Jika tidak ada komentar yang diberikan oleh pemanggil, gunakan komentar penyedia Git default.
items		ItemIdentifier[]	Item tertentu untuk dikomit. Ini hanya relevan untuk mode Penerapan selektif. Saling eksklusif dengan itemWithFileSelection. Item dapat diambil dari GIT Status API.
itemsWithFileSelection		ItemIdentifierWithFileSelection[]	Item dengan pilihan per file untuk mode penerapan FileLevelSelective. Saling eksklusif dengan item. Setiap entri menentukan item dan secara opsional daftar jalur file yang akan diterapkan. Jika selectedFiles null atau kosong untuk item, semua file untuk item tersebut akan diterapkan.
workspaceHead		string	Hash SHA penuh tempat ruang kerja disinkronkan. Hash dapat diambil dari GIT Status API.

Respons

Nama	Jenis	Deskripsi
200 OK		Permintaan berhasil diselesaikan.
202 Accepted		Permintaan diterima, terapkan ke Git yang sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang `Retry-After` menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: WorkspaceNotConnectedToGit - Ruang kerja tidak tersambung ke git. WorkspaceHasNoCapacityAssigned - Tidak ada kapasitas yang dinilai ke ruang kerja. WorkspaceHeadMismatch - Kepala dalam permintaan tidak cocok dengan kepala dalam sistem. WorkspacePreviousOperationInProgress - Operasi sebelumnya masih berlangsung. InsufficientPrivileges - Pemanggil tidak memiliki izin ruang kerja yang memadai. PrincipalTypeNotSupported - Jenis identitas pemanggil tidak didukung.

Contoh

Commit all to Git example

Commit file-level selective to Git example

Commit selective items to Git example

Commit all to Git example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/commitToGit

{
  "mode": "All",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing all my changes."
}

Respon sampel

Kode status:: 200

Kode status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Commit file-level selective to Git example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/commitToGit

{
  "mode": "FileLevelSelective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "Commit only the metadata change from MyNotebook",
  "itemsWithFileSelection": [
    {
      "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
      "selectedFiles": [
        "metadata.json"
      ]
    },
    {
      "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789",
      "selectedFiles": []
    }
  ]
}

Respon sampel

Kode status:: 200

Kode status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Commit selective items to Git example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/commitToGit

{
  "mode": "Selective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing specific changes.",
  "items": [
    {
      "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
      "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
    },
    {
      "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
    }
  ]
}

Respon sampel

Kode status:: 200

Kode status:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definisi

Nama	Deskripsi
CommitMode	Mode untuk operasi penerapan. Mode tambahan dapat ditambahkan dari waktu ke waktu.
CommitToGitRequest	Berisi permintaan penerapan.
ErrorParameter	Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
ItemIdentifier	Berisi pengidentifikasi item. Setidaknya salah satu properti harus ditentukan.
ItemIdentifierWithFileSelection	Berisi pengidentifikasi item dengan pilihan tingkat file opsional untuk operasi penerapan.

CommitMode

Enumerasi

Mode untuk operasi penerapan. Mode tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
All	Terapkan semua perubahan yang tidak dikomit. Pemanggil tidak diperlukan untuk menyediakan daftar item yang akan dilakukan.
Selective	Terapkan daftar item tertentu yang memiliki perubahan yang tidak dikomit. `items` Gunakan properti untuk menentukan item.
FileLevelSelective	Terapkan file yang ditentukan dalam item yang ditentukan. `itemsWithFileSelection` Gunakan properti untuk menentukan item dan file.

CommitToGitRequest

Objek

Berisi permintaan penerapan.

Nama	Jenis	Deskripsi
comment	string maxLength: 300	Komentar bebas penelepon untuk penerapan ini. Panjang maksimum adalah 300 karakter. Jika tidak ada komentar yang diberikan oleh pemanggil, gunakan komentar penyedia Git default.
items	ItemIdentifier[]	Item tertentu untuk dikomit. Ini hanya relevan untuk mode Penerapan selektif. Saling eksklusif dengan itemWithFileSelection. Item dapat diambil dari GIT Status API.
itemsWithFileSelection	ItemIdentifierWithFileSelection[]	Item dengan pilihan per file untuk mode penerapan FileLevelSelective. Saling eksklusif dengan item. Setiap entri menentukan item dan secara opsional daftar jalur file yang akan diterapkan. Jika selectedFiles null atau kosong untuk item, semua file untuk item tersebut akan diterapkan.
mode	CommitMode	Mode untuk operasi penerapan.
workspaceHead	string	Hash SHA penuh tempat ruang kerja disinkronkan. Hash dapat diambil dari GIT Status API.

ErrorParameter

Objek

Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.

Nama	Jenis	Deskripsi
message	string	Deskripsi yang dapat dibaca manusia tentang arti parameter.
name	string	Pengidentifikasi parameter.
value	string	Nilai parameter.

ErrorRelatedResource

Objek

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

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. `Retry-After` Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
parameters	ErrorParameter[]	Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

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.
parameters	ErrorParameter[]	Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

ItemIdentifier

Objek

Berisi pengidentifikasi item. Setidaknya salah satu properti harus ditentukan.

Nama	Jenis	Deskripsi
logicalId	string (uuid)	ID logis item. Saat ID logis tidak tersedia karena item belum ditambahkan ke ruang kerja, Anda dapat menggunakan ID objek.
objectId	string (uuid)	ID objek item. Saat ID objek tidak tersedia karena item dihapus dari ruang kerja, Anda dapat menggunakan ID logis.

ItemIdentifierWithFileSelection

Objek

Berisi pengidentifikasi item dengan pilihan tingkat file opsional untuk operasi penerapan.

Nama	Jenis	Deskripsi
logicalId	string (uuid)	ID logis item. Saat ID logis tidak tersedia karena item belum ditambahkan ke ruang kerja, Anda dapat menggunakan ID objek.
objectId	string (uuid)	ID objek item. Saat ID objek tidak tersedia karena item dihapus dari ruang kerja, Anda dapat menggunakan ID logis.
selectedFiles	string[]	Jalur file yang akan diterapkan, relatif terhadap akar item. Jalur hanya menggunakan garis miring, tidak ada garis miring terdepan, jalur file lengkap saja (tidak ada direktori atau kartubebas), tidak ada segmen kosong atau khusus spasi kosong, dan segmen tidak dapat diakhapi dengan titik atau spasi akhir. Jika null atau kosong, semua file untuk item ini diterapkan.