Freigeben über

Web-API-Abfragedatenbeispiel (PowerShell)

In diesem PowerShell Version 7.4.0-Beispiel wird veranschaulicht, wie verschiedene Abfragevorgänge für Microsoft Dataverse-Tabellenzeilen mithilfe der Dataverse-Web-API ausgeführt werden. In diesem Beispiel werden die Dataverse-Vorgänge und die Konsolenausgabe implementiert, die im Web-API-Abfragedatenbeispiel 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 Repository Power Apps-Samples, oder laden Sie es herunter.

  2. Die QueryData.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 Benutzer herzustellen, führen Sie den Disconnect-AzAccount-Befehl aus, und versuchen Sie es erneut.

Code

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

Zeigt

Dieses Beispiel hat 11 Regionen:

Abschnitt 0: Abzufragende Datensätze erstellen

Vorgänge: Erstellen Sie einen Kontodatensatz mit verwandten Kontaktdatensätzen, und jeder Kontakt verfügt über verwandte Aufgabendatensätze. Dies sind die Beispieldaten, die während der gesamten Demonstration verwendet werden.

Abschnitt 1: Auswählen bestimmter Eigenschaften

Vorgänge:

  • Verwenden Sie $select die Systemabfrageoption, um bestimmte Eigenschaften abzurufen.
  • Fügen Sie Prefer: odata.include-annotations="*" Kopfzeile ein, um formatierte Werte abzurufen.

Abschnitt 2: Verwenden von Abfragefunktionen

Vorgänge:

  • Verwenden Sie Standardabfragefunktionen wie contains, endswith und startswith, um Ergebnisse zu filtern.
  • Verwenden Sie Dataverse-spezifische Abfragefunktionen wie LastXHours, , Last7Days, Today, Betweenund In.
  • Verwenden Von Filteroperatoren und logischen Operatoren (eq, ne, gt, and, or).
  • Legen Sie Die Rangfolge mithilfe von Klammern in Filterausdrücken fest.

Abschnitt 3: Bestellung und Aliase

Vorgänge:

  • Verwenden Sie $orderby, um Abfrageergebnisse zu sortieren.
  • Verwenden Sie parametrisierte Aliase mit $filter und $orderby, um Abfragen zu vereinfachen.

Abschnitt 4: Ergebnisse begrenzen und zählen

Vorgänge:

  • Wird $top verwendet, um die Anzahl der zurückgegebenen Ergebnisse zu begrenzen.
  • Dient $count zum Abrufen der Gesamtanzahl der Datensätze, die der Abfrage entsprechen.

Abschnitt 5: Paginierung

Vorgänge:

  • Verwenden Sie den Anforderungsheader Prefer: odata.maxpagesize , um die Seitengröße zu steuern.
  • Verwenden Sie die @odata.nextLink Anmerkung, um nachfolgende Seiten von Ergebnissen abzurufen.

Abschnitt 6: Erweitern der Ergebnisse

Vorgänge:

  • Verwenden Sie $expand mit einzelwertigen Navigationseigenschaften, um verwandte Datensätze einzuschließen.
  • Verwenden Sie $expand mit sammlungswertigen Navigationseigenschaften.
  • Verwenden Sie $expand mit mehreren Navigationseigenschaften in einer einzigen Anforderung.
  • Verwenden Sie geschachtelten $expand, um mehrere Ebenen verwandter Datensätze abzurufen.

Abschnitt 7: Aggregieren von Ergebnissen

Verwenden Sie $apply=aggregate mit Funktionen wie average, sum, min und max, um Aggregatwerte zu berechnen.

Abschnitt 8: FetchXML-Abfragen

Vorgänge:

  • Senden von Anforderungen mithilfe von FetchXML mit dem fetchXml Abfragezeichenfolgenparameter.
  • Verwenden Sie das Paging mit FetchXML und den Attributen page und count.

Abschnitt 9: Verwenden vordefinierter Abfragen

Vorgänge:

  • Führen Sie eine gespeicherte Abfrage (Systemansicht) mithilfe des Parameters aus savedQuery .
  • Führen Sie eine Benutzerabfrage (gespeicherte Ansicht) mithilfe des Parameters aus userQuery .

Abschnitt 10: 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 in false. Sie werden dann aufgefordert, zu entscheiden, ob Sie die Datensätze löschen möchten.

Siehe auch

Verwenden der Dataverse-Web-API
Datenabfrage mit Web-API
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-Abfragedatenbeispiel
Beispiel fürWeb API-Abfragedaten (C#)
Web-API-Abfragedatenbeispiel (clientseitiges JavaScript)

  • Last updated on