Starten Sie ein Microsoft Dataverse Web-API-Projekt in Visual Studio (C#).

Artikel
05/09/2023

In diesem Thema wird gezeigt, wie Sie ein neues Projekt in Visual Studio 2017 (oder späater) erstellen, das eine Konsolenanwendung erstellt, die die Dataverse Web API verwendet. Es zeigt die allgemeinen Verweise werden Projektressourcen, die die meisten Anwendungen, einschließlich den SDK-C#-Beispielen, verwenden, um Web-API-basierte Lösungen zu implementieren.

Voraussetzungen

Die folgenden Voraussetzungen sind zur Erstellung der Konsolenanwendung in diesem Abschnitt erforderlich.

Visual Studio 2017 auf Ihrem Entwicklungsrechner installiert. Jede Edition, inkl. Visual Studio Express, sollte ausreichend sein, um mit der Dataverse-Web-API zu arbeiten.
Es muss ein NuGet-Client installiert sein: entweder das Kommandozeilenprogramm oder die Erweiterung Visual Studio. Weitere Informationen finden Sie unter Installation von NuGet.

Erstellen eines Projekts

Die folgende Vorgehensweise zeigt, wie Sie ein Konsolenanwendungsprojekt in C# erstellen, das das Framework Microsoft .NET verwendet.

Neues Projekt

Klicken Sie in Visual Studio auf Neues Projekt. Das Dialogfeld Neues Projekt wird angezeigt.
Wählen Sie im linken Navigationsbereich unter Vorlagen die Option Visual C# aus.
Über der Liste verfügbarer Vorlagen, wählen Sie .NET Framework 4.6.2.
Wählen Sie aus der Vorlagenliste Konsolen-App (.NET Framework) aus. (Alternativ wählen Sie den Projekttyp aus, der aus, der Ihrer Lösung entspricht). Alle Web API C#-Beispiele sind Konsolenanwendungen.
Geben Sie für das Projekt in den Feldern in der Nähe des unteren Bereichs des Formulars einen Speicherort und einen Namen an, und wählen Sie dann OK aus. (In diesem Thema wurde der Lösungsname „StartWebAPI-CS“ verwendet.) Die Ausgangslösungsdateien werden generiert und die Lösung wird in Visual Studio geladen.
Öffnen Sie im Menü Projekt das Eigenschaftenformular des Projekts und überprüfen Sie, ob das Zielframework auf .NET Framework 4.6.2 festgelegt ist.

Installieren und prüfen der erforderlichen Assembly-Verweise

Nachdem das Projekt geöffnet wird, klicken Sie auf Extras in der Steuerleiste oben in Ihrem Projekt. Wählen Sie NuGet Paketmanager > Paketmanager-Konsole und installieren Sie die folgenden NuGet Pakete.

install-package Newtonsoft.Json
install-package System.Net.Http

Erweitern Sie im Lösungs-Explorer den Knoten Referenzen.
Bestätigen Sie, dass alle erforderlichen Verweise zum Projekt hinzugefügt wurden.
Wenn Sie zusätzliche Funktionalitäten nutzen, die Sie routinemäßig in den Anwendungen verwenden, können Sie die zugeordneten Verweise auf die erforderlichen Assemblys jetzt hinzufügen. Weitere Informationen finden Sie unter Anleitung: Hinzufügen oder Entfernen von Verweisen über das 'Verweise Hinzufügen-Dialogfeld'..

Da die Dataverse-Web-API auf REST-Prinzipien basiert, benötigt sie keine clientseitigen Assemblys für den Zugriff. Allerdings werden diese von andere APIs, die von Dataverse-Apps unterstützt werden, benötigt.

Hinzufügen typische Using-Anweisungen

Öffnen Sie im Lösungs-Explorer die Datei Program.cs zum Bearbeiten.
Fügen Sie oben in der Datei können die folgenden using-Anweisungen hinzu. Diese Namespaces werden im Allgemeinen in Dataverse-Web-API-basierten Lösungen verwendet.
```
using Newtonsoft.Json;  
using Newtonsoft.Json.Linq;  
using System.Net.Http;  
using System.Net.Http.Headers;
```
Wenn Sie routinemäßig verwendete Assemblys oder Verweise in den vorherigen Abschnitten hinzugefügt haben, sollten Sie die Entsprechenden using-Anweisungen für diese Ressourcen hinzufügen.
Speichern Sie die Datei.

Verbindungscode hinzufügen

In diesem Abschnitt wird beschrieben, wie eine grundlegende Einstellungen und Anweisungen für diese Vorgänge hinzufügen.

Bearbeiten der Anwendungskonfigurationsdatei

Öffnen Sie im Lösungs-Explorer die Datei App.config zum Bearbeiten. Fügen Sie die folgenden zwei Abschnitte nach dem vorhandenen <startup>-Abschnitt hinzu, und speichern Sie die Datei.


<connectionStrings>  
    <clear />  

    <!-- When providing a password, make sure to set the app.config file's security so that only you can read it. -->  
    <add name="default"   connectionString="Url=https://myserver/myorg/; Username=name; Password=password; Domain=domain" />  
    <add name="CrmOnline" connectionString="Url=https://mydomain.crm.dynamics.com/; Username=someone@mydomain.onmicrosoft.com; Password=password" />  
  </connectionStrings>  

  <appSettings>  
    <!--For information on how to register an app and obtain the ClientId and RedirectUrl  
        values see https://msdn.microsoft.com/dynamics/crm/mt149065 -->  
    <!--Active Directory application registration. -->  
    <!--These are dummy values and should be replaced with your actual app registration values.-->  
    <add key="ClientId" value="e5cf0024-a66a-4f16-85ce-99ba97a24bb2" />  
    <add key="RedirectUrl" value="https://localhost/SdkSample" />  

    <!-- Use an alternate configuration file for connection string and setting values. This optional setting  
    enables use of an app.config file shared among multiple applications. If the specified file does  
    not exist, this setting is ignored.-->  
    <add key="AlternateConfig" value="C:\Temp\crmsample.exe.config"/>  
  </appSettings>

Wenn Sie eine Lösung entwickeln oder bereitstellen, müssen die tatsächlichen und Anwendungsregistrierungswerte statt der Beispielsplatzhalterwerte verwendet werden.

Nächste Schritte

An dieser Stelle kann die Lösung ohne Fehler erstellt werden. Wenn Sie die Anwendungskonfigurationsdatei bearbeiten, um Werte für Dynamics 365 Server bereitzustellen, sollten sich das Programm mit diesem Server verbinden. Die Lösung stellt einen grundlegenden Rahmen dar, der für benutzerdefinierten Code verwendet werden kann (inkl. Aufrufe der Dataverse-Web-API).

Tipp

Bevor Sie das Thema verlassen, sollten Sie darüber nachdenken, das Projekt als Projektvorlage zu speichern. Sie können die Vorlage dann wieder für zukünftige Lernprojekte verwenden und sich etwas Zeit und Aufwand bei der Erstellung neue Projekte ersparen. Wählen Sie dazu im Menü Datei die Option Exportvorlage, aus, während das Projekt in Microsoft Visual Studio geöffnet ist. Befolgen Sie Anweisungen des Vorlagenexportassistenten zum Erstellen der Vorlage.

Siehe auch

Erste Schritte mit dem Web API (C#)
Verwenden der Web API Helper Library (C#)
Vorgänge mithilfe der Web-API ausführen

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

Freigeben über