Compartir vía

Ejemplo de acciones y funciones de API web (PowerShell)

En este ejemplo de PowerShell versión 7.4.0 se muestra cómo llamar a las funciones y acciones enlazadas y sin enlazar, incluidas las acciones personalizadas, mediante la API web de Microsoft Dataverse. En este ejemplo se implementan las operaciones de Dataverse y salida por consola detalladas en Web API Functions and Actions Sample.

Ver este ejemplo en Github

Esta muestra utiliza las Funciones auxiliares de PowerShell de la Web API de Dataverse para gestionar la autenticación y proporcionar funciones reutilizables para realizar operaciones comunes. Se hace referencia a estos scripts utilizando abastecimiento de puntos con las siguientes líneas:

. $PSScriptRoot\..\Core.ps1
. $PSScriptRoot\..\TableOperations.ps1
. $PSScriptRoot\..\CommonFunctions.ps1

Nota:

Esta muestra debería funcionar con Windows, Linux y macOS, pero solo se ha probado en Windows.

Prerrequisitos

Antes de ejecutar este ejemplo, debe leer estos artículos que explican los conceptos y patrones utilizados en estos ejemplos:

Estos artículos tienen los mismos requisitos previos.

Instale o verifique que lo siguiente esté instalado

Comprobar la instalación

  1. Abre Visual Studio Code.

  2. En el menú Terminal, seleccione Nuevo terminal.

  3. En el panel de navegación de Visual Studio Code, seleccione el icono para la extensión de PowerShell.

  4. Copie y pegue el siguiente script en la ventana de la terminal de Visual Studio Code:

    Write-Host 'PowerShell Version:'$PSVersionTable.PSVersion.ToString()
Write-Host 'PowerShell Az version:'(Get-InstalledModule Az).Version

  5. Presione ENTRAR. La salida debe ser similar a la siguiente:

    PowerShell Version: 7.4.0
PowerShell Az version: 11.1.0

Si no ve resultados como este, instale o actualice los requisitos previos.

También necesitará

  • Cuenta de usuario válida para un entorno de Dataverse
  • Dirección URL al entorno de Dataverse al que desea conectarse Consulte Ver recursos para desarrolladores para saber cómo encontrarlo. Se parece a esto: https://yourorg.crm.dynamics.com/, donde yourorg.crm es diferente.
  • Comprensión básica de lenguaje de scripting PowerShell

Cómo ejecutar esta muestra

  1. Clonar o descargar el repositorio de ejemplos de PowerApps.

  2. Abrir el archivo FunctionsAndActions.ps1 utilizando Visual Studio Code

  3. Edite esta línea para usar la URL del entorno al que quiere conectarse:

    Connect 'https://yourorg.crm.dynamics.com/' # change this

  4. (Opcional) Configure la variable $deleteCreatedRecords a $false si no desea eliminar los registros que crea esta muestra.

  5. Presione F5 para ejecutar el ejemplo.

  6. La primera vez que ejecuta el ejemplo se abre una ventana del navegador. En la ventana del navegador, ingrese o seleccione las credenciales que desea usar para autenticarse.

Para conectarse como un usuario diferente, ejecute el Comando Disconnect-AzAccount e inténtelo de nuevo.

Código

El código de este ejemplo se encuentra en: PowerApps-Samples/dataverse/webapi/PS/FunctionsAndActions/FunctionsAndActions.ps1

Demostraciones

Este ejemplo tiene nueve regiones:

Sección 1: Función independiente WhoAmI

Operaciones: llame a la función WhoAmI para recuperar información sobre el usuario actual.

Sección 2: Función independiente FormatAddress

Operaciones:

  • Llame a la función FormatAddress con parámetros para una dirección en Estados Unidos.
  • Llame a la misma función con parámetros para una dirección en Japón para mostrar un formato diferente.

Sección 3: Función independiente InitializeFrom

Operaciones:

  • Cree un registro de cuenta igual al registro original.
  • Llame a la función InitializeFrom para obtener datos de un nuevo registro basado en el original.
  • Crear un nuevo registro de cuenta usando los datos devueltos de InitializeFrom.

Sección 4: Función independiente RetrieveCurrentOrganization

Operaciones: llame a la función RetrieveCurrentOrganization para recuperar información sobre la organización actual.

Sección 5: Función independiente RetrieveTotalRecordCount

Operaciones: llame a la función RetrieveTotalRecordCount para recuperar el número total de registros de las tablas especificadas.

Sección 6: Función vinculada de API personalizada IsSystemAdmin

Operaciones:

  • Detecte si la sample_IsSystemAdmin API personalizada está instalada en la organización.
  • Si no está instalado, importe la solución administrada que contiene la API personalizada.
  • Recupere los registros de usuario del sistema y pruebe cada uno con la función sample_IsSystemAdmin para determinar si tienen el rol de seguridad System Administrator.

Sección 7: Acción sin consolidar GrantAccess

Operaciones:

  • Cree un registro de cuenta para compartir.
  • Recupere un usuario habilitado que no sea el usuario actual.
  • Use la función RetrievePrincipalAccess para comprobar los derechos de acceso del usuario.
  • Usa la GrantAccess Action para conceder derechos de acceso adicionales al usuario.
  • Compruebe que los derechos de acceso se concedieron de nuevo mediante RetrievePrincipalAccess .

Sección 8: Acción vinculada AddPrivilegesRole

Operaciones:

  • Cree un rol de seguridad asociado a la unidad de negocio del usuario actual.
  • Recupere el rol con privilegios expandidos para mostrar los privilegios predeterminados.
  • Recupere información sobre privilegios específicos para agregar al rol.
  • Use la acción AddPrivilegesRole para agregar privilegios al rol.
  • Recupere el rol de nuevo para confirmar que se agregaron los privilegios.

Sección 9: Eliminar registros de muestra

Operaciones: se agregó una referencia a cada registro creado en esta muestra a una lista a medida que se creaba. Esta sección recorre esa lista y elimina cada registro.

Limpieza

De forma predeterminada, esta muestra elimina todos los registros creados en ella. Si desea ver los registros creados después de completar la muestra, cambie la variable deleteCreatedRecords a false y se le pedirá que decida si desea eliminar los registros.

Consulte también

Usar la API web de Dataverse
Uso de funciones de API web
Usar acciones de la API web
Inicio rápido de la API web con PowerShell y Visual Studio Code
Usar PowerShell y Visual Studio Code con la API web de Dataverse
Ejemplos de la API Web
Ejemplo de funciones y acciones de la API web
Ejemplo de acciones y funciones de API web (C#)
Ejemplo de acciones y funciones de API web (JavaScript del lado cliente)

  • Last updated on