เชื่อมต่อและยกเลิกการเชื่อมต่อ Dataverse จากที่เก็บ Git โดยใช้โค้ด

ConnectToGitและDisconnectFromGit API เพื่อใช้การรวมสภาพแวดล้อม Microsoft Dataverse ของคุณกับระบบควบคุมเวอร์ชัน Git ด้วยวิธีการโปรแกรม โดยการใช้ API เหล่านี้ คุณสามารถเชื่อมต่อโซลูชันแต่ละรายการหรือสภาพแวดล้อมทั้งหมดไปยังที่เก็บ Git ที่โฮสต์บน Azure DevOps และจัดการการเชื่อมต่อเหล่านั้นผ่านรหัสได้

สำคัญ

Azure DevOps เป็นผู้ให้บริการ Git ที่ได้รับการสนับสนุนเท่านั้นในขณะนี้

ข้อกำหนดเบื้องต้น

ก่อนที่จะใช้ API เหล่านี้ ตรวจสอบให้แน่ใจว่าคุณมี:

• การเข้าถึงสภาพแวดล้อม Microsoft Dataverse
• สิทธิ์ของผู้ดูแลระบบ
• การเข้าถึงแบบอ่านและเขียนไปยังที่เก็บ Git

ConnectToGit API

สร้างการเชื่อมต่อระหว่างโซลูชัน Dataverse หรือสภาพแวดล้อมและที่เก็บ Git โดยการใช้การเชื่อมต่อนี้ คุณสามารถจัดการตัวควบคุมแหล่งข้อมูลสําหรับคอมโพเนนต์ Dataverse ของคุณได้

พารามิเตอร์

ConnectToGit API ยอมรับพารามิเตอร์ต่อไปนี้:

พารามิเตอร์	ประเภท	จำเป็นต้องระบุ	คำอธิบาย
GitFolder	สตริง	ใช่	ชื่อของโฟลเดอร์ที่คุณต้องการผูกโซลูชันหรือสภาพแวดล้อมของคุณ
Branch	สตริง	ใช่	ชื่อของสาขาที่คุณต้องการเชื่อมต่อ
ConnectionType	เลขจำนวนเต็ม	ไม่ใช่	ระบุสิ่งที่จะเชื่อมต่อ ดูพารามิเตอร์ ConnectionType
GitProvider	เลขจำนวนเต็ม	ไม่ใช่	ผู้ให้บริการ Git ดูพารามิเตอร์ GitProvider
Organization	สตริง	ไม่ใช่	ชื่อขององค์กรที่คุณต้องการเชื่อมต่อ
Project	สตริง	ไม่ใช่	ชื่อของโครงการที่คุณต้องการเชื่อมต่อ
Repository	สตริง	ไม่ใช่	ชื่อของที่เก็บที่คุณต้องการเชื่อมต่อ
RootFolder	สตริง	ไม่ใช่	ชื่อของโฟลเดอร์รากที่โซลูชันทั้งหมดของคุณอยู่ในขอบเขตโซลูชัน
SolutionUniqueName	สตริง	ไม่ใช่	ชื่อเฉพาะของโซลูชันที่คุณต้องการเชื่อมต่อกับ git
UpstreamBranch	สตริง	ไม่ใช่	ชื่อของสาขาอัพสตรีมที่คุณต้องการเชื่อมต่อ ค่าเริ่มต้นเป็นสาขาเริ่มต้นของที่เก็บข้อมูล

พารามิเตอร์ ConnectionType

พารามิเตอร์ ConnectionType จะควบคุมว่าจะเชื่อมต่อกับสภาพแวดล้อม Dataverse ทั้งหมดหรือโซลูชันเฉพาะ

มูลค่า	ฉลาก	คำอธิบาย
0	โซลูชัน	เชื่อมต่อโซลูชัน Dataverse เฉพาะกับ Git
1	สิ่งแวดล้อม	เชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดกับ Git

พารามิเตอร์ GitProvider

GitProviderใช้พารามิเตอร์เพื่อระบุประเภทของผู้ให้บริการ Git ที่คุณใช้อยู่ ไม่ว่าจะเป็น Azure DevOps หรือ GitHub

มูลค่า	ฉลาก	คำอธิบาย
0	Azure DevOps	ใช้สําหรับที่เก็บที่โฮสต์บน Azure DevOps
1	GitHub	ใช้สําหรับที่เก็บที่โฮสต์บน GitHub

DisconnectFromGit API

ลบการเชื่อมต่อ Git ออกจากโซลูชัน Dataverse หรือสภาพแวดล้อม และปิดใช้งานการรวมตัวควบคุมแหล่งข้อมูล

พารามิเตอร์

DisconnectFromGit API มีพารามิเตอร์เดียวเท่านั้น

พารามิเตอร์	ประเภท	จำเป็นต้องระบุ	คำอธิบาย
SolutionUniqueName	สตริง	ไม่ใช่	ชื่อเฉพาะของโซลูชันที่คุณต้องการยกเลิกการเชื่อมต่อจาก Git ไม่ต้องทำการยกเลิกการเชื่อมต่อโซลูชันหรือสภาพแวดล้อมทั้งหมด

ข้อมูลเพิ่มเติม

ต่อไปนี้เป็นตัวเลือกค่าพารามิเตอร์สองสามตัวเพื่อระบุเมื่อเรียกใช้DisconnectFromGit

• ยกเลิกการเชื่อมต่อโซลูชันเดียว: ให้ SolutionUniqueName เพื่อยกเลิกการเชื่อมต่อโซลูชันเฉพาะ
• ยกเลิกการเชื่อมต่อโซลูชันทั้งหมด: ไม่มีพารามิเตอร์เพื่อยกเลิกการเชื่อมต่อระดับโซลูชันทั้งหมด
• สภาพแวดล้อมที่ยกเลิกการเชื่อมต่อ: ไม่มีพารามิเตอร์เพื่อยกเลิกการเชื่อมต่อระดับสภาพแวดล้อม

ตัวอย่าง

ตัวอย่างต่อไปนี้อธิบายสถานการณ์สําหรับการใช้ ConnectToGit และ DisconnectFromGit API:

• เชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณกับที่เก็บ Azure DevOps
• ยกเลิกการเชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณจากตัวควบคุมแหล่งข้อมูล Git
• เชื่อมต่อโซลูชันแรกกับที่เก็บ Git
• เชื่อมต่อโซลูชันเพิ่มเติมไปยังที่เก็บ Git เดียวกันหลังจากที่คุณเชื่อมต่อโซลูชันเริ่มต้น
• ยกเลิกการเชื่อมต่อโซลูชันเฉพาะจากตัวควบคุมแหล่งข้อมูล Git ในขณะที่ยังคงเชื่อมต่อโซลูชันอื่น ๆ อยู่

เชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณกับที่เก็บ Azure DevOps

การเชื่อมต่อนี้จะเปิดใช้งานตัวควบคุมแหล่งข้อมูลสําหรับการกําหนดค่าและคอมโพเนนต์ระดับสภาพแวดล้อมทั้งหมด

อย่าใช้พารามิเตอร์เหล่านี้กับการเชื่อมต่อนี้:

• RootFolder
• SolutionUniqueName
• UpstreamBranch

API เว็บ

ตัวอย่างนี้แสดงวิธีการใช้ การดําเนินการ ConnectToGit เพื่อเชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณไปยังที่เก็บ Azure DevOps

ขอร้อง

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

การตอบสนอง

HTTP/1.1 204 No Content
OData-Version: 4.0

เรียนรู้วิธีเรียกใช้การดําเนินการ API เว็บ

SDK สําหรับ .NET

วิธีการแบบคงที่ ConnectDataverseEnvironment นี้แสดงวิธีการใช้ ConnectToGit ข้อความเพื่อเชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณไปยังที่เก็บ Azure DevOps

private const int GitProviderAzureDevOps = 0;
private const int GitProviderGitHub = 1;
private const int ConnectionTypeEnvironment = 1;

static void ConnectDataverseEnvironment(
    IOrganizationService service,
    string gitFolderName,
    string branchName,
    string organizationName,
    string projectName,
    string repositoryName,
    OptionSetValue? gitProvider = null)
{
    // Validate required parameters
    ArgumentNullException.ThrowIfNull(service);
    ArgumentException.ThrowIfNullOrWhiteSpace(gitFolderName);
    ArgumentException.ThrowIfNullOrWhiteSpace(branchName);
    ArgumentException.ThrowIfNullOrWhiteSpace(organizationName);
    ArgumentException.ThrowIfNullOrWhiteSpace(projectName);
    ArgumentException.ThrowIfNullOrWhiteSpace(repositoryName);

    // Default to Azure Dev Ops
    gitProvider ??= new OptionSetValue(GitProviderAzureDevOps);

    ParameterCollection parameters = new()
    {
        { "GitFolder", gitFolderName },
        { "Branch", branchName },
        { "ConnectionType", new OptionSetValue(ConnectionTypeEnvironment) },
        { "GitProvider", gitProvider },
        { "Organization", organizationName },
        { "Project", projectName },
        { "Repository", repositoryName }
    };

    OrganizationRequest request = new()
    {
        RequestName = "ConnectToGit",
        Parameters = parameters
    };

     service.Execute(request);
}

เรียนรู้วิธีการเรียกข้อความ Dataverse โดยใช้ SDK สําหรับ .NET

ยกเลิกการเชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณจากตัวควบคุมแหล่งข้อมูล Git

การดําเนินการนี้จะเป็นการลบการเชื่อมต่อ Git ระดับสภาพแวดล้อม อย่าใช้ SolutionUniqueName พารามิเตอร์ สําหรับการดําเนินการนี้ Dataverse ระบุและลบการเชื่อมต่อ Git ระดับสภาพแวดล้อมโดยอัตโนมัติ

API เว็บ

ตัวอย่างนี้แสดงวิธีการใช้ การดําเนินการ DisconnectFromGit เพื่อยกเลิกการเชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณจากตัวควบคุมแหล่งข้อมูล Git

ขอร้อง

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

การตอบสนอง

HTTP/1.1 204 No Content
OData-Version: 4.0

เรียนรู้วิธีเรียกใช้การดําเนินการ API เว็บ

SDK สําหรับ .NET

เมธอดแบบคงที่ DisconnectDataverseEnvironment ยกเลิกการเชื่อมต่อสภาพแวดล้อม Dataverse ทั้งหมดของคุณจากตัวควบคุมแหล่งข้อมูล Git

static void DisconnectDataverseEnvironment(IOrganizationService service) {

   // Validate required parameters
    ArgumentNullException.ThrowIfNull(service);

   OrganizationRequest request = new("DisconnectFromGit");

   service.Execute(request);

}

เรียนรู้วิธีการเรียกข้อความ Dataverse โดยใช้ SDK สําหรับ .NET

เชื่อมต่อโซลูชันแรกกับที่เก็บ Git

การเชื่อมต่อนี้จะสร้างลิงก์ที่เก็บข้อมูลและโครงสร้างโฟลเดอร์สําหรับตัวควบคุมแหล่งข้อมูลระดับโซลูชันกับโซลูชันแรกในสภาพแวดล้อม

คุณจําเป็นต้องใส่ค่าสําหรับพารามิเตอร์เหล่านี้เพื่อระบุโซลูชัน:

• RootFolder
• SolutionUniqueName

API เว็บ

ตัวอย่างนี้แสดงวิธีการใช้ การดําเนินการ ConnectToGit เพื่อเชื่อมต่อโซลูชันแรกกับที่เก็บ Git

ขอร้อง

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

การตอบสนอง

HTTP/1.1 204 No Content
OData-Version: 4.0

เรียนรู้วิธีเรียกใช้การดําเนินการ API เว็บ

SDK สําหรับ .NET

เมธอดแบบคงที่ ConnectFirstSolution แสดงวิธีการเชื่อมต่อโซลูชันแรกกับที่เก็บ Git

private const int ConnectionTypeSolution = 0;

static void ConnectFirstSolution(
    IOrganizationService service,
    string gitFolderName,
    string branchName,
    string organizationName,
    string projectName,
    string repositoryName,
    string rootFolderName,
    string solutionUniqueName,
    OptionSetValue? gitProvider = null)
{
    // Validate required parameters
    ArgumentNullException.ThrowIfNull(service);
    ArgumentException.ThrowIfNullOrWhiteSpace(gitFolderName);
    ArgumentException.ThrowIfNullOrWhiteSpace(branchName);
    ArgumentException.ThrowIfNullOrWhiteSpace(organizationName);
    ArgumentException.ThrowIfNullOrWhiteSpace(projectName);
    ArgumentException.ThrowIfNullOrWhiteSpace(repositoryName);
    ArgumentException.ThrowIfNullOrWhiteSpace(rootFolderName);
    ArgumentException.ThrowIfNullOrWhiteSpace(solutionUniqueName);

    // Default to Azure Dev Ops
    gitProvider ??= new OptionSetValue(GitProviderAzureDevOps);

    ParameterCollection parameters = new()
    {
        { "GitFolder", gitFolderName },
        { "Branch", branchName },
        { "ConnectionType", new OptionSetValue(ConnectionTypeSolution) },
        { "GitProvider", gitProvider },
        { "Organization", organizationName },
        { "Project", projectName },
        { "Repository", repositoryName },
        { "RootFolder", rootFolderName },
        { "SolutionUniqueName", solutionUniqueName }
    };

    OrganizationRequest request = new()
    {
        RequestName = "ConnectToGit",
        Parameters = parameters
    };

    service.Execute(request);
}

เรียนรู้วิธีการเรียกข้อความ Dataverse โดยใช้ SDK สําหรับ .NET

เชื่อมต่อโซลูชันเพิ่มเติมไปยังที่เก็บ Git เดียวกันหลังจากที่คุณเชื่อมต่อโซลูชันเริ่มต้น

หลังจากที่คุณเชื่อมต่อโซลูชันแรก คุณต้องการเฉพาะพารามิเตอร์เฉพาะโซลูชันเท่านั้น คุณได้รับรายละเอียดการเชื่อมต่อที่เก็บจากการเชื่อมต่อเริ่มต้น

ตั้งค่าพารามิเตอร์เหล่านี้เท่านั้น:

• SolutionUniqueName
• Branch
• GitFolder

สำคัญ

คุณต้องเชื่อมต่อโซลูชันแรกก่อนที่สิ่งนี้จะทำงานได้ ดูที่ เชื่อมต่อโซลูชันแรกกับที่เก็บ Git

API เว็บ

ตัวอย่างนี้แสดงวิธีการใช้ การดําเนินการ ConnectToGit เพื่อเชื่อมต่อโซลูชันที่ตามมากับที่เก็บ Git

ขอร้อง

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

การตอบสนอง

HTTP/1.1 204 No Content
OData-Version: 4.0

เรียนรู้วิธีเรียกใช้การดําเนินการ API เว็บ

SDK สําหรับ .NET

เมธอดแบบคงที่ ConnectExtraSolution แสดงวิธีการเชื่อมต่อโซลูชันที่ตามมากับที่เก็บ Git

static void ConnectExtraSolution(
   IOrganizationService service,
   string gitFolderName,
   string branchName,
   string solutionUniqueName)
{
   // Validate required parameters
   ArgumentNullException.ThrowIfNull(service);
   ArgumentException.ThrowIfNullOrWhiteSpace(gitFolderName);
   ArgumentException.ThrowIfNullOrWhiteSpace(branchName);
   ArgumentException.ThrowIfNullOrWhiteSpace(solutionUniqueName);

   ParameterCollection parameters = new()
   {
         { "GitFolder", gitFolderName },
         { "Branch", branchName },
         { "SolutionUniqueName", solutionUniqueName }
   };

   OrganizationRequest request = new()
   {
         RequestName = "ConnectToGit",
         Parameters = parameters
   };

   service.Execute(request);
}

เรียนรู้วิธีการเรียกข้อความ Dataverse โดยใช้ SDK สําหรับ .NET

ยกเลิกการเชื่อมต่อโซลูชันเฉพาะจากตัวควบคุมแหล่งข้อมูล Git ในขณะที่ยังคงเชื่อมต่อโซลูชันอื่น ๆ อยู่

ใช้วิธีการนี้เพื่อเอาตัวควบคุมแหล่งข้อมูลสําหรับโซลูชันหนึ่งออกโดยไม่กระทบต่อโซลูชันอื่น

API เว็บ

ตัวอย่างนี้แสดงวิธีการใช้ การดําเนินการ DisconnectFromGit เพื่อเอาตัวควบคุมแหล่งข้อมูลสําหรับโซลูชันหนึ่งออกโดยไม่กระทบต่อโซลูชันอื่น

ขอร้อง

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

การตอบสนอง

HTTP/1.1 204 No Content
OData-Version: 4.0

เรียนรู้วิธีเรียกใช้การดําเนินการ API เว็บ

SDK สําหรับ .NET

เมธอดแบบคงที่ DisconnectSolution จะลบตัวควบคุมแหล่งข้อมูลสําหรับโซลูชันหนึ่งโดยไม่กระทบต่อโซลูชันอื่น

static void DisconnectSolution(IOrganizationService service,
    string solutionUniqueName)
{

   // Validate required parameters
    ArgumentNullException.ThrowIfNull(service);
    ArgumentException.ThrowIfNullOrWhiteSpace(solutionUniqueName);

    ParameterCollection parameters = new()
    {
        { "SolutionUniqueName", solutionUniqueName }
    };

    OrganizationRequest request = new()
    {
        RequestName = "DisconnectFromGit",
        Parameters = parameters
    };

    service.Execute(request);
}

เรียนรู้วิธีการเรียกข้อความ Dataverse โดยใช้ SDK สําหรับ .NET

การจัดการข้อผิดพลาด

ไม่มีทั้ง ConnectToGit หรือ DisconnectFromGit API ส่งคืนค่าเมื่อดำเนินการสำเร็จ เมื่อ API ล้มเหลว จะส่งกลับข้อผิดพลาด

สถานการณ์ข้อผิดพลาดทั่วไปประกอบด้วย:

• ข้อมูลประจําตัวไม่ถูกต้อง: ตรวจสอบให้แน่ใจว่าคุณมีการรับรองความถูกต้องที่ถูกต้องไปยังผู้ให้บริการ Git
• ไม่พบที่เก็บข้อมูล: ตรวจสอบชื่อองค์กร โครงการ และที่เก็บ
• ปฏิเสธสิทธิ์: ตรวจสอบให้แน่ใจว่าบัญชี Dataverse ของคุณมีสิทธิ์การจัดการตัวควบคุมแหล่งข้อมูล
• ไม่พบโซลูชัน: ตรวจสอบว่ามี SolutionUniqueName อยู่ในสภาพแวดล้อมของคุณ
• ไม่มีสาขาอยู่: ยืนยันว่ามีสาขาที่ระบุอยู่ในที่เก็บ

การสนับสนุนและแหล่งข้อมูลเพิ่มเติม

สําหรับข้อมูลเพิ่มเติมเกี่ยวกับการรวมตัวควบคุมแหล่งข้อมูลกับ Dataverse โปรดดู:

• ภาพรวมของการรวม Git ใน Power Platform
• การดําเนินการ ConnectToGit
• การดําเนินการ DisconnectFromGit
• การดําเนินการ CommitToGit
• การดําเนินการ RefreshChangesFromGit
• PullChangesFromGit Action