Freigeben über

Web-API-Funktionen und -Aktionen (Beispiel) (PowerShell)

In diesem PowerShell Version 7.4.0-Beispiel wird veranschaulicht, wie gebundene und ungebundene Funktionen und Aktionen, einschließlich benutzerdefinierter Aktionen, mithilfe der Microsoft Dataverse-Web-API aufgerufen werden. In diesem Beispiel werden die Dataverse-Vorgänge und die Konsolenausgabe implementiert, die im Web-API-Funktionen- und Aktionsbeispiel beschrieben ist.

Dieses Beispiel auf Github ansehen

Dieses Beispiel verwendet die Dataverse-Web-API-PowerShell-Hilfsfunktionen, um die Authentifizierung zu verwalten und wiederverwendbare Funktionen zur Durchführung allgemeiner Vorgänge bereitzustellen. Auf diese Skripte wird mit Dot-Sourcing mit den folgenden Zeilen verwiesen:

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

Hinweis

Dieses Beispiel sollte mit Windows, Linux und macOS funktionieren, wurde aber nur unter Windows getestet.

Voraussetzungen

Bevor Sie dieses Beispiel ausführen, sollten Sie die folgenden Artikel lesen, in denen die von diesen Beispielen verwendeten Konzepte und Muster erläutert werden:

Für diese Artikel gelten die gleichen Voraussetzungen.

Installieren Sie Folgendes oder überprüfen Sie, ob es vorhanden ist

Überprüfen der Installation

  1. Öffnen Sie Visual Studio Code.

  2. Wählen Sie im Menü Terminal die Option New Terminal (Neues Terminal) aus.

  3. Wählen Sie im Visual Studio Code-Navigationsbereich das Symbol für die PowerShell-Erweiterung aus.

  4. Kopieren Sie das folgende Skript im Terminalfenster von Visual Studio Code, und fügen Sie es ein:

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

  5. Drücken Sie die EINGABETASTE. Die Ausgabe sollte wie folgt aussehen:

    PowerShell Version: 7.4.0
PowerShell Az version: 11.1.0

Wenn Sie keine derartigen Ergebnisse sehen, installieren oder aktualisieren Sie die Voraussetzungen.

Darüber hinaus brauchen Sie

  • Ein gültiges Benutzerkonto für eine Dataverse-Umgebung
  • Die URL zur Dataverse-Umgebung, mit der Sie eine Verbindung herstellen möchten Unter Entwicklerressourcen anzeigen erfahren Sie, wie Sie ihn finden. Sie sieht ungefähr so aus: https://yourorg.crm.dynamics.com/, wobei yourorg.crm anders ist.
  • Grundlegende Kenntnisse über die PowerShell-Skriptsprache

Wie man dieses Beispiel ausführt

  1. Klonen Sie das PowerApps-Beispiele-Repository oder laden Sie es herunter.

  2. Die FunctionsAndActions.ps1-Datei mit Visual Studio Code öffnen

  3. Bearbeiten Sie diese Zeile, damit sie die URL der Umgebung verwendet, mit der Sie eine Verbindung herstellen können:

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

  4. (Optional) Legen Sie die $deleteCreatedRecords-Variable auf $false fest, wenn Sie die in diesem Beispiel erstellten Datensätze nicht löschen möchten.

  5. Drücken Sie F5, um das Beispiel auszuführen.

  6. Wenn Sie das Beispiel zum ersten Mal ausführen, wird ein Browserfenster geöffnet. Geben Sie im Browserfenster die Anmeldeinformationen ein bzw. wählen Sie diejenigen aus, die Sie zur Authentifizierung verwenden möchten.

Um eine Verbindung als anderer Benutzender herzustellen, führen Sie den Disconnect-AzAccount-Befehl aus und versuchen Sie es erneut.

Code

Der Code für dieses Beispiel ist unter: PowerApps-Samples/dataverse/webapi/PS/FunctionsAndActions/FunctionsAndActions.ps1

Zeigt

Dieses Beispiel umfasst neun Regionen:

Abschnitt 1: Ungebundene Funktion WhoAmI

Vorgänge: Rufen Sie die WhoAmI-Funktion auf, um Informationen zum aktuellen Benutzer abzurufen.

Abschnitt 2: Ungebundene Funktion FormatAddress

Vorgänge:

  • Rufen Sie die FormatAddress-Funktion mit Parametern für eine Adresse in den USA auf.
  • Rufen Sie dieselbe Funktion mit Parametern für eine Adresse in Japan auf, um unterschiedliche Formatierungen zu veranschaulichen.

Abschnitt 3: Ungebundene Funktion InitializeFrom

Vorgänge:

  • Erstellen Sie einen Kontodatensatz als ursprünglichen Datensatz.
  • Rufen Sie die InitializeFrom-Funktion auf, um Daten für einen neuen Datensatz basierend auf dem Original abzurufen.
  • Erstellen Sie einen neuen Kontodatensatz mit den zurückgegebenen Daten von InitializeFrom.

Abschnitt 4: Ungebundene Funktion RetrieveCurrentOrganization

Vorgänge: Rufen Sie die RetrieveCurrentOrganization-Funktion auf, um Informationen zur aktuellen Organisation abzurufen.

Abschnitt 5: Ungebundene Funktion RetrieveTotalRecordCount

Vorgänge: Rufen Sie die RetrieveTotalRecordCount-Funktion auf, um die Gesamtanzahl der Datensätze für angegebene Tabellen abzurufen.

Abschnitt 6: Gebundene Funktion IsSystemAdmin Custom-API

Vorgänge:

  • Ermitteln, ob die sample_IsSystemAdmin benutzerdefinierte API in der Organisation installiert ist.
  • Wenn sie nicht installiert ist, importieren Sie die verwaltete Lösung, die die benutzerdefinierte API enthält.
  • Rufen Sie die Systembenutzerdatensätze ab, und testen Sie jeden mit der sample_IsSystemAdmin Funktion, um festzustellen, ob sie über die Sicherheitsrolle "Systemadministrator" verfügen.

Abschnitt 7: Ungebundene Aktion GrantAccess

Vorgänge:

  • Erstellen Sie einen freizugebenden Firmendatensatz.
  • Rufen Sie einen anderen aktivierten Benutzer als den aktuellen Benutzer ab.
  • Verwenden Sie die RetrievePrincipalAccess-Funktion , um die Zugriffsrechte des Benutzers zu überprüfen.
  • Verwenden Sie die GrantAccess-Aktion , um dem Benutzer zusätzliche Zugriffsrechte zu gewähren.
  • Überprüfen Sie, ob die Zugriffsrechte erneut gewährt wurden, indem Sie RetrievePrincipalAccess verwenden.

Abschnitt 8: Gebundene Aktion AddPrivilegesRole

Vorgänge:

  • Erstellen Sie eine Sicherheitsrolle, die der Geschäftseinheit des aktuellen Benutzers zugeordnet ist.
  • Rufen Sie die Rolle mit erweiterten Berechtigungen ab, um Standardberechtigungen anzuzeigen.
  • Abrufen von Informationen zu bestimmten Berechtigungen, die der Rolle hinzugefügt werden sollen.
  • Verwenden Sie die AddPrivilegesRole-Aktion , um der Rolle Berechtigungen hinzuzufügen.
  • Rufen Sie die Rolle erneut ab, um zu bestätigen, dass die Berechtigungen hinzugefügt wurden.

Abschnitt 9: Beispielaufzeichnungen löschen

Vorgänge: Ein Verweis auf jeden in diesem Beispiel erstellten Datensatz wurde einer Liste hinzugefügt, während sie erstellt wurde. Dieser Abschnitt durchläuft diese Liste und löscht jeden Datensatz.

Aufräumen

Standardmäßig löscht dieses Beispiel alle darin erstellten Datensätze. Wenn Sie die erstellten Datensätze nach Abschluss des Beispiels anzeigen möchten, ändern Sie die deleteCreatedRecords-Variable auf false und Sie werden aufgefordert, zu entscheiden, ob Sie die Datensätze löschen möchten.

Siehe auch

Verwenden der Dataverse-Web-API
Web-API-Funktionen verwenden
Nutzen von Web-API-Aktionen
Schnellstart-Web-API mit PowerShell und Visual Studio Code
PowerShell und Visual Studio Code mit der Dataverse-Web-API verwenden
Web API Beispiele
Web API-Funktionen- und Aktionen-Beispiel
Beispiel für Internet-API-Funktionen- und Aktionen (C#)
Beispiele von Web API-Funktionen und Aktionen (clientseitiges JavaScript)

  • Last updated on