Підключіть і від'єднайте Dataverse від репозиторію Git за допомогою коду

Використовуйте ConnectToGit API та DisconnectFromGit для програмної інтеграції вашого середовища Microsoft Dataverse з контролем версій Git. Використовуючи ці API, ви можете підключати окремі рішення або цілі середовища до Git-репозиторіїв, розміщених на Azure DevOps, і керувати цими з'єднаннями через код.

Important

Azure DevOps наразі є єдиним підтримуваним провайдером Git.

вимоги

Перед використанням цих API переконайтеся, що у вас:

• Доступ до середовища Microsoft Dataverse
• Права доступу системного адміністратора
• Доступ до читання та запису до репозиторію Git

ConnectToGit API

Створює зв'язок між рішенням або середовищем Dataverse та репозиторієм Git. Використовуючи це з'єднання, ви можете керувати контролем версії для компонентів Dataverse.

Параметри

API приймає такі параметри:ConnectToGit

Параметр	Тип	Обов'язковий	Опис
GitFolder	Рядок	Так	Назвіть папку, до якої хочете прив'язати рішення або середовище.
Branch	Рядок	Так	Назвіть філію, до якої хочете підключитися.
ConnectionType	Ціле число	Ні	Вказує, до чого підключатися. Див. параметр ConnectionType.
GitProvider	Ціле число	Ні	Провайдер Git. Див. параметр GitProvider.
Organization	Рядок	Ні	Назвіть організацію, з якою хочете зв'язатися.
Project	Рядок	Ні	Назва проєкту, до якого ви хочете приєднатися.
Repository	Рядок	Ні	Назва репозиторію, до якого ви хочете підключитися.
RootFolder	Рядок	Ні	Ім'я кореневої папки, де всі ваші рішення знаходяться у scope solution.
SolutionUniqueName	Рядок	Ні	Унікальна назва рішення, яке ви хочете підключити до git.
UpstreamBranch	Рядок	Ні	Назва верхньої гілки, до якої ви хочете підключитися. За замовчуванням налаштований на стандартну гілку репозиторію.

Параметр ConnectionType

Параметр ConnectionType визначає, чи підключатися до всього середовища Dataverse, чи до конкретного рішення.

Цінність	Мітка	Опис
0	Рішення	Підключає конкретне рішення Dataverse до Git.
1	Середовище	Підключає все середовище Dataverse до Git.

Параметр GitProvider

Використовуйте GitProvider параметр, щоб вказати тип провайдера Git, який ви використовуєте — Azure DevOps або GitHub.

Цінність	Мітка	Опис
0	Azure DevOps	Use for repositories hosted on 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

Дізнайтеся, як викликати дії Web 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

Дізнайтеся, як викликати дії Web 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

Дізнайтеся, як викликати дії Web 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

Important

Спочатку потрібно підключити перше рішення, перш ніж це спрацює. Див. Підключити перше рішення до репозиторію 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

Дізнайтеся, як викликати дії Web 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

Дізнайтеся, як викликати дії Web 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

Обробка помилок

Ні API, ConnectToGitDisconnectFromGit ні API не повертає значення після успішного завершення. Коли API виходить з ладу, він повертає помилку.

Поширені сценарії помилок включають:

• Недійсні облікові дані: Переконайтеся, що у вас дійсна автентифікація для провайдера Git.
• Репозиторій не знайдено: Перевірте назви організацій, проєктів і репозиторіїв.
• Дозвіл відмовлено: переконайтеся, що ваш обліковий запис Dataverse має права на керування версією.
• Рішення не знайдено: перевірте, чи існує SolutionUniqueName у вашому середовищі.
• Branch не існує: Підтвердіть, що вказана гілка існує у репозиторії.

Підтримка та додаткові ресурси

Для отримання додаткової інформації про інтеграцію контролю версії з Dataverse дивіться:

• Огляд інтеграції Git у Power Platform
• Дія ConnectToGit
• Дія DisconnectFromGit
• Дія CommitToGit
• RefreshChangesFromGit Action
• PullChangesFromGit Action