Dataverse CLI-Referenz (Vorschau)

Note

  • Dies ist eine Vorschaufunktion.
  • Funktionen in der Vorschauversion sind nicht für den Produktionseinsatz gedacht und können eine eingeschränkte Funktionalität aufweisen. Diese Funktionen sind vor einer offiziellen Veröffentlichung verfügbar, damit Kunden frühzeitig zugreifen und Feedback geben können.

In diesem Artikel werden die Befehle beschrieben, die in der Dataverse CLI verfügbar sind. Jeder Befehl unterstützt eine --help Option, die seine Verwendung, Optionen und Beispiele auflistet. Befehle, die Daten zurückgeben, unterstützen eine --json Option für die unformatierte JSON-Ausgabe, die in Skripts nützlich ist.

Die folgenden globalen Optionen können mit jedem beliebigen Befehl verwendet werden:

Auswahl Description
--log-level <level> Legen Sie die Protokollierungsebene fest: Trace, , Debug, Information, Warning, , oder ErrorCritical. Standardwert: Warning.
--log-file Melden Sie sich in einer Datei im temporären Verzeichnis anstelle der Konsole an.
--context <value> Der An den Benutzer-Agent angefügte Vorgangskontext. Sie können auch die Umgebungsvariable DATAVERSE_OPERATION_CONTEXT festlegen.
Command Description
api describe Beschreiben einer API
api invoke Aufrufen einer API anhand des Namens
api list Auffindbare APIs auflisten
api request Senden einer authentifizierten HTTP-Anforderung
auth create Erstellen eines neuen Authentifizierungsprofils
auth list Auflisten aller Authentifizierungsprofile
auth remove Entfernen eines Authentifizierungsprofils
auth select Auswählen des aktiven Authentifizierungsprofils
auth who Anzeigen des aktuellen Authentifizierungsprofils
data associate Verknüpfen von zwei Datensätzen über eine Beziehung
data count Zählen von Datensätzen in einer Tabelle
data create Neuen Datensatz erstellen
data delete Löschen eines Datensatzes
data describe Beschreiben des Schemas einer Entität
data disassociate Entfernen einer Beziehung zwischen zwei Datensätzen
data get Abrufen eines einzelnen Datensatzes nach ID oder alternativem Schlüssel
data query Ausführen einer OData-, FetchXML- oder SQL-Abfrage
data update Vorhandenen Datensatz aktualisieren
data upload Hochladen einer Datei in eine Dateispalte in einem vorhandenen Datensatz
data upsert Erstellen oder Aktualisieren eines Datensatzes anhand eines alternativen Schlüssels
erp batch cancel Abbrechen eines Batchauftrags für Finanzen und Vorgänge
erp batch list Batchaufträge für Finanz- und Betriebsvorgänge auflisten
install Installieren einer bestimmten Version oder Aktualisieren auf die neueste Version
mcp Starten des MCP-Servers für Dataverse oder ERP
mcp allow Zulassen einer App als MCP-Client
org list Auflisten aller barrierefreien Umgebungen
org who Aktuelle Organisations- und Benutzerinformationen anzeigen
skill delete Löschen einer Fähigkeit aus Dataverse
skill download Herunterladen einer Fähigkeit von Dataverse
skill list Auflisten aktiver Fähigkeiten in der Umgebung
skill upload Hochladen einer Fähigkeit auf Dataverse

Note

Viele Befehle unterstützen eine --target <dataverse\|erp> Option, mit der der Vorgang an Dataverse (Standard) oder an die verknüpfte ERP-Umgebung (Finance and Operations) weitergeleitet wird. Befehle, die eine Verbindung mit einer Umgebung herstellen, unterstützen eine --environment <url> (-env) Option zum Überschreiben der Umgebungs-URL des aktuellen Profils.

api describe-Befehl

Zeigen Sie die Metadaten für eine einzelne API an. Bei benutzerdefinierten Dataverse-APIs enthält die Ausgabe Anforderungsparameter- und Antworteigenschaftenbeschreibungen, wenn die Metadaten sie bereitstellen.

Dataverse-Namen sind standardmäßig nicht eingestellt. Sie können ERP-qualifizierte Namen im Formular erp:ServiceGroup/Service/Operationverwenden.

api describe Parameter

Parameter Description
--target Auflösen eines nicht qualifizierten Namens gegen dataverse oder erp.
--service-group Nur ERP. Einschränken der Vorgangssuche auf eine Dienstgruppe.
--service Nur ERP. Einschränken der Vorgangssuche auf einen Dienst.
--environment Überschreiben Sie die Dataverse-Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für api describe

dataverse api describe sample_CustomAPIExample
dataverse api describe msdyn_DoesKBExist
dataverse api describe GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService

api invoke-Befehl

Rufen Sie eine ermittelte API anhand des Namens auf. Verwenden Sie name=value syntax für Parameter. Wenn ein Wert Leerzeichen enthält, geben Sie das gesamte Token an. Einige Dataverse-APIs akzeptieren einen Zeichenfolgenparameter, deren Inhalt selbst JSON ist. Übergeben Sie in diesem Fall den JSON-Text als Wert, indem Sie die normalen Quoting- und Escaperegeln der Shell verwenden.

Standardmäßig werden JSON-Antworten in einem benutzerfreundlichen Textformat gerendert, das die Namen der Ausgabeeigenschaft behält. Wird verwendet --json , um die unformatierte JSON-Nutzlast beizubehalten.

api invoke Parameter

Parameter Description
--target Auflösen eines nicht qualifizierten Namens gegen dataverse oder erp.
--service-group Nur ERP. Einschränken der Vorgangssuche auf eine Dienstgruppe.
--service Nur ERP. Einschränken der Vorgangssuche auf einen Dienst.
--param Fügen Sie einen benannten Parameter in name=value Form hinzu. Wiederholbar.
--bind Der Bindungspfad für entitätsgebundene Dataverse-APIs.
--method, -X Überschreiben Sie die abgeleitete HTTP-Methode.
--body Verwenden Sie einen unformatierten JSON-Text anstelle von benannten Parametern.
--body-file Lesen Eines unformatierten JSON-Texts aus einer Datei.
--header, -H Fügen Sie einen HTTP-Header in key:value Form hinzu.
--include, -i Fügen Sie den Antwortstatus und Die Kopfzeilen ein.
--environment Überschreiben Sie die Dataverse-Umgebungs-URL.
--json Ausgabe von unformatiertem JSON anstelle von Anzeigetext.

Beispiele für api invoke

Rufen Sie eine Dataverse-Funktion auf. Dieses Beispiel zeigt die Verwendung der funktion Dynamics 365 Contact Center CCaaS_GetPresence.

dataverse api invoke CCaaS_GetPresence ApiVersion=1.0

Rufen Sie die Dataverse AISummarize-Aktion mit Leerzeichen in einem Parameterwert auf:

dataverse api invoke AISummarize "Text=The customer reported intermittent login failures..."

Aufrufen eines benutzerdefinierten ERP-Diensts:

dataverse api invoke GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService

api list-Befehl

Auflisten auffindbarer APIs, z. B. benutzerdefinierte Dataverse-APIs und ERP-aufrufbare Dienstendpunkte. Die Ergebnisse zeigen die API-Identität, den Anzeigenamen, die Art und die Beschreibung an, wenn verfügbar. Sie können einen optionalen Abfrageausdruck übergeben, um die Ergebnisse zu filtern.

api list Parameter

Parameter Description
--target Das zu durchsuchende Zielsystem: dataverse (Standard) oder erp.
--service-group Nur ERP. Filtert nach einer einzelnen Dienstgruppe.
--service Nur ERP. Filtert auf einen einzelnen Dienst.
--limit Die maximale Anzahl der zurückzugebenden APIs. Standardwert: 50.
--page Die 1-basierte Seitenzahl beim Auslagerung der Ergebnisse. Standardwert: 1.
--environment Überschreiben Sie die Dataverse-Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für api list

dataverse api list
dataverse api list invoice --target dataverse
dataverse api list --target erp GetUserSessionInfo
dataverse api list --target erp --service-group UserSessionService --service AifUserSessionService

api request-Befehl

Senden Sie eine unformatierte authentifizierte HTTP-Anforderung an Dataverse oder ERP. Verwenden Sie diesen Befehl, wenn Sie vollzugriff auf den Pfad, die Methode, die Kopfzeilen und den Textkörper benötigen.

api request Parameter

Parameter Description
--target Das Zielsystem: dataverse oder erp. Erforderlich.
--path Der Anforderungspfad. Erforderlich.
--method, -X Die HTTP-Methode. Standard: GET, oder POST wenn ein Textkörper angegeben wird.
--body Ein Inline-JSON-Anforderungstext.
--body-file Eine Datei, die einen JSON-Objektanforderungstext enthält.
--header, -H Fügen Sie einen HTTP-Header in key:value Form hinzu.
--include, -i Fügen Sie den Antwortstatus und Die Kopfzeilen ein.
--environment Überschreiben Sie die Dataverse-Umgebungs-URL.

Beispiele für api request

dataverse api request --target dataverse --path /api/data/v9.2/sample_CustomAPIExample --body "{\"Input\":\"value\"}"
dataverse api request --target erp --path /api/services/UserSessionService/AifUserSessionService/GetUserSessionInfo --body "{}"

auth create-Befehl

Erstellen Sie ein neues Authentifizierungsprofil.

auth create Parameter

Verwenden Sie diese Parameter, um das Verhalten des auth create Befehls anzugeben.

Parameter Description
--environment, -env Die URL für die Dataverse-Umgebung, mit der Sie sich authentifizieren möchten.
--name, -n Optionaler Name für das Profil. Verwenden Sie den Namen, um das Profil später auszuwählen.
--cloud, -ci Die Zielcloud: Public, UsGov, , UsGovHigh, UsGovDod, oder China.
--deviceCode, -dc Verwenden Sie den Gerätecodeauthentifizierungsfluss für Umgebungen ohne Browser.
--username, -un Der Benutzername für die Authentifizierung mit Benutzername und Kennwort.
--password, -p Das Kennwort für die Benutzernamen- und Kennwortauthentifizierung.
--applicationId, -id Die Anwendungs-ID (Client-ID) für die Dienstprinzipalauthentifizierung (SPN).
--clientSecret, -cs Der geheime Clientschlüssel für die Dienstprinzipalauthentifizierung.
--certificateDiskPath, -cdp Der Pfad zu einer PFX-Zertifikatdatei für die zertifikatbasierte Authentifizierung.
--certificatePassword, -cp Das Kennwort für das Zertifikat.
--tenant, -t Die Mandanten-ID. Erforderlich für die Dienstprinzipalauthentifizierung.
--managedIdentity, -mi Verwenden Sie eine Azure verwaltete Identität.
--githubFederated, -ghf Verwenden Sie GitHub Actions Verbundauthentifizierung.
--azureDevOpsFederated, -adof Verwenden Sie Azure DevOps Verbundauthentifizierung.
--clientid, -cid Eine benutzerdefinierte Microsoft Entra App-Client-ID, die anstelle der standardmäßigen Dataverse CLI-App verwendet werden soll.
--no-default-environment Legen Sie die Umgebung nicht als Standard fest.
--accept-cleartext-caching Zulassen eines Nur-Text-Tokencaches unter Linux.

Beispiele für auth create

Die folgenden Beispiele veranschaulichen die Verwendung des auth create Befehls.

Interaktive Authentifizierung

Mit diesem Befehl wird ein Browser- oder Systemdialogfeld für zusätzliche Informationen geöffnet.

dataverse auth create --environment https://myorg.crm.dynamics.com

Benanntes Profil

Erstellen Sie ein Profil mit einem bestimmten Namen.

dataverse auth create --environment https://myorg.crm.dynamics.com --name prod

Gerätecodefluss

Verwenden Sie den Gerätecodefluss für Umgebungen ohne Browser.

dataverse auth create --environment https://myorg.crm.dynamics.com --deviceCode

Dienstprinzipal mit Clientgeheimnis

Verwenden Sie einen Dienstprinzipal, wenn Sie eine unbeaufsichtigte Authentifizierung benötigen, z. B. in einer CI/CD-Pipeline oder einem anderen automatisierten Skript, bei dem die interaktive Anmeldung nicht möglich ist. Geben Sie die Anwendungs-ID, den geheimen Clientschlüssel und die Mandanten-ID einer App-Registrierung an, die Zugriff auf die Umgebung hat.

dataverse auth create --applicationId <appId> --clientSecret <secret> --tenant <tenantId>

Benutzerdefinierte Entra-App-Client-ID

Verwenden Sie ihre eigene App-Registrierung anstelle der Standardeinstellung.

dataverse auth create --environment https://myorg.crm.dynamics.com --clientid <your-app-guid>

auth list-Befehl

Listet alle Authentifizierungsprofile auf. Für die unformatierte JSON-Ausgabe hinzufügen --json .

Beispiele für auth list

dataverse auth list
dataverse auth list --json

auth remove-Befehl

Entfernen Sie ein oder alle Authentifizierungsprofile.

auth remove Parameter

Parameter Description
--index, -i Entfernen Sie das Profil mit dem angegebenen 1-basierten Index, wie in auth list.
--name, -n Entfernen Sie das Profil mit dem angegebenen Namen.
--all Entfernen Sie alle Profile.

Beispiele für auth remove

dataverse auth remove --index 1
dataverse auth remove --name prod
dataverse auth remove --all

auth select-Befehl

Wählen Sie das aktive Authentifizierungsprofil aus. Führen Sie den Befehl ohne Optionen aus, um alle Profile auflisten zu können.

auth select Parameter

Parameter Description
--index, -i Wählen Sie das Profil anhand des 1-basierten Indexes aus, wie in .auth list
--name, -n Wählen Sie das Profil anhand des Namens aus.

Beispiele für auth select

Öffnen Sie eine interaktive Auswahl. Verwenden Sie die Pfeiltasten, oder geben Sie Folgendes ein, um zu filtern:

dataverse auth select

Wählen Sie ein Profil nach Index oder nach Name aus:

dataverse auth select --index 1
dataverse auth select --name prod

auth who-Befehl

Anzeigen des aktuellen aktiven Authentifizierungsprofils. Für die unformatierte JSON-Ausgabe hinzufügen --json .

Beispiele für auth who

dataverse auth who
dataverse auth who --json

data associate-Befehl

Zuordnen von zwei Datensätzen über eine Navigationseigenschaft (Beziehung). Dieser Befehl wird nur für Dataverse unterstützt.

data associate Parameter

Parameter Description
--table, -t Der Entitätssatzname des primären Datensatzes. Erforderlich.
--id, -i Die GUID des primären Datensatzes. Erforderlich.
--relationship, -rel Der Name der Navigationseigenschaft. Erforderlich.
--related Der Entitätssatzname der verknüpften Tabelle. Erforderlich.
--related-id Die GUID des zugehörigen Datensatzes. Erforderlich.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data associate

dataverse data associate --table accounts --id <guid> --relationship contact_customer_accounts --related contacts --related-id <related-guid>

data count-Befehl

Zählen Sie die Datensätze in einer Tabelle, optional gefiltert.

data count Parameter

Parameter Description
--table, -t Der Entitätssatzname. Erforderlich, es sei denn, Sie verwenden --fetchxml.
--filter, -f Ein OData-Ausdruck $filter .
--fetchxml Eine FetchXML-Aggregatabfrage für komplexe Anzahlen.
--target Route zu dataverse (Standard) oder der verknüpften erp Umgebung.
--cross-company Nur ERP. Zählen Sie für alle Unternehmen. Standard: Das Standardunternehmen des Benutzers.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data count

dataverse data count --table accounts
dataverse data count --target erp --table Currencies --filter "CurrencyCode eq 'AED'"

data create-Befehl

Erstellen Sie einen neuen Datensatz in einer Dataverse-Tabelle. Legen Sie Nachschlagespalten mithilfe der @odata.bind Syntax fest.

data create Parameter

Parameter Description
--table, -t Der Entitätssatzname. Erforderlich.
--data, -d Ein JSON-Objekt mit den Feldwerten.
--data-file Der Pfad zu einer JSON-Datei mit den Datensatzdaten.
--return, -r Gibt den vollständig erstellten Datensatz zurück.
--target Route zu dataverse (Standard) oder der verknüpften erp Umgebung.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data create

dataverse data create --table accounts --data '{"name":"Contoso"}'
dataverse data create --table contacts --data '{"firstname":"Alice","parentcustomerid_account@odata.bind":"accounts(<guid>)"}'

Tip

Wird für komplexe JSON-Dateien verwendet --data-file . Dient --return --json zum Abrufen des vollständig erstellten Datensatzes.

data delete-Befehl

Löschen Sie einen einzelnen Datensatz anhand des Primärschlüssels oder eines alternativen Schlüssels.

data delete Parameter

Parameter Description
--table, -t Der Entitätssatzname. Erforderlich.
--id, -i Die Datensatz-GUID.
--key, -k Eine alternative Taste.
--no-confirm Überspringen Sie die Bestätigungsaufforderung.
--target Route zu dataverse (Standard) oder der verknüpften erp Umgebung.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data delete

dataverse data delete --table accounts --id 00000000-0000-0000-0000-000000000001 --no-confirm

data describe-Befehl

Beschreiben des Schemas einer OData-Entität. Bei Dataverse ruft EntityDefinitions(LogicalName='<table>') der Befehl mit $expand der Steuerung und --includeeinem zweiten Aufruf an, wann customapis--include actions festgelegt wird. Integrierte Dataverse-Aktionen wie Assign z. B. und SetState werden nicht aufgezählt. Für ERP gibt ein einzelner Aufruf Eigenschaften /Metadata/PublicEntities , gebundene Aktionen und Navigationen zusammen zurück.

data describe Parameter

Parameter Description
--target Das Ziel: dataverse (Standard) oder erp.
--table, -t Erforderlich. Für Dataverse, den logischen Namen, z account. B. . Für ERP, der Entitätssatzname, z BatchJobs. B. .
--include Eine durch Trennzeichen getrennte Liste von Abschnitten, die eingeschlossen werden sollen: entity, properties, , , relations, actionsoder all. Aliase: attributes=properties, relationships=relations. Standard für ERP: all. Standard für Dataverse: entity,properties.
--json Ausgabe roher JSON-Code.

Beispiele für data describe

dataverse data describe --table account
dataverse data describe --target dataverse --table account --include all
dataverse data describe --target erp --table BatchJobs

data disassociate-Befehl

Entfernen einer Beziehung zwischen zwei Datensätzen. Dieser Befehl wird nur für Dataverse unterstützt.

data disassociate Parameter

Parameter Description
--table, -t Der Entitätssatzname des primären Datensatzes. Erforderlich.
--id, -i Die GUID des primären Datensatzes. Erforderlich.
--relationship, -rel Der Name der Navigationseigenschaft. Erforderlich.
--related-id Die GUID des verknüpften Datensatzes für eine m:n-Beziehung. Lassen Sie diesen Parameter aus, um einen Nachschlagevorgang zu löschen.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data disassociate

dataverse data disassociate --table accounts --id <guid> --relationship contact_customer_accounts --related-id <related-guid>

data get-Befehl

Abrufen eines einzelnen Datensatzes anhand seiner ID (Primärschlüssel) oder eines alternativen Schlüssels.

data get Parameter

Parameter Description
--table, -t Der Entitätssatzname. Erforderlich.
--id, -i Die Datensatz-GUID (Primärschlüssel).
--key, -k Ein alternativer Schlüssel, z. B "col='val'". .
--select, -s Eine durch Trennzeichen getrennte Liste von Spalten ($select).
--expand, -x Ein OData-Ausdruck $expand für verwandte Datensätze.
--target Route zu dataverse (Standard) oder der verknüpften erp Umgebung.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data get

dataverse data get --table accounts --id 00000000-0000-0000-0000-000000000001
dataverse data get --target erp --table Currencies --key "CurrencyCode='AED'" --select "CurrencyCode,Name"

data query-Befehl

Führen Sie eine OData-, FetchXML- oder SQL-Abfrage für eine Dataverse-Tabelle aus.

data query Parameter

Parameter Description
--table, -t Der Entitätssatzname für die Abfrage. Erforderlich für OData-Abfragen.
--select, -s Eine durch Trennzeichen getrennte Liste von Spalten ($select).
--filter, -f Ein OData-Ausdruck $filter .
--orderby, -o Ein OData-Ausdruck $orderby .
--top Die maximale Anzahl der zurückzugebenden Datensätze (1-5000).
--expand, -x Ein OData-Ausdruck $expand für verwandte Datensätze.
--fetchxml Eine Inline-FetchXML-Abfrage.
--fetchxml-file Der Pfad zu einer Datei, die eine FetchXML-Abfrage enthält.
--sql Eine SQL-Abfrage SELECT (Vorschau).
--sql-file Der Pfad zu einer Datei, die eine SQL-Abfrage enthält.
--all, -a Folgen Sie der Paginierung, um alle Datensätze abzurufen.
--max-records Die maximale Anzahl von Datensätzen, die bei Verwendung --allabgerufen werden sollen. Standardwert: 100000.
--target Route zu dataverse (Standard) oder der verknüpften erp Umgebung.
--cross-company Nur ERP. Fragen Sie alle Unternehmen ab. Standard: Das Standardunternehmen des Benutzers.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data query

dataverse data query --table accounts --select "name,revenue" --filter "revenue gt 1000000"
dataverse data query --fetchxml "<fetch><entity name='account'><attribute name='name'/></entity></fetch>"
dataverse data query --sql "SELECT name, revenue FROM account WHERE revenue > 1000000"
dataverse data query --target erp --table Currencies --select "CurrencyCode,Name" --top 10

Weitere Informationen

data update-Befehl

Aktualisieren Sie ein oder mehrere Felder für einen vorhandenen Datensatz, der durch die ID oder einen alternativen Schlüssel identifiziert wird. Legen Sie Nachschlagespalten mithilfe der @odata.bind Syntax fest.

data update Parameter

Parameter Description
--table, -t Der Entitätssatzname. Erforderlich.
--id, -i Die Datensatz-GUID.
--key, -k Eine alternative Taste.
--data, -d Ein JSON-Objekt mit den zu aktualisierenden Feldern.
--data-file Der Pfad zu einer JSON-Datei mit den Updatedaten.
--return, -r Gibt den vollständig aktualisierten Datensatz zurück.
--target Route zu dataverse (Standard) oder der verknüpften erp Umgebung.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data update

dataverse data update --table accounts --id 00000000-0000-0000-0000-000000000001 --data '{"name":"Contoso (updated)"}'

data upload-Befehl

Laden Sie eine lokale Datei in eine Dataverse-Dateispalte in einen vorhandenen Datensatz hoch. Der Befehl wählt automatisch basierend auf der Dateigröße eine einzelne Anforderung oder einen blockierten Upload aus, es sei denn, Sie geben an --mode. Im automatischen Modus werden Dateien unter 128 MB in einer einzigen Anforderung hochgeladen, und größere Dateien verwenden einen blockierten Upload. Wenn Sie weglassen --mime-type, leitet der Befehl den MIME-Typ aus der Dateierweiterung ab. Unbekannte Erweiterungen standardmäßig auf application/octet-stream.

data upload Parameter

Parameter Description
--table, -t Das Tabellenschema oder der logische Name, z account. B. . Erforderlich. Mit dem Befehl wird der Entitätssatz aus Metadaten aufgelöst.
--id, -i Die Datensatz-GUID. Erforderlich.
--column, -c Der Dateispalten-Attributname. Erforderlich.
--file, -f Der Pfad zur lokalen Datei. Erforderlich.
--mode, -m Die Uploadstrategie: auto (Standard), smalloder chunk.
--mime-type Ein expliziter MIME-Typ. Standard: abgeleitet von der Dateierweiterung.
--overwrite Überschreiben Sie eine vorhandene Datei. Standardmäßig schlägt der Befehl fehl, wenn die Spalte nicht leer ist.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data upload

dataverse data upload --table account --id <guid> --column new_document --file report.pdf
dataverse data upload -t account -i <guid> -c new_document -f photo.jpg --overwrite
dataverse data upload -t account -i <guid> -c new_document -f big.bin --mode chunk

data upsert-Befehl

Erstellen Sie einen Datensatz, wenn er nicht vorhanden ist, oder aktualisieren Sie ihn, falls dies der Fall ist. Der Datensatz wird durch einen alternativen Schlüssel identifiziert. Informationen zum Verwenden eines alternativen Schlüssels zum Verweisen auf einen Datensatz

data upsert Parameter

Parameter Description
--table, -t Der Entitätssatzname. Erforderlich.
--key, -k Eine alternative Taste. Erforderlich.
--data, -d Ein JSON-Objekt mit den Feldwerten.
--data-file Der Pfad zu einer JSON-Datei.
--update-only Schlägt fehl, wenn der Datensatz nicht vorhanden ist (If-Match: *).
--create-only Fehler, wenn der Datensatz bereits vorhanden ist (If-None-Match: *).
--return, -r Gibt den vollständigen Datensatz nach dem Vorgang zurück.
--target Route zu dataverse (Standard) oder der verknüpften erp Umgebung.
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für data upsert

dataverse data upsert --table accounts --key "accountnumber='ACC-100'" --data '{"name":"Contoso"}'

erp batch cancel-Befehl

Abbrechen eines Finanz- und Operations-Batchauftrags nach seinem RecId. Wird erp batch list verwendet, um die RecId.

Beispiele für erp batch cancel

dataverse erp batch cancel <recid>

erp batch list-Befehl

Auflisten von Batchaufträgen in der Finanz- und Betriebsinstanz, die mit Ihrer Dataverse-Umgebung verknüpft ist. Der Befehl erfordert ein Authentifizierungsprofil, das mit einer Dataverse-Umgebung verbunden ist, die über eine verknüpfte Finance and Operations-Instanz verfügt. Die FINANZ- und Betriebs-URL wird automatisch von der aktuellen Dataverse-Verbindung abgeleitet.

erp batch list Parameter

Parameter Description
--company Filtern nach juristischer Person (dataAreaId), z USMF. B. .
--status Filtern nach Status: Waiting, , Executing, Finished, , Erroroder Cancelled.
--top Die maximale Anzahl der zurückzugebenden Ergebnisse. Standardwert: 20.
--caption Filtern nach Beschriftung (Übereinstimmung der Teilzeichenfolge ohne Groß-/Kleinschreibung).
--json Ausgabe roher JSON-Code.

Beispiele für erp batch list

dataverse erp batch list
dataverse erp batch list --status Waiting
dataverse erp batch list --status Executing --top 20

install-Befehl

Installieren Sie eine bestimmte Version der Dataverse CLI, oder aktualisieren Sie sie auf die neueste Version. Der Befehl erkennt, ob Sie die CLI global installiert oder entsprechend installiert npx und installiert werden.

Beispiele für install

Installieren Sie die aktuelle Version:

dataverse install latest

Installieren Sie eine bestimmte Version:

dataverse install 1.0.0

mcp-Befehl

Startet einen MCP-Server (Model Context Protocol), der eine Verbindung mit Ihrer Umgebung herstellt, sodass KI-Assistenten wie Claude Desktop mit Ihren Daten interagieren können. Das Ziel wird automatisch von der URL erkannt: Eine Dataverse-URL startet den Dataverse MCP-Server und eine Finanz- und Betriebs-URL, z https://myorg.operations.dynamics.com. B. startet den ERP-MCP-Server.

mcp-Syntax

dataverse mcp <orgUrl> [options]

Das <orgUrl> Argument ist ihre Organisations-URL, z. B https://myorg.crm.dynamics.com. .

mcp Parameter

Parameter Description
--validate Überprüfen Sie die MCP-Endpunkte und die Authentifizierungseinrichtung, ohne den Server zu starten.
--log-level Legen Sie die Protokollierungsebene fest: Trace, , Debug, Information, Warning, , oder ErrorCritical. Standardwert: Warning.
--log-file Melden Sie sich bei einer Datei im temporären Verzeichnis an.
--preview Verwenden Sie den MCP-Vorschauendpunkt (api/mcp_preview anstelle von api/mcp). Wird für ERP nicht unterstützt.

Beispiele für mcp

Überprüfen des Setups (empfohlener erster Schritt):

dataverse mcp https://myorg.crm.dynamics.com --validate

Starten Sie den Server mithilfe des Stdiotransports:

dataverse mcp https://myorg.crm.dynamics.com

Verwenden Sie den Vorschauendpunkt, oder aktivieren Sie die Debugdateiprotokollierung:

dataverse mcp https://myorg.crm.dynamics.com --preview
dataverse mcp https://myorg.crm.dynamics.com --log-level Debug --log-file

mcp allow-Befehl

Stellen Sie sicher, dass sich eine Microsoft Entra Anwendung in der Liste der zugelassenen Dataverse MCP-Clients für die Umgebung des aktuellen Profils befindet. Dieser Befehl ist eine Alternative zum manuellen Administratorschritt, der in den Voraussetzungen beschrieben wird. Der authentifizierte Benutzer muss über Dataverse-Administratorberechtigungen für die Zielumgebung verfügen.

mcp allow-Syntax

dataverse mcp allow <appId> [options]

Das <appId> Argument ist die Anwendungs-ID (Client-ID), die als GUID zulässig ist.

mcp allow Parameter

Parameter Description
--erp Die Anwendung auf der verknüpften Finanz- und Operations-Instanz anstelle von Dataverse zulassen.

Beispiele für mcp allow

dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457
dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457 --erp

Note

Finance and Operations speichert die Zulassungsliste in AOS zwischen, sodass eine neu zulässige App-ID bis zu fünf Minuten in Kraft treten kann.

org list-Befehl

Auflisten aller Umgebungen, auf die Sie zugreifen können.

org list Parameter

Parameter Description
--filter Filtern Sie die Liste der Umgebungen nach einem Suchbegriff.
--json Ausgabe roher JSON-Code.

Beispiele für org list

dataverse org list
dataverse org list --filter contoso
dataverse org list --json

org who-Befehl

Zeigen Sie Informationen zur aktuellen Organisation und zum aktuellen Benutzer mithilfe des aktiven Authentifizierungsprofils an. Der env Befehl ist ein Alias für org.

org who Parameter

Parameter Description
--environment, -env Überschreiben Sie die Umgebungs-URL.
--json Ausgabe roher JSON-Code.

Beispiele für org who

dataverse org who
dataverse org who --environment https://myorg.crm.dynamics.com
dataverse org who --json

skill-Befehle

Verwalten Sie Dataverse-Fähigkeiten – wiederverwendbare Anweisungssätze (eine SKILL.md Datei und ihre Ressourcendateien), die KI-Agents verwenden – die in der verbundenen Umgebung gespeichert sind. Die Befehle auf oberster Ebene skill stellen Erstellungs-, Lese-, Aktualisierungs- und Löschvorgänge für die Umgebung bereit. Lokal werden Fähigkeiten unter .claude/skills/<name>/gespeichert.

Note

Qualifikationserstellungs- und Auswertungsbefehle, wie makez. B. , update, get, und eval, sind von diesen Befehlen getrennt. Wenn Sie hierzu weitere Informationen benötigen, führen Sie dataverse workspace skill --help aus.

skill delete-Befehl

Löschen Sie eine Fähigkeit und alle zugehörigen Ressourcen aus der aktiven Dataverse-Umgebung. Wird verwendet skill list , um einzigartige Fähigkeiten zu finden.

dataverse skill delete new_lead-qualification

skill download-Befehl

Laden Sie eine oder mehrere Fähigkeiten aus der aktiven Dataverse-Umgebung auf den Datenträger herunter. Der Befehl lädt die SKILL.md Datei und alle Ressourcendateien herunter, wobei die Verzeichnisstruktur erhalten bleibt. Wird verwendet skill list , um einzigartige Fähigkeiten zu finden.

Parameter Description
--all Laden Sie alle aktiven Fähigkeiten aus der Umgebung herunter. Kann nicht mit einem eindeutigen Namen kombiniert werden.
--output, -o Das Basisverzeichnis für die Ausgabe. Standardwert: .claude/skills/. Mit --all, jede Fähigkeit wird geschrieben in <path>/<name>/.
--json Geben Sie den Qualifikationsinhalt als JSON aus, ohne Dateien zu schreiben. Geben Sie optional einen Dateipfad an, in den geschrieben werden soll. 
dataverse skill download new_lead-qualification
dataverse skill download --all --output ./skills

skill list-Befehl

Auflisten aller aktiven Fähigkeiten in der verbundenen Dataverse-Umgebung.

Parameter Description
--resources, -r Listen Sie außerdem die Ressourcendateien für jede Fähigkeit auf.
--json Ausgabe als JSON. Geben Sie optional einen Dateipfad an, in den geschrieben werden soll. 
dataverse skill list
dataverse skill list --resources

skill upload-Befehl

Laden Sie eine oder mehrere Fähigkeiten vom Datenträger in die aktive Dataverse-Umgebung hoch. Der Befehl unterstützt Verzeichnisse, .zip Dateien, .skill-Dateien und MD-Dateien .

Sie können eine Fähigkeit <name>übergeben, die zu .claude/skills/<name>/einem Verzeichnis oder einer Datei aufgelöst <path> wird.

Parameter Description
--all Laden Sie alle Fähigkeiten unter .claude/skills/. Kann nicht mit einem Qualifikationsnamen oder Pfad kombiniert werden.
--json Ausgabe des Ergebnisses als JSON. Geben Sie optional einen Dateipfad an, in den geschrieben werden soll. 
dataverse skill upload lead-qualification
dataverse skill upload ./my-skill.zip
dataverse skill upload --all

Siehe auch

Arbeiten mit Daten mithilfe der Dataverse CLI

  • Last updated on