Conexión y desconexión de Dataverse desde un repositorio de Git mediante código

Use las ConnectToGit API y DisconnectFromGit para integrar mediante programación el entorno de Microsoft Dataverse con el control de código fuente de Git. Mediante estas API, puede conectar soluciones individuales o entornos completos a repositorios de Git hospedados en Azure DevOps y administrar esas conexiones a través del código.

Importante

Azure DevOps es actualmente el único proveedor de Git compatible.

Prerrequisitos

Antes de usar estas API, asegúrese de que tiene:

• Acceso a un entorno de Microsoft Dataverse
• Permisos de administrador del sistema
• Acceso de lectura y escritura a un repositorio de Git

ConnectToGit API

Crea una conexión entre una solución o un entorno de Dataverse y un repositorio de Git. Mediante esta conexión, puede administrar el control de código fuente para los componentes de Dataverse.

Parámetros

La ConnectToGit API acepta los parámetros siguientes:

Parámetro	Tipo	Obligatorio	Descripción
GitFolder	String	Sí	Nombre de la carpeta a la que desea enlazar la solución o el entorno.
Branch	String	Sí	Nombre de la rama a la que desea conectarse.
ConnectionType	Número entero	No	Especifica a qué conectarse. Consulte Parámetro ConnectionType.
GitProvider	Número entero	No	Proveedor de Git. Consulte el parámetro GitProvider.
Organization	String	No	Nombre de la organización a la que desea conectarse.
Project	String	No	Nombre del proyecto al que desea conectarse.
Repository	String	No	Nombre del repositorio al que desea conectarse.
RootFolder	String	No	Nombre de la carpeta raíz donde residen todas las soluciones en el ámbito de la solución.
SolutionUniqueName	String	No	Nombre único de la solución que desea conectar a Git.
UpstreamBranch	String	No	Nombre de la rama ascendente a la que desea conectarse. El valor por defecto es la rama predeterminada del repositorio.

Parámetro de ConnectionType

El ConnectionType parámetro controla si se va a conectar a todo el entorno de Dataverse o a una solución específica.

Importancia	Etiqueta	Descripción
0	Solución	Conecta una solución específica de Dataverse a Git.
1	Medio ambiente	Conecta todo el entorno de Dataverse a Git.

Parámetro GitProvider

Use el GitProvider parámetro para especificar el tipo de proveedor de Git que usa, ya sea Azure DevOps o GitHub.

Importancia	Etiqueta	Descripción
0	Azure DevOps	Uso de repositorios hospedados en Azure DevOps
1	GitHub (en inglés)	Uso para repositorios hospedados en GitHub

DesconectarDeGit API

Quita la conexión de Git de una solución o entorno de Dataverse y deshabilita la integración del control de código fuente.

Parámetro

La DisconnectFromGit API solo tiene un parámetro.

Parámetro	Tipo	Obligatorio	Descripción
SolutionUniqueName	String	No	Nombre único de la solución que desea desconectar de Git. Omita para desconectar todas las soluciones o el entorno.

Información adicional

Estas son algunas opciones de valor de parámetro que se deben especificar al invocar DisconnectFromGit.

• Desconectar solución única: proporcione SolutionUniqueName para desconectar una solución específica.
• Desconectar todas las soluciones: no proporcione ningún parámetro para desconectar todas las conexiones de nivel de solución.
• Desconectar entorno: No proporcione ningún parámetro para desconectar la conexión a nivel de entorno.

Ejemplos

En los ejemplos siguientes se describen escenarios para el uso de las APIs ConnectToGit y DisconnectFromGit.

• Conexión de todo el entorno de Dataverse a un repositorio de Azure DevOps
• Desconecte todo el entorno de Dataverse del control de código fuente de Git.
• Conexión de la primera solución a un repositorio de Git
• Conexión de soluciones adicionales al mismo repositorio de Git después de conectar la solución inicial
• Desconecte una solución específica del control de código fuente de Git mientras mantiene conectadas otras soluciones

Conexión de todo el entorno de Dataverse a un repositorio de Azure DevOps

Esta conexión habilita el control de código fuente para todas las configuraciones y componentes de nivel de entorno.

No use estos parámetros con esta conexión:

• RootFolder
• SolutionUniqueName
• UpstreamBranch

API Web

En este ejemplo se muestra cómo usar la acción ConnectToGit para conectar todo el entorno de Dataverse a un repositorio de Azure DevOps.

Solicitud

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

Respuesta

HTTP/1.1 204 No Content
OData-Version: 4.0

Aprenda a invocar acciones de API web

SDK para .NET

Este método estático ConnectDataverseEnvironment muestra cómo usar el mensaje para conectar todo el ConnectToGit entorno de Dataverse a un repositorio de 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);
}

Aprenda a invocar mensajes de Dataverse mediante el SDK para .NET.

Desconecte todo el entorno de Dataverse del control de código fuente de Git.

Esta acción elimina la conexión de Git a nivel de entorno. No use el SolutionUniqueName parámetro para esta operación. Dataverse identifica y elimina automáticamente la conexión Git a nivel de entorno.

API Web

En este ejemplo se muestra cómo usar la acción DisconnectFromGit para desconectar todo el entorno de Dataverse del control de código fuente de Git.

Solicitud

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

Respuesta

HTTP/1.1 204 No Content
OData-Version: 4.0

Aprenda a invocar acciones de API web

SDK para .NET

El método estático DisconnectDataverseEnvironment desconecta todo el entorno de Dataverse del control de código fuente de Git.

static void DisconnectDataverseEnvironment(IOrganizationService service) {

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

   OrganizationRequest request = new("DisconnectFromGit");

   service.Execute(request);

}

Aprenda a invocar mensajes de Dataverse mediante el SDK para .NET.

Conexión de la primera solución a un repositorio de Git

Esta conexión establece el vínculo del repositorio y la estructura de carpetas para el control de código fuente a nivel de solución en la primera solución de un entorno.

Debe incluir valores para estos parámetros para especificar la solución:

• RootFolder
• SolutionUniqueName

API Web

En este ejemplo se muestra cómo usar la acción ConnectToGit para conectar la primera solución a un repositorio de Git.

Solicitud

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

Respuesta

HTTP/1.1 204 No Content
OData-Version: 4.0

Aprenda a invocar acciones de API web

SDK para .NET

El método estático ConnectFirstSolution muestra cómo conectar la primera solución a un repositorio de 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);
}

Aprenda a invocar mensajes de Dataverse mediante el SDK para .NET.

Conexión de soluciones adicionales al mismo repositorio de Git después de conectar la solución inicial

Después de conectar la primera solución, solo necesita los parámetros específicos de la solución. Hereda los detalles de conexión al repositorio de la conexión inicial.

Establezca solo estos parámetros:

• SolutionUniqueName
• Branch
• GitFolder

Importante

Debe conectar primero la solución inicial para que esto funcione. Consulte Conexión de la primera solución a un repositorio de Git.

API Web

En este ejemplo se muestra cómo usar la acción ConnectToGit para conectar soluciones posteriores a un repositorio de Git.

Solicitud

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

Respuesta

HTTP/1.1 204 No Content
OData-Version: 4.0

Aprenda a invocar acciones de API web

SDK para .NET

El método estático ConnectExtraSolution muestra cómo conectar soluciones posteriores a un repositorio de 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);
}

Aprenda a invocar mensajes de Dataverse mediante el SDK para .NET.

Desconecte una solución específica del control de código fuente de Git mientras mantiene conectadas otras soluciones

Use este enfoque para quitar el control de código fuente de una solución sin afectar a otros usuarios.

API Web

En este ejemplo se muestra cómo usar la acción DisconnectFromGit para quitar el control de código fuente de una solución sin afectar a otros.

Solicitud

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

Respuesta

HTTP/1.1 204 No Content
OData-Version: 4.0

Aprenda a invocar acciones de API web

SDK para .NET

El método estático DisconnectSolution quita el control de código fuente de una solución sin afectar a otros.

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);
}

Aprenda a invocar mensajes de Dataverse mediante el SDK para .NET.

Gestión de errores

Ni la API ConnectToGit ni la API DisconnectFromGit devuelven un valor cuando se completa correctamente. Cuando se produce un error en una API, devuelve un error.

Las situaciones de error más comunes son:

• Credenciales no válidas: asegúrese de que tiene autenticación válida en el proveedor de Git.
• Repositorio no encontrado: compruebe los nombres de organización, proyecto y repositorio.
• Permiso denegado: asegúrese de que la cuenta de Dataverse tiene permisos de administración de control de código fuente.
• Solución no encontrada: compruebe que SolutionUniqueName existe en su entorno.
• La rama no existe: confirme que la rama especificada existe en el repositorio.

Soporte técnico y recursos adicionales

Para obtener más información sobre la integración del control de código fuente con Dataverse, consulte:

• Introducción a la integración de Git en Power Platform
• Acción ConnectToGit
• DisconnectFromGit (acción)
• Acción de CommitToGit
• Acción RefreshChangesFromGit
• Acción PullChangesFromGit