Menyambungkan dan memutuskan Sambungan Dataverse dari repositori Git dengan menggunakan kode

ConnectToGit Gunakan API dan DisconnectFromGit untuk mengintegrasikan lingkungan Microsoft Dataverse Anda secara terprogram dengan kontrol sumber Git. Dengan menggunakan API ini, Anda dapat menghubungkan solusi individual atau seluruh lingkungan ke repositori Git yang dihosting di Azure DevOps, dan mengelola koneksi tersebut melalui kode.

Important

Azure DevOps saat ini adalah satu-satunya penyedia Git yang didukung.

Prasyarat

Sebelum menggunakan API ini, pastikan Anda memiliki:

  • Akses ke lingkungan Microsoft Dataverse
  • Izin sistem administrator
  • Membaca dan menulis akses ke repositori Git

ConnectToGit API

Membuat koneksi antara solusi atau lingkungan Dataverse dan repositori Git. Dengan menggunakan koneksi ini, Anda dapat mengelola kontrol sumber untuk komponen Dataverse Anda.

Parameters

ConnectToGit API menerima parameter berikut:

Parameter Type Required Deskripsi
GitFolder String Yes Nama folder yang ingin Anda hubungkan dengan solusi atau lingkungan Anda.
Branch String Yes Nama cabang yang ingin Anda sambungkan.
ConnectionType Integer No Menentukan apa yang akan disambungkan. Lihat parameter ConnectionType.
GitProvider Integer No Penyedia Git. Lihat Parameter GitProvider.
Organization String No Nama organisasi yang ingin Anda sambungkan.
Project String No Nama proyek yang ingin Anda sambungkan.
Repository String No Nama repositori yang ingin Anda sambungkan.
RootFolder String No Nama folder utama tempat semua solusi Anda termasuk dalam cakupan solusi.
SolutionUniqueName String No Nama unik solusi yang ingin Anda sambungkan ke git.
UpstreamBranch String No Nama cabang hulu yang ingin Anda sambungkan. Default untuk cabang default repositori.

Parameter ConnectionType

Parameter ConnectionType mengontrol apakah akan terhubung ke seluruh lingkungan Dataverse atau solusi tertentu.

Nilai Label Deskripsi
0 Solusi Menyambungkan solusi Dataverse tertentu ke Git.
1 Lingkungan Menyambungkan seluruh lingkungan Dataverse ke Git.

Parameter GitProvider

GitProvider Gunakan parameter untuk menentukan jenis penyedia Git yang Anda gunakan, baik Azure DevOps atau GitHub.

Nilai Label Deskripsi
0 Azure DevOps Gunakan untuk repositori yang dihosting di Azure DevOps
1 GitHub Gunakan untuk repositori yang dihosting di GitHub

API DisconnectFromGit

Menghapus koneksi Git dari solusi atau lingkungan Dataverse, dan menonaktifkan integrasi kontrol sumber.

Parameter

DisconnectFromGit API hanya memiliki satu parameter.

Parameter Type Required Deskripsi
SolutionUniqueName String No Nama unik solusi yang ingin Anda putuskan sambungannya dari Git. Abaikan untuk memutuskan koneksi semua perangkat atau sistem.

Informasi tambahan

Berikut adalah beberapa opsi nilai parameter untuk ditentukan saat memanggil DisconnectFromGit.

  • Putuskan solusi tunggal: Siapkan SolutionUniqueName untuk memutuskan solusi tertentu.
  • Memutuskan semua solusi: Tidak menyediakan parameter untuk memutuskan semua koneksi tingkat solusi.
  • Putuskan sambungan lingkungan: Tanpa parameter untuk memutuskan koneksi di tingkat lingkungan.

Contoh

Contoh berikut menjelaskan skenario untuk menggunakan ConnectToGit dan DisconnectFromGit API:

Menyambungkan seluruh lingkungan Dataverse Anda ke repositori Azure DevOps

Koneksi ini memungkinkan kontrol sumber untuk semua konfigurasi dan komponen tingkat lingkungan.

Jangan gunakan parameter ini dengan koneksi ini:

  • RootFolder
  • SolutionUniqueName
  • UpstreamBranch

Contoh ini menunjukkan cara menggunakan tindakan ConnectToGit untuk menghubungkan seluruh lingkungan Dataverse Anda ke repositori Azure DevOps.

Permintaan

POST [Organization URI]/api/data/v9.2/ConnectToGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "GitFolder": "yourGitfolderName",
   "Branch": "yourBranchName",
   "ConnectionType": 1,
   "GitProvider": 0,
   "Organization": "yourOrganizationName",
   "Project": "yourProjectName",
   "Repository": "yourRepositoryName"
}

Jawaban

HTTP/1.1 204 No Content
OData-Version: 4.0

Pelajari cara memanggil tindakan API Web

Memutuskan seluruh lingkungan Dataverse Anda dari kontrol sumber Git

Tindakan ini menghapus koneksi Git tingkat lingkungan. Jangan gunakan SolutionUniqueName parameter untuk operasi ini. Dataverse secara otomatis mengidentifikasi dan menghapus koneksi Git tingkat lingkungan.

Contoh ini menunjukkan cara menggunakan tindakan DisconnectFromGit untuk memutuskan sambungan seluruh lingkungan Dataverse Anda dari kontrol sumber Git.

Permintaan

POST [Organization URI]/api/data/v9.2/DisconnectFromGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

Jawaban

HTTP/1.1 204 No Content
OData-Version: 4.0

Pelajari cara memanggil tindakan API Web

Menyambungkan solusi pertama ke repositori Git

Koneksi ini menetapkan tautan repositori dan struktur folder untuk kontrol sumber tingkat solusi ke solusi pertama di lingkungan.

Anda perlu menyertakan nilai untuk parameter ini untuk menentukan solusi:

  • RootFolder
  • SolutionUniqueName

Contoh ini menunjukkan cara menggunakan tindakan ConnectToGit untuk menyambungkan solusi pertama ke repositori Git.

Permintaan

POST [Organization URI]/api/data/v9.2/ConnectToGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "GitFolder": "yourGitfolderName",
   "Branch": "yourBranchName",
   "ConnectionType": 1,
   "GitProvider": 0,
   "Organization": "yourOrganizationName",
   "Project": "yourProjectName",
   "Repository": "yourRepositoryName",
   "RootFolder": "yourRootFolderName",
   "SolutionUniqueName": "yourSolutionUniqueName"
}

Jawaban

HTTP/1.1 204 No Content
OData-Version: 4.0

Pelajari cara memanggil tindakan API Web

Hubungkan solusi tambahan ke repositori Git yang sama setelah Anda menyambungkan solusi awal

Setelah menyambungkan solusi pertama, Anda hanya memerlukan parameter khusus solusi. Anda mewarisi detail koneksi repositori dari koneksi awal.

Atur hanya parameter ini:

  • SolutionUniqueName
  • Branch
  • GitFolder

Important

Anda harus terlebih dahulu menyambungkan solusi pertama sebelum ini berfungsi. Lihat Menyambungkan solusi pertama ke repositori Git.

Contoh ini menunjukkan cara menggunakan tindakan ConnectToGit untuk menyambungkan solusi berikutnya ke repositori Git.

Permintaan

POST [Organization URI]/api/data/v9.2/ConnectToGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "GitFolder": "yourGitfolderName",
   "Branch": "yourBranchName",
   "SolutionUniqueName": "yourSolutionUniqueName"
}

Jawaban

HTTP/1.1 204 No Content
OData-Version: 4.0

Pelajari cara memanggil tindakan API Web

Putuskan sambungan solusi tertentu dari kontrol sumber Git sambil menjaga solusi lain tetap terhubung

Gunakan pendekatan ini untuk menghapus kontrol sumber untuk satu solusi tanpa memengaruhi yang lain.

Contoh ini menunjukkan cara menggunakan tindakan DisconnectFromGit untuk menghapus kontrol sumber untuk satu solusi tanpa memengaruhi yang lain.

Permintaan

POST [Organization URI]/api/data/v9.2/DisconnectFromGit HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0

{
   "SolutionUniqueName": "yourSolutionUniqueName"
}

Jawaban

HTTP/1.1 204 No Content
OData-Version: 4.0

Pelajari cara memanggil tindakan API Web

Penanganan kesalahan

ConnectToGit API maupun DisconnectFromGit API tidak mengembalikan nilai saat keduanya berhasil diselesaikan. Saat API gagal, API akan mengembalikan kesalahan.

Skenario kesalahan umum meliputi:

  • Kredensial tidak valid: Pastikan Anda memiliki autentikasi yang valid ke penyedia Git.
  • Repositori tidak ditemukan: Verifikasi nama organisasi, proyek, dan repositori.
  • Izin ditolak: Pastikan akun Dataverse Anda memiliki izin manajemen kontrol sumber.
  • Solusi tidak ditemukan: Verifikasi ada SolutionUniqueName di lingkungan Anda.
  • Cabang tidak ada: Konfirmasi cabang yang ditentukan ada di repositori.

Dukungan dan sumber daya tambahan

Untuk informasi selengkapnya tentang integrasi kontrol sumber dengan Dataverse, lihat: