Freigeben über


Beispiel grundlegender Web-API-Operationen (PowerShell)

Dieses Beispiel der PowerShell-Version 7.4.0 zeigt, wie allgemeine Datenvorgänge mithilfe der Dataverse-Web-API und Visual Studio Code durchgeführt werden. Dieses Beispiel implementiert die Dataverse-Vorgänge und die Konsolenausgabe, die unter Beispiel grundlegender Web-API-Vorgänge beschrieben ist.

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.

Anforderungen

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 Terminal-Menü Neues Terminal aus.

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

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

    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 BasicOperations.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

Sie finden den Code für dieses Beispiel unter: PowerApps-Samples/dataverse/webapi/PS/BasicOperations/BasicOperations.ps1

Veranschaulichung

Dieses Beispiel umfasst fünf Regionen:

Abschnitt 1: Grundlegendes Erstellen und Aktualisieren von Vorgängen

Vorgänge:

  • Erstellen Sie einen Kontaktdatensatz.
  • Aktualisieren Sie die Kontaktdatensatz.
  • Rufen Sie den Kontaktdatensatz ab.
  • Aktualisieren Sie eine einzelne Eigenschaft des Kontaktdatensatzes.
  • Rufen Sie eine einzelne Eigenschaft des Kontaktdatensatzes ab.

Abschnitt 2: Ein mit einem anderen Datensatz verknüpften Datensatz erstellen

Vorgänge: Verknüpfen Sie einen neuen Datensatz mit einem vorhandenen.

Vorgänge: Erstellen Sie die folgenden Einträge in einem Vorgang: ein Konto, seinen zugeordneten primären Kontakt und offene Aufgaben für diesen Kontakt. Diese Entitätstypen haben die folgenden Beziehungen:

Accounts
    |---[Primary] Contact (N-to-1)
        |---Tasks (1-to-N)

Abschnitt 4: Datensätze zuordnen und Zuordnung aufheben

Vorgänge:

  • Fügen Sie der contact_customer_accounts-Sammlung des Kontos einen Kontakt hinzu.
  • Entfernen Sie einen Kontakt aus der contact_customer_accounts-Sammlung des Kontos.
  • Ordnen Sie einem Benutzer ein Sicherheitsrolle zu, indem Sie die systemuserroles_association-Sammlung verwenden.
  • Entfernen Sie eine Sicherheitsrolle für einen Benutzer, indem Sie die systemuserroles_association-Sammlung verwenden.

Abschnitt 5: 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.

Bereinigung

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

Dataverse-Web-API verwenden
Schnellstart-Web-API mit PowerShell und Visual Studio Code
PowerShell und Visual Studio Code in der Dataverse-Web-API verwenden
Erstellen einer Tabellenzeile über die Web-API
Aktualisieren und Löschen von Tabellenzeilen über die Web-API
Abrufen einer Tabellenzeile mit der Web-API
Web API Beispiele
Beispiel grundlegender Web-API-Operationen

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).