CLI-Befehlsreferenz für Copilot Managed Runtime

In diesem Artikel werden die einzelnen CLI-Befehle von Copilot Managed Runtime mit Syntax und Parametern beschrieben, um Sie beim Erstellen, Bereitstellen und Freigeben von Apps über die Befehlszeile zu unterstützen. Die Copilot Managed Runtime-CLI wird als @microsoft/cmr-cli veröffentlicht und aufgerufen ms.

Die meisten Befehle werden für die App im aktuellen Verzeichnis ausgeführt und lesen Standardwerte aus ihrer lokalen Konfiguration (App-Name, Umgebung, Repositorybindung). Führen Sie Befehle aus dem Verzeichnis aus, das Ihre App enthält, es sei denn, ein Flag lässt Sie explizit zu, dass Sie auf eine andere App abzielen.

Diese Referenz gruppiert jeden Befehl nach typischen Entwickler-Workflowaufgaben:

Gruppe Befehl Beschreibung
Authentifizierung ms auth login Melden Sie sich über den Browser bei Microsoft Entra ID an.
Authentifizierung ms auth logout Löschen zwischengespeicherter Anmeldeinformationen und Entfernen des aktiven Kontozeigers.
Authentifizierung ms auth status Listen Sie zwischengespeicherte Konten auf, und geben Sie das aktive Konto an.
Authentifizierung ms auth switch Aktivieren Sie ein anderes zwischengespeichertes Konto.
Authentifizierung ms git auth refresh Aktualisieren oder richten Sie die Entra-to-GitHub-Identitätszuordnung ein.
App erstellen ms app create Erstellen Sie eine neue App und erstellen Sie ein Gerüst für eine Projektvorlage.
App erstellen ms app clone Klonen Sie das plattformverwaltete Git-Repository einer vorhandenen App.
App erstellen ms app init Registrieren Sie ein vorhandenes Webprojekt als App.
Connectors ermitteln ms connector list Auflisten der in einer Umgebung verfügbaren Connectors.
Connectors ermitteln ms connector list-actions Auflisten von Vorgängen, die von einem Connector verfügbar gemacht werden.
Verwalten von App-Ressourcen ms app add backend Fügen Sie der App ein Fabric-Datenbank-Back-End hinzu.
Verwalten von App-Ressourcen ms app add data-source Fügen Sie der App einen Connector als Tabellen- oder Aktionsdatenquelle hinzu.
Verwalten von App-Ressourcen ms app remove data-source Entfernen Sie eine zuvor hinzugefügte Datenquelle (Tabelle oder Aktion) aus der App.
Verwalten von App-Ressourcen ms app refresh data-source Rufen Sie das Schema erneut ab, und generieren Sie TypeScript für gebundene Datenquellen erneut.
Lokal entwickeln ms app dev Starten Sie die vollständige lokale Entwicklungsschleife.
Erstellen und Bereitstellen ms app pack Erstellen Sie die App lokal und stellen Sie die Ausgabe zur Überprüfung bereit.
Erstellen und Bereitstellen ms app build Lösen Sie einen Plattformbuild für einen bestimmten Commit aus.
Erstellen und Bereitstellen ms app build-status Überprüfen Sie den Status eines Builds.
Erstellen und Bereitstellen ms app deploy Bewerben Sie ein umweltfreundliches Gebäude in der Live-App.
Play ms app play Öffnen einer App und Drucken der Start-URL.
Freigeben ms app share Gewähren Sie Benutzern oder Gruppen Zugriff.
Freigeben ms app share list Listen Sie die Benutzer und Gruppen auf, für die eine App freigegeben ist.
Freigeben ms app unshare Widerrufen Sie den zuvor gewährten Zugriff.
Freigeben ms app share link create Erstellen Sie einen mandantenweiten Freigabelink für die App.
Freigeben ms app share link list Auflisten von Freigabelinks, die für die App ausgestellt wurden.
Freigeben ms app share link revoke Widerrufen Sie einen Freigabelink nach ID.
Untersuchen und verwalten ms app list Listen Sie Apps in der Umgebung auf, auf die Sie zugreifen können.
Untersuchen und verwalten ms app info Zeigen Sie den serverseitigen Status der App an.
Untersuchen und verwalten ms app get-settings Alle App-Einstellungen und die aktuellen Werte anzeigen.
Untersuchen und verwalten ms app set-setting Aktualisieren Sie eine oder mehrere App-Einstellungen.
Untersuchen und verwalten ms app delete Löschen Sie die App aus der Umgebung.
Telemetrie ms telemetry enable Aktivieren Sie die Telemetrieerfassung.
Telemetrie ms telemetry disable Deaktivieren Sie die Telemetrieerfassung.
Telemetrie ms telemetry status Aktuelle Telemetrieeinstellungen anzeigen.

Befehlsindex

In der folgenden Tabelle sind die Befehle alphabetisch aufgeführt:

Befehl Gruppe Beschreibung
ms app add backend Verwalten von App-Ressourcen Fügen Sie der App ein Fabric-Datenbank-Back-End hinzu.
ms app add data-source Verwalten von App-Ressourcen Fügen Sie der App einen Connector als Tabellen- oder Aktionsdatenquelle hinzu.
ms app build Erstellen und Bereitstellen Lösen Sie einen Plattformbuild für einen bestimmten Commit aus.
ms app build-status Erstellen und Bereitstellen Überprüfen Sie den Status eines Builds.
ms app clone App erstellen Klonen Sie das plattformverwaltete Git-Repository einer vorhandenen App.
ms app create App erstellen Erstellen Sie eine neue App und erstellen Sie ein Gerüst für eine Projektvorlage.
ms app delete Untersuchen und verwalten Löschen Sie die App aus der Umgebung.
ms app deploy Erstellen und Bereitstellen Bewerben Sie ein umweltfreundliches Gebäude in der Live-App.
ms app dev Lokal entwickeln Starten Sie die vollständige lokale Entwicklungsschleife.
ms app get-settings Untersuchen und verwalten Alle App-Einstellungen und die aktuellen Werte anzeigen.
ms app info Untersuchen und verwalten Zeigen Sie den serverseitigen Status der App an.
ms app init App erstellen Registrieren Sie ein vorhandenes Webprojekt als App.
ms app list Untersuchen und verwalten Listen Sie Apps in der Umgebung auf, auf die Sie zugreifen können.
ms app pack Erstellen und Bereitstellen Erstellen Sie die App lokal und stellen Sie die Ausgabe zur Überprüfung bereit.
ms app play Play Öffnen einer App und Drucken der Start-URL.
ms app refresh data-source Verwalten von App-Ressourcen Rufen Sie das Schema erneut ab, und generieren Sie TypeScript für gebundene Datenquellen erneut.
ms app remove data-source Verwalten von App-Ressourcen Entfernen Sie eine zuvor hinzugefügte Datenquelle (Tabelle oder Aktion) aus der App.
ms app set-setting Untersuchen und verwalten Aktualisieren Sie eine oder mehrere App-Einstellungen.
ms app share Freigeben Gewähren Sie Benutzern oder Gruppen Zugriff.
ms app share list Freigeben Listen Sie die Benutzer und Gruppen auf, für die eine App freigegeben ist.
ms app share link create Freigeben Erstellen Sie einen mandantenweiten Freigabelink für die App.
ms app share link list Freigeben Auflisten von Freigabelinks, die für die App ausgestellt wurden.
ms app share link revoke Freigeben Widerrufen Sie einen Freigabelink nach ID.
ms app unshare Freigeben Widerrufen Sie den zuvor gewährten Zugriff.
ms auth login Authentifizierung Melden Sie sich über den Browser bei Microsoft Entra ID an.
ms auth logout Authentifizierung Löschen zwischengespeicherter Anmeldeinformationen und Entfernen des aktiven Kontozeigers.
ms auth status Authentifizierung Listen Sie zwischengespeicherte Konten auf, und geben Sie das aktive Konto an.
ms auth switch Authentifizierung Aktivieren Sie ein anderes zwischengespeichertes Konto.
ms connector list Connectors ermitteln Auflisten der in einer Umgebung verfügbaren Connectors.
ms connector list-actions Connectors ermitteln Auflisten von Vorgängen, die von einem Connector verfügbar gemacht werden.
ms git auth refresh Authentifizierung Aktualisieren oder richten Sie die Entra-to-GitHub-Identitätszuordnung ein.
ms telemetry disable Telemetrie Deaktivieren Sie die Telemetrieerfassung.
ms telemetry enable Telemetrie Aktivieren Sie die Telemetrieerfassung.
ms telemetry status Telemetrie Aktuelle Telemetrieeinstellungen anzeigen.

Globale Flags

Jeder Befehl akzeptiert die folgenden Flags.

Flag Alias Pflichtfeld? Beschreibung
--json Nein Geben Sie das Ergebnis als einzelnes JSON-Objekt (oder NDJSON für Streamingbefehle) aus. Verwenden Sie dieses Flag in Skripts und CI.
--non-interactive Nein Ohne Eingabeaufforderungen ausführen. Geben Sie alle erforderlichen Werte über Flags oder Umgebungsvariablen an. Verwenden Sie dieses Flag in Skripts und CI.
--no-color Nein Deaktivieren Sie die farbige Ausgabe.
--cloud <cloud> Nein Cloudumgebung als Ziel festlegen. Gültige Werte sind public (Standard), usgov, usgovhigh, usgovdodund china.
--version -v Nein Drucken Sie die CLI-Version.
--help -h Nein Zeigen Sie die Hilfe für den Befehl an, einschließlich aller verfügbaren Flags.

Tipp

Wird ohne Argumente für gruppierte Hilfe der obersten Ebene, ms app für App-Unterbefehle und ms app <verb> --help für die Flags eines Verbs ausgeführtms. Funktionen werden nach und nach angezeigt, wenn Sie einen Drilldown ausführen.

Authentifizierung

Melden Sie sich einmal pro Computer an. Bei allen anderen Befehlen wird von einer authentifizierten Sitzung für einen Copilot Managed Runtime-fähigen Mandanten ausgegangen.

ms auth login

Melden Sie sich über den Browser bei Microsoft Entra ID an. Fügt das neue Konto dem Cache hinzu und aktiviert es.

ms auth login [--account <email>]

ms auth login account Parameter

Versucht, Sie mit dem ausgewählten Konto anzumelden, was für Szenarien mit mehreren Konten nützlich ist. Um zwischen bereits zwischengespeicherten Konten auszuwählen, verwenden Sie ms auth switch stattdessen.


ms auth logout

Löschen Sie alle zwischengespeicherten Anmeldeinformationen und entfernen Sie den Zeiger auf das aktive Konto.

ms auth logout

Um zu ändern, welches Konto aktiv ist, ohne sich abzumelden, verwenden Sie ms auth switch.


ms auth status

Zwischengespeicherte Konten auflisten. Wenn mehrere Konten zwischengespeichert werden, wird das aktive Konto (das von anderen Befehlen verwendet) mit *markiert.

ms auth status

ms auth switch

Aktivieren Sie ein anderes zwischengespeichertes Konto für nachfolgende Befehle.

ms auth switch [--account <email>]

ms auth switch account Parameter

Das Konto, das aktiviert werden soll. Im interaktiven Modus mit mehreren zwischengespeicherten Konten fordert die CLI zur Auswahl auf, wenn dieses Flag weggelassen wird. Erforderlich im nicht interaktiven Modus und bei Verwendung von --json.

Git-Authentifizierung

Einige Befehle müssen überprüfen, ob Ihre Microsoft Entra-Identität einem GitHub-Benutzer mit Zugriff auf das gebundene Repository zugeordnet ist. Wenn zum ersten Mal eine Zuordnung erforderlich ist, ms app createms app build, , und ms app deploy führen Sie den GitHub-Gerätecodeflow inline aus – Sie müssen sie für die erstmalige Einrichtung nicht proaktiv aktualisieren. Wird ms git auth refresh verwendet, um sich explizit erneut zu authentifizieren (z. B. beim Wechseln von GitHub-Konten).

ms git auth refresh

Aktualisieren oder richten Sie die Microsoft Entra ↔ GitHub-Identitätszuordnung für ein Repository ein, das einer GitHub Enterprise Cloud-organization gehört.

ms git auth refresh --repo <url> [--open-browser]

Der Befehl druckt die Bestätigungs-URL und einen Benutzercode, den Sie in einen Browser einfügen können. Bei erfolgreicher Ausführung werden die authentifizierte GitHub-Anmeldung und der Ablaufzeitstempel der Zuordnung ausgegeben. Drücken Sie Ctrl+C diese Taste, um die Abrufschleife sauber abzubrechen.

ms git auth refresh Parameter

Parameter Alias Pflichtfeld? Beschreibung
--repo -r Ja Eine vollständige URL für ein Repository, das einer GitHub Enterprise Cloud-organization gehört. Zum Beispiel https://contoso.ghe.com/contoso/my-app oder https://github.com/contoso/my-app. Die CLI überprüft nur minimal, ob die URL einen Host hat (der zum Ableiten des Anmeldeendpunkts verwendet wird), und erzwingt selbst keine Host- oder Schemaregeln. Die Plattform ist die Autorität, für die Hosts und Anbieter unterstützt werden. Die CLI fragt im interaktiven Modus auf, wenn Sie diesen Wert nicht festlegen.
--open-browser Nein Starten Sie nach besten Kräften den Systembrowser und drucken Sie nicht nur die Überprüfungs-URL. Der Standardwert ist schreibgeschützt.

App erstellen

Verwenden Sie diese Befehle, um eine neue Copilot Runtime-App zu erstellen oder ein vorhandenes Projekt zu registrieren.

Konfigurieren Sie die Repository-Sichtbarkeit und andere Richtlinien für die Repository-Verwaltung in GitHub Enterprise Cloud. Weitere Informationen finden Sie unter Erzwingen von Richtlinien zur Repository-Verwaltung in Ihrem Unternehmen.

ms app create

Erstellen Sie eine neue App, erstellen Sie ein Gerüst für die Projektvorlage in das Verzeichnis, und richten Sie die Quellcodeverwaltung ein.

ms app create --display-name <name> [directory] [options]

ms app create Parameter

Parameter Alias Pflichtfeld? Beschreibung
--display-name <name> -n Ja Anzeigename für die App.
[directory] Nein Zielverzeichnis. Er muss leer sein. Wenn diese Angabe weggelassen wird, erstellt die CLI ein Verzeichnis, das nach dem Anzeigenamen der App benannt ist. Explizit übergeben . , um das aktuelle Verzeichnis zu verwenden.
--environment-id <id> -e Nein Zielumgebung. Wenn er weggelassen wird, verwendet die CLI Ihre Entwicklerumgebung und stellt bei der ersten Ausführung eine bereit.
--description <text> -d Nein Freitextbeschreibung, die im App-Eintrag gespeichert ist.
--template <name> -t Nein GitHub-Repository oder Unterpfad zum Gerüst der App (z. B github:owner/repo/subdir. ). Standardmäßig ist die integrierte Vite-Vorlage. Gilt für jeden --repo Modus.
--repo <url> Nein Bindung an die Quellcodeverwaltung. Weglassen für plattformseitig verwaltetes (GRS) Git (Standard). Übergeben Sie eine vollständige https:// URL für ein Repository, das einer GitHub Enterprise Cloud-organization gehört, z. B. oder https://github.com/contoso/my-app -, https://contoso.ghe.com/contoso/my-app um ein vorhandenes leeres externes GitHub-Repository zu klonen und zu binden. Überspringen Sie none die gesamte Git-Bindung (erstellen Sie ein Gerüst für die Vorlage und schreiben ms.config.json Sie nur, ohne lokales Repository oder Remote). Kann nicht mit kombiniert werden --repository-id.
--repository-id <id> -r Nein Repository-ID, die der App für die Quellcodeverwaltung zugeordnet werden soll. Kann nicht mit kombiniert werden --repo.
--build-path <path> -b Nein Ausgabeverzeichnis erstellen. Standardwert ist ./dist.
--build-command <cmd> -S Nein Vollständiger Shellbefehl, der zum Erstellen der App verwendet wird. Standardwert ist npm run build.
--build-entry-point <file> Nein HTML-Datei für Einstiegspunkt. Standardwert ist index.html.
--open-browser Nein Starten Sie nach besten Kräften den Systembrowser, wenn eine erneute Authentifizierung des Gerätecodeflows erforderlich ist. Hat keine Auswirkung mit --json.
--force-reauth Nein Umgehen Sie die gespeicherte GitHub-Zuordnung, und erzwingen Sie den Gerätecodefluss, als ob die Zuordnung abgelaufen wäre. Betrifft nur Apps, die an ein externes GitHub-Repository gebunden sind.

Hinweis

  • Für --repo <url>klont die CLI das externe GitHub-Repository in das Verzeichnis und überlagert die Vorlage. Das Repository muss vorhanden und leer sein.
  • Für --repo noneerstellt die CLI ein Gerüst für die Vorlage und schreibt ms.config.json , initialisiert jedoch kein lokales Git-Repository und bindet kein Remoterepository. Dadurch wird eine App für die Bereitstellung externer Artefakte erstellt, die Sie selbst erstellen und bereitstellen. Ein Beispiel finden Sie unter Bereitstellen von Microsoft Copilot Managed Runtime-Apps mit GitHub Actions.
  • Wenn die GitHub-Zuordnung fehlt oder abgelaufen ist, ms app create wird der Gerätecodeflow in Band ausgeführt und einmal versucht.

ms app init

Registrieren Sie ein vorhandenes Webprojekt als App ohne Gerüstdateien.

ms app init --display-name <name> [options]

ms app init Parameter

Parameter Alias Pflichtfeld? Beschreibung
--display-name <name> -n Ja Anzeigename für die App.
--environment-id <id> -e Nein Zielumgebung. Standardmäßig ist die Entwicklerumgebung des Benutzers festgelegt.
--description <text> -d Nein Freitextbeschreibung.
--build-path <path> -b Nein Ausgabeverzeichnis erstellen. Standardwert ist ./dist.
--build-command <cmd> -S Nein Vollständiger Shellbefehl, der zum Erstellen der App verwendet wird. Standardwert ist npm run build.
--build-entry-point <file> Nein HTML-Datei für Einstiegspunkt. Standardwert ist index.html.
--repo <value> Nein Verhalten des Repositorys. Lassen Sie das aktuelle Git-Setup nicht automatisch erkennen (und im interaktiven Modus anzeigen). Übergeben native Sie sie, none um ein plattformverwaltetes (GRS) Repository für die Bereitstellung externer Artefakte (kein plattformverwaltetes Repository) oder eine Repository-URL zum Binden an ein vorhandenes GitHub-Repository zu erzwingen, das bereits in das aktuelle Verzeichnis geklont wurde.
--icon-path <path> Nein Optionaler Pfad zu einem .png oder .jpg App-Symbol, geschrieben als iconPathms.config.json .
--local-app-url <url> Nein Optionale lokale Entwicklungs-URL, geschrieben in ms.config.json als localAppUrl.
--open-browser Nein Starten Sie nach besten Kräften den Systembrowser während des Gerätecodeflusses. Hat keine Auswirkung mit --json.
--force-reauth Nein Umgehen Sie die gespeicherte GitHub-Zuordnung, und erzwingen Sie den Gerätecodefluss beim ersten Versuch. Nützlich für die Wiederherstellung einer beschädigten Zuordnung.

Hinweis

  • Fehler, wenn das aktuelle Verzeichnis bereits eine App ist.
  • Erstellt kein Gerüst für Vorlagendateien. Das Verhalten der Quellcodeverwaltung hängt von --repo (automatisch aus dem aktuellen Verzeichnis erkannt, wenn diese Option weggelassen wird).
  • Für den externen GitHub-Zweig gilt die gleiche Inline-Gerätecodefluss-Neuauthentifizierung wie bei ms app create.

ms app clone

Klonen Sie das plattformverwaltete Git-Repository einer vorhandenen App, und konfigurieren Sie die Git-Authentifizierung für zukünftige Abruf- und Pushvorgänge.

ms app clone --app <app-id> [directory]

ms app clone Parameter

Parameter Alias Pflichtfeld? Beschreibung
--app <app-id> Ja App-ID einer App, für die Sie Bearbeitungszugriff haben. Werden verwendet ms app list --permission edit , um die App-ID zu finden.
[directory] Nein Zielverzeichnis. Er muss leer sein. Wenn diese Angabe weggelassen wird, erstellt die CLI ein Verzeichnis, das nach dem Anzeigenamen der App benannt ist. Explizit übergeben . , um das aktuelle Verzeichnis zu verwenden.

Hinweis

ms app clone unterstützt plattformseitig verwaltete Git-Repositorys. Für eine App, die ein externes GitHub- oder GitHub Enterprise Cloud-Repository verwendet, verwenden Sie git clone <repository-url> stattdessen. Sie können keine App klonen, die nicht über eine Quellcodeverwaltungsbindung verfügt.

Connectors ermitteln

Verwenden Sie diese Befehle, um verfügbare Connectors zu finden und deren Vorgänge zu überprüfen, bevor Sie sie Ihrer App hinzufügen.

ms connector list

Auflisten der in einer Umgebung verfügbaren Connectors.

ms connector list [--environment-id <id>] [--search <term>] [--only-allowed]

Die Ermittlung umfasst Connectors, die durch Richtlinien blockiert werden, es sei denn, Sie bestehen die --only-allowed. Die Texttabelle enthält die Connector-ID, das tabellarische Supportflag und einen einheitlichen Richtlinienstatus, der auf der Verhinderung von Datenverlust (Data Loss Prevention, DLP) und erweiterten Connectorrichtlinien (Advanced Connector Policies, ACP) basiert. Die JSON-Ausgabe enthält detailliertere Connector- und Richtlinienfelder.

ms connector list Parameter

Parameter Alias Pflichtfeld? Beschreibung
--environment-id <id> -e Nein Umgebung für die Abfrage. Standardwerte von ms.config.json , wenn vorhanden.
--search <term> -s Nein Nach Teilzeichenfolgenübereinstimmung nach dem Anzeigenamen oder der ID des Connectors filtern (Groß-/Kleinschreibung wird nicht beachtet).
--only-allowed Nein Listen Sie nur Connectors auf, die von der Richtlinie zugelassen sind. Standardmäßig beinhaltet die Ermittlung blockierte Connectors.

ms connector list-actions

Listen Sie die Vorgänge auf, die ein Connector verfügbar macht, einschließlich des Status der Verhinderung von Datenverlust (Data Loss Prevention, DLP) für jeden Vorgang.

ms connector list-actions [--environment-id <id>] --connector <connector> [--search <term>]

ms connector list-actions Parameter

Parameter Alias Pflichtfeld? Beschreibung
--connector <connector> Ja Zu überprüfender Connector, angegeben durch ID.
--environment-id <id> -e Nein Umgebung für die Abfrage. Standardwerte von ms.config.json , wenn vorhanden.
--search <term> -s Nein Nach Teilzeichenfolgenübereinstimmung nach Vorgangszusammenfassung oder Aktions-ID filtern (Groß-/Kleinschreibung wird nicht beachtet).

Verwalten von App-Ressourcen

Verwenden Sie diese Befehle, um die Datenquellen hinzuzufügen, zu entfernen und zu aktualisieren, von denen Ihre App abhängt.

Hinzufügen von App-Ressourcen

Führen Sie alle add Befehle aus dem Verzeichnis aus, das Ihre App enthält. Standardmäßig werden TypeScript-Modelle und -Dienste unter generated/generiert. ms app add data-source


ms app add backend

Fügen Sie der App ein Fabric-Datenbank-Back-End hinzu. Ein Administrator muss die Fabric-Integration für die Umgebung aktivieren, bevor Sie diesen Befehl ausführen.

ms app add backend --provider fabric

ms app add backend Parameter

Parameter Alias Pflichtfeld? Beschreibung
--provider <provider> Ja Hinzuzufügender Back-End-Anbieter. Derzeit ist fabricder einzige gültige Wert .

Voraussetzungen und Details zum Datenbank-Back-End finden Sie unter Fabric-Integration mit Copilot Managed Runtime.


ms app add data-source

Fügen Sie der App einen Connector hinzu. Der Befehl wählt automatisch zwischen Tabellen- und Aktionsdatenquellen.

ms app add data-source --connector <connector> [options]

Hinweis

  • Die CLI fügt nicht tabellarische Verbinder automatisch als Aktionen hinzu.
  • Die CLI fordert im interaktiven Modus für tabellarische Connectors zur Eingabe von Tabelle im Vergleich zu einer Aktion auf. Sie müssen dies im nicht interaktiven Modus angeben --as .
  • DLP- und ACP-Vorabtests werden ausgeführt, bevor der Befehl eine Aktion oder Tabelle hinzufügt. Die CLI filtert blockierte Vorgänge heraus und meldet die übersprungene Anzahl.

ms app add data-source Parameter

Parameter Alias Pflichtfeld? Beschreibung
--connector <connector> Ja Hinzuzufügender Connector, nach ID (z. B shared_office365. ) oder Anzeigename, von ms connector list.
--as <mode> Bedingter Erzwingen table oder action entsenden. Im nicht interaktiven Modus erforderlich, wenn der Connector Tabellen unterstützt.
--connection-id <id> -c Nein Vorhandene Verbindung zu verwenden. Wenn diese Angabe weggelassen wird, wird die CLI angezeigt.
--dataset <name> -d Nein Dataset (used with --as table).
--table <name> -t Nein Hinzuzufügende Tabelle (verwendet mit --as table). Für Dataverse (shared_commondataserviceforapps) der logische Tabellenname.
--dataverse-environment-id <guid> Nein Dataverse-Umgebungs-ID. Wird nur verwendet, um eine Bindung an --connector shared_commondataserviceforapps eine bestimmte Tabelle herzustellen.
--use-sso Nein Einmaliges Anmelden (Entra ID)-Verbindung bevorzugen: Verwenden Sie die erste vorhandene SSO-Verbindung wieder oder erstellen Sie im Hintergrund eine. Fehler, wenn der Connector nicht SSO-fähig ist. Ignoriert, wenn --connection-id angegeben.

Entfernen von App-Ressourcen

Im interaktiven Modus fordern Entfernungsbefehle zur Bestätigung auf, es sei denn, Sie bestehen die --force. Im nicht interaktiven Modus wird das Entfernen ohne Bestätigung fortgesetzt, auch wenn Sie den Befehl --forceweglassen.

ms app remove data-source

Entfernen Sie eine zuvor hinzugefügte Datenquelle (Tabelle oder Aktion) aus der App.

ms app remove data-source [--name <name>] [--force]

ms app remove data-source Parameter

Parameter Alias Pflichtfeld? Beschreibung
--name <name> -n Nein Der Name der zu entfernenden Datenquelle. Wenn diese Angabe in der CLI ausgelassen wird, werden Sie aufgefordert, eine Auswahl aus den Datenquellen der App zu treffen.
--force -f Nein Überspringt die Bestätigungsaufforderung.

App-Ressourcen aktualisieren

Verwenden Sie diesen Befehl, um generierte App-Typen mit den neuesten Quellschemaänderungen zu synchronisieren.

ms app refresh data-source

Rufen Sie das Schema erneut ab, und generieren Sie TypeScript für gebundene Datenquellen erneut.

ms app refresh data-source [--name <name>]

Führen Sie diesen Befehl aus, nachdem sich das zugrunde liegende Schema geändert hat (z. B. eine neue Spalte in einer SharePoint-Liste), um das generierte TypeScript synchron zu halten.

ms app refresh data-source Parameter

Parameter Alias Pflichtfeld? Beschreibung
--name <name> -n Nein Aktualisieren einer bestimmten Datenquelle. Aktualisieren Sie nicht alle gebundenen Quellen.

Lokal entwickeln

Verwenden Sie diese Befehle, um Ihre App lokal mit dem Konfigurationsserver für die iterative Entwicklung auszuführen.

ms app dev

Starten Sie die vollständige lokale Entwicklungsschleife.

ms app dev [--port <n>] [--local-app-url <url>] [--config-only]

Die CLI startet den Entwicklungsprozess des Projekts zusammen mit einem lokalen Konfigurationsserver. Die Wiedergabe-URL wird gedruckt, sobald beide erreichbar sind. Drücken Sie diese Taste Ctrl+C , um sie sauber zu stoppen.

ms app dev Parameter

Parameter Alias Pflichtfeld? Beschreibung
--port <n> -p Nein Port für den Konfigurationsserver. Standardwert ist 8080.
--local-app-url <url> -l Nein URL, unter der der Entwicklungsserver erreichbar ist. Standardwert ist http://localhost:3000.
--config-only -C Nein Starten Sie nur den Konfigurationsserver, wenn Sie den Entwicklungsserver separat ausführen (z. B. unter einem Prozessmanager).

Erstellen und Bereitstellen

Verwenden Sie diese Befehle, um lokal zu verpacken, Remotebuilds auszuführen und einen validierten Commit bereitzustellen.

ms app pack

Erstellen Sie die App lokal und stellen Sie die Ausgabe zur Überprüfung bereit, ohne sie irgendwo hochzuladen.

ms app pack

Verwenden Sie diesen Befehl, um vor dem Auslösen eines Remotebuilds zu überprüfen, ob ein sauberer lokaler Build erfolgreich ist.


ms app build

Lösen Sie einen Plattformbuild für einen bestimmten Commit in einer Git-gestützten App aus.

ms app build --app <name> --commit <sha> [--no-wait] [--open-browser] [--force-reauth]

ms app build Parameter

Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein App-Name. Standardwerte von ms.config.json , wenn vorhanden.
--commit <sha> -c Nein Commit to build ausführen. Der Standardwert ist die aktuelle HEAD.
--no-wait Nein Senden Sie sofort nach der Übermittlung zurück, und drucken Sie einen Hinweis aus, um nachzufassen ms app build-status. Standardmäßig wartet der Befehl, bis der Build einen Endzustand erreicht.
--open-browser Nein Starten Sie nach bestem Wissen und Gewissen den Systembrowser, wenn für externe GitHub-Repositorys eine erneute Authentifizierung des Gerätecodeflows erforderlich ist. Hat keine Auswirkung mit --json.
--force-reauth Nein Umgehen Sie die gespeicherte GitHub-Zuordnung, und erzwingen Sie den Gerätecodefluss. Betrifft nur Apps, die an ein externes GitHub-Repository gebunden sind.

ms app build-status

Überprüfen Sie den Status eines Builds.

ms app build-status --app <name> --commit <sha> [--show-log]

Wenn der Build fehlgeschlagen ist, enthält die Ausgabe den Grund, damit Sie den Code korrigieren und erneut pushen können.

ms app build-status Parameter

Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein Zu überprüfende App. Standardwerte von ms.config.json , wenn vorhanden.
--commit <sha> -c Nein Führen Sie einen Commit durch, um den Build-Status zu überprüfen. Der Standardwert ist die aktuelle HEAD.
--show-log Nein Rufen Sie das Buildprotokoll ab und drucken Sie es aus, wenn es verfügbar ist.

ms app deploy

Bewerben Sie ein umweltfreundliches Gebäude in der Live-App.

ms app deploy [--app <name>] [--commit <sha>] [--artifact <path>] [--force] [--open-browser] [--force-reauth]

Hinweis

  • Der Befehl wird in der mit der App verknüpften Umgebung bereitgestellt. Es wird keine Bereitstellungsumgebung ausgewählt.
  • Bei Git-gestützten Apps löst die CLI den Commit auf (standardmäßiges lokales Git), HEADstellt einen Remotebuild in die Warteschlange oder verwendet einen zwischengespeicherten Build für diesen Commit wieder, wartet auf den Abschluss und stellt denselben Commit bereit. Ein fehlerhafter oder abgebrochener Build stoppt die Bereitstellung. Die CLI wählt keinen älteren erfolgreichen Build aus.
  • Wenn der Auscheckvorgang nicht abgeschlossene Änderungen oder lokale Commits vor der Remoteumgebung aufweist, fragt Preflight im interaktiven Modus "Trotzdem bereitstellen?". Im nicht-interaktiven oder JSON-Modus endet es mit einem Nutzungsfehler, es sei denn, Sie übergeben --force. Commit und Push für die beabsichtigten Änderungen vor der Bereitstellung. --force umgeht den Vorflug; Es werden keine nicht committeten oder nicht gepushten Quellen hochgeladen.
  • Für Apps ohne Quellcodeverwaltung ()repoType: none packt die CLI den lokalen Build und lädt ihn hoch, oder lädt einen vorgefertigten .zip Build hoch, wenn --artifact er bereitgestellt wird.

ms app deploy Parameter

Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein bereitzustellende App. Standardwerte von ms.config.json.
--commit <sha> -c Nein Commit für die Bereitstellung ausführen (nur Git-gestützte Apps). Der Standardwert ist die aktuelle HEAD. Schließt sich gegenseitig mit --artifactaus.
--artifact <path> Nein Pfad zu einem lokalen .zip Buildartefakt, das hochgeladen und bereitgestellt werden soll. Nur gültig für Apps, die ohne Quellcodeverwaltung erstellt wurden (repoType: none); abgelehnt für Git-gestützte Apps. Schließt sich gegenseitig mit --commitaus.
--force Nein Umgehen Sie die Bestätigung oder Ablehnung von Git vor dem Flug für nicht übermittelte Änderungen oder lokale Commits vor der Remote. Lädt diese Änderungen nicht hoch.
--open-browser Nein Starten Sie nach besten Kräften den Systembrowser, wenn eine erneute Authentifizierung des Gerätecodeflows erforderlich ist. Hat keine Auswirkung mit --json.
--force-reauth Nein Umgehen Sie die gespeicherte GitHub-Zuordnung, und erzwingen Sie den Gerätecodefluss. Betrifft nur Apps, die an ein externes GitHub-Repository gebunden sind.

Bis zum Abschluss der Bereitstellung bleibt die vorhandene Bereitstellung intakt und nutzbar. Nach Abschluss der Bereitstellung erhalten Endbenutzer eine Benachrichtigung, dass eine neue Version verfügbar ist, mit einem Link zum Aktualisieren der App.

ms app deploy --artifact <path> das Artefakt ohne plattformverwalteten Build hochlädt und bereitstellt. Die Bereitstellung externer Artefakte ist standardmäßig nicht zulässig. Weitere Informationen finden Sie unter Bereitstellung externer Artefakte. Ihre organization ist dafür verantwortlich, extern erstellte Artefakte zu validieren und die Buildpipeline vor der Bereitstellung zu sichern.

„Wiedergeben“

Verwenden Sie diesen Befehl, um Ihre App im Live- oder Vorschaumodus zu öffnen.

ms app play

Öffnen Sie eine App im Browser, und drucken Sie die Start-URL aus.

ms app play [--app <name>] [--mode live | preview] [--commit <sha> | --branch <name>] [--no-browser]

ms app play Parameter

Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein App zum Öffnen. Standardwerte von ms.config.json.
--mode <mode> -m Nein live die bereitgestellte App öffnet. preview Öffnet standardmäßig den aktuellen Git-Branch oder den Branch oder Commit, den Sie angeben. Standardwert ist live.
--commit <sha> -c Nein Öffnet die Vorschau bei einem bestimmten Commit. Gültig nur mit --mode preview. Schließt sich gegenseitig mit --branchaus.
--branch <name> Nein Öffnen der Vorschau für einen bestimmten Branch. Gültig nur mit --mode preview. Standardmäßig ist der aktuelle Git-Zweig; Wenn die CLI es nicht identifizieren kann, gibt es eine Warnung aus und greift auf mainzurück. Schließt sich gegenseitig mit --commitaus.
--no-browser Nein Gibt die Start-URL aus, ohne den Standardbrowser zu öffnen. Nützlich für SSH-Sitzungen, CI und Skripts.

Hinweis

--mode livewarnt, dass der Live-Build eine Momentaufnahme ist und nicht automatisch aktualisiert wird. Führen Sie es erneut aus ms app deploy , um es zu aktualisieren. Wenn keine Wiedergabe-URL verfügbar ist, schlägt der Befehl fehl. Wenn eine URL vorhanden ist, das Ziel jedoch keinen bereitgestellten Commit hat, gibt der Befehl eine Warnung aus, druckt die URL weiter aus und öffnet sie.

Vorschau des Buildverhaltens

In --mode previewbasiert die Start-URL auf dem Commit am Anfang des aktuellen Branchs oder einem ausgewählten Commit-SHA. Was im Browser für diese URL angezeigt wird, hängt vom Status des Builds für diesen Commit ab:

Build State Verhalten in Vorschau
Letzter Commit mit erfolgreichem Build Rendert den Build.
Neuester Commit wird noch aufgebaut Rendert den vorherigen erfolgreichen Build mit einem in Bearbeitung befindlichen Banner: "Neuester Build wird ausgeführt."
Letzter Commit konnte nicht erstellt werden Rendert den vorherigen erfolgreichen Build mit einem Fehlerbanner: "Fehler beim letzten Build. Zeigt den letzten erfolgreichen Build."
App wurde noch nicht erfolgreich erstellt Rendert eine dedizierte "nie bereitgestellt"-Erfahrung.

Freigeben

Verwenden Sie diese Befehle, um App-Zugriff zu gewähren, zu widerrufen und zu verwalten und Links freizugeben.

ms app share

Gewähren Sie Benutzern oder Gruppen Zugriff.

ms app share <principals> [--app <name>] [--access play | edit]

Der Befehl sucht automatisch E-Mail-Adressen. Es meldet Warnungen für Einträge, die nicht aufgelöst werden, fährt aber mit denen fort, die dies tun. Wenn keine Einträge aufgelöst werden, schlägt der Befehl fehl.

ms app share Parameter

Parameter Alias Pflichtfeld? Beschreibung
<principals> Ja Eine durch Kommas getrennte Liste von E-Mail-Adressen oder Microsoft Entra-Objekt-IDs.
--app <name> Nein App zum Teilen. Standardwerte von ms.config.json.
--access <level> Nein Gewähren Sie Laufzeitzugriff (playStandard) oder Mitwirkendenzugriff (edit). Der Bearbeitungszugriff umfasst Repositoryberechtigungen für plattformverwaltetes Git; Der Zugriff auf externe GitHub-Repositorys muss in GitHub separat gewährt werden.

ms app unshare

Widerrufen Sie den zuvor gewährten Zugriff.

ms app unshare <principals> [--app <name>] [--access play | edit]

Der unshare Befehl wirkt sich nur auf die angeforderte Zugriffsebene aus. Lässt play z. B. den Zugriff intakt. unshare --access edit Prinzipale ohne vorhandene Rollenzuweisung auf der angeforderten Ebene sind No-Ops.

Widerrufen Sie für GitHub-gestützte Apps den Zugriff auf externe Repositorys separat in GitHub. Das Aufheben der Freigabe der App entfernt nicht unabhängig gewährte GitHub-Berechtigungen.

ms app unshare Parameter

Parameter Alias Pflichtfeld? Beschreibung
<principals> Ja Eine durch Kommas getrennte Liste von E-Mail-Adressen oder Microsoft Entra-Objekt-IDs.
--app <name> Nein App, deren Freigabe aufgehoben werden soll. Standardwerte von ms.config.json.
--access <level> Nein Widerruf des Laufzeitzugriffs (play, Standard) oder des Zugriffs auf Mitwirkende (edit). Der Bearbeitungszugriff umfasst Repositoryberechtigungen für plattformverwaltetes Git, aber keine externen GitHub-Repositoryberechtigungen.

ms app share list

Listen Sie die Benutzer und Gruppen auf, für die eine App auf einer bestimmten Zugriffsebene freigegeben ist.

ms app share list --access <level> [--app <name>] [--environment-id <id>]

ms app share list Parameter

Parameter Alias Pflichtfeld? Beschreibung
--access <level> Ja Zugriffsebene auf Liste. Entweder play (führen Sie die App aus) oder edit (tragen Sie zur App bei). Für GitHub-gestützte Apps richtet diese Liste keinen externen Repositoryzugriff ein.
--app <name> Nein Zu überprüfende App. Standardwerte von ms.config.json.
--environment-id <id> -e Nein Außerkraftsetzung der Umgebungs-ID. Standardwerte von ms.config.json , wenn vorhanden.

Erstellen Sie einen mandantenweiten Freigabelink für die App.

ms app share link create [--app <name>] [--environment-id <id>]
Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein App zum Teilen. Standardwerte von ms.config.json.
--environment-id <id> -e Nein Außerkraftsetzung der Umgebungs-ID. Standardwerte von ms.config.json , wenn vorhanden.

Auflisten von Freigabelinks, die für die App ausgestellt wurden.

ms app share link list [--app <name>] [--environment-id <id>]
Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein Zu überprüfende App. Standardwerte von ms.config.json.
--environment-id <id> -e Nein Außerkraftsetzung der Umgebungs-ID. Standardwerte von ms.config.json , wenn vorhanden.

Widerrufen Sie einen Freigabelink nach ID. Dieser Befehl entfernt die Rolle aller vorherigen Einlöser, bevor der Verknüpfungsdatensatz beendet wird.

ms app share link revoke --link-id <id> [--app <name>] [--environment-id <id>] [--force]
Parameter Alias Pflichtfeld? Beschreibung
--link-id <id> -l Ja Die von zurückgegebene Link-ID von ms app share link create.
--app <name> Nein App, die den Link besitzt. Standardwerte von ms.config.json.
--environment-id <id> -e Nein Außerkraftsetzung der Umgebungs-ID. Standardwerte von ms.config.json , wenn vorhanden.
--force -f Nein Überspringt die Bestätigungsaufforderung.

Untersuchen und verwalten

Verwenden Sie diese Befehle, um den App-Status anzuzeigen, Einstellungen zu aktualisieren und Apps bei Bedarf zu entfernen.

ms app list

Listen Sie alle Apps auf, auf die Sie zugreifen können. Standardmäßig listet der Befehl alle Apps im Mandanten auf. Verwenden Sie --environment-id , um den Umfang der Liste auf eine einzelne Umgebung zu beschränken.

ms app list [--environment-id <id>] [--permission <level>]

Gibt App-Details wie den Anzeigenamen und die App-ID zurück.

ms app list Parameter

Parameter Alias Pflichtfeld? Beschreibung
--environment-id <id> -e Nein Beschränken Sie das Listing auf eine einzelne Umgebung. Wenn er weggelassen wird, gibt der Befehl alle Apps zurück, auf die Sie im gesamten Mandanten zugreifen können.
--permission <level> -p Nein Berechtigungsfilter. Verwenden Sie entweder edit (Apps, zu denen Sie beitragen können) oder play (Apps, die Sie abspielen oder anzeigen können). Groß- und Kleinschreibung wird nicht beachtet.

ms app info

Zeigt den serverseitigen Status der App an.

ms app info [--app <name>] [--environment-id <id>]

Gibt den Anzeigenamen, die optionale Beschreibung, die Umgebungs-ID, die App-ID, die Projekt-ID, den bereitgestellten auf sieben Zeichen abgekürzten Commit, Connectors und optionale Repositorydetails zurück. Es werden keine Besitzer oder Start-URLs zurückgegeben.

Verwenden Sie ms app play --no-browser zum Abrufen von Start-URLs ohne Öffnen eines Browsers den Livemodus oder ms app play --mode preview --no-browser den Vorschaumodus. Fügen Sie für eine strukturierte Ausgabe hinzu --json . Um die tatsächliche lokale Konfiguration zu überprüfen, öffnen Sie ms.config.json"Serverstatus von ;". ms app info

ms app info Parameter

Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein Name der zu überprüfenden App. Standardwerte von ms.config.json. Übergeben Sie einen expliziten Namen, um eine App außerhalb des aktuellen Arbeitsverzeichnisses zu überprüfen.
--environment-id <id> -e Nein Außerkraftsetzung der Umgebungs-ID. Standardwerte von ms.config.json; Wenn keines von beiden festgelegt ist, wird die Umgebung automatisch aus dem App-Namen aufgelöst.

ms app get-settings

Zeigt alle App-Einstellungen und ihre aktuellen Werte an.

ms app get-settings

Informationen zum Anzeigen von App-Einstellungen


ms app set-setting

Updates einer oder mehrerer App-Einstellungen.

ms app set-setting [--show-header <bool>] [other-settings...]

Übergeben von Einstellungen als benannte Flags. Nur die von Ihnen angegebenen Schlüssel werden aktualisiert.

ms app set-setting Parameter

Parameter Alias Pflichtfeld? Beschreibung
--show-header <bool> Nein Ein- oder Ausblenden der App-Kopfleiste.
[other-settings...] Nein Mindestens ein benanntes Einstellungspannzeichen, das aktualisiert werden soll. Nur ausgewählte Schlüssel werden geändert.

Informationen zum Konfigurieren einer App-Einstellung


ms app delete

Löscht die App aus der Umgebung. Mit diesem Befehl werden weder der lokale Quellcode noch das Git-Repository gelöscht.

ms app delete [--app <name>] [--environment-id <id>] [--force]

Wenn die App nicht vorhanden ist, wird der Befehl fehlerfrei und ohne Fehler beendet.

ms app delete Parameter

Parameter Alias Pflichtfeld? Beschreibung
--app <name> Nein Zu löschende App. Standardwerte von ms.config.json.
--environment-id <id> -e Nein Außerkraftsetzung der Umgebungs-ID. Wenn diese Angabe weggelassen wird, wird die Umgebung automatisch aus der App aufgelöst. Nützlich zum Löschen einer App von außerhalb ihres Gerüstverzeichnisses.
--force -f Nein Überspringt die Bestätigungsaufforderung.

Telemetrie

Die CLI sendet standardmäßig anonymisierte Telemetriedaten. Verwenden Sie diese Befehle, um die Sammlung zu steuern.


ms telemetry enable

Aktivieren Sie die Telemetrieerfassung.

ms telemetry enable [--remote] [--console]

ms telemetry enable Parameter

Parameter Alias Pflichtfeld? Beschreibung
--remote Nein Steuern Sie das Senden von Telemetriedaten an den Remotedienst. Diese Option ist die Standardeinstellung, wenn keine Kennzeichnung angegeben wurde.
--console Nein Drucken von Telemetrieereignissen in die lokale Konsole.

Passe beide Flags, um beide Ziele gleichzeitig umzuschalten.


ms telemetry disable

Deaktivieren Sie die Telemetrieerfassung.

ms telemetry disable [--remote] [--console]

ms telemetry disable Parameter

Parameter Alias Pflichtfeld? Beschreibung
--remote Nein Beenden Sie das Senden von Telemetriedaten an den Remotedienst. Diese Option ist die Standardeinstellung, wenn keine Kennzeichnung angegeben wurde.
--console Nein Drucken von Telemetrieereignissen in der lokalen Konsole beenden.

Übergeben Sie beide Flags, um beide Ziele gleichzeitig zu deaktivieren.


ms telemetry status

Aktuelle Telemetrieeinstellungen anzeigen.

ms telemetry status