Copilot Managed Runtime CLI-opdrachtverwijzing (preview)

[Dit artikel is voorlopige documentatie en kan worden gewijzigd.]

De Copilot Managed Runtime CLI wordt gepubliceerd als @microsoft/managed-apps-cli en aangeroepen als ms.

De meeste opdrachten werken op de app in de huidige map en lezen standaardwaarden van de lokale configuratie (naam van de app, omgeving, binding met de opslagplaats). Voer opdrachten uit vanuit de map die uw app bevat, tenzij een vlag u expliciet toestaat een andere app te targeten.

Deze verwijzing groepeert elke opdracht op basis van typische workflowtaken voor ontwikkelaars:

Groep Opdracht Beschrijving
Verificatie ms auth login Meld je via de browser aan bij Microsoft Entra ID.
Verificatie ms auth logout Wis referenties in de cache en verwijder de aanwijzer van het actieve account.
Verificatie ms auth status Maak een lijst van accounts in de cache en geef de actieve accounts aan.
Verificatie ms auth switch Maak een ander account in de cache actief.
Verificatie ms git auth refresh De identiteitstoewijzing van Entra aan GitHub vernieuwen of tot stand brengen.
Een app maken ms app create Maak een nieuwe app en gebruik een projectsjabloon.
Een app maken ms app clone Kloon de door het platform beheerde Git-opslagplaats van een bestaande app.
Een app maken ms app init Een bestaand webproject registreren als app.
Connectors ontdekken ms connector list Lijstconnectors die beschikbaar zijn in een omgeving.
Connectors ontdekken ms connector list-actions Lijstbewerkingen die worden weergegeven door een connector.
App-bronnen beheren ms app add data-source Voeg een connector aan de app toe als een tabel of actiegegevensbron.
App-bronnen beheren ms app remove data-source Een eerder toegevoegde gegevensbron (tabel of actie) verwijderen uit de app.
App-bronnen beheren ms app refresh data-source Haal schema opnieuw op en genereer TypeScript opnieuw voor afhankelijke gegevensbronnen.
Lokaal ontwikkelen ms app dev Start de volledige lokale ontwikkelingslus.
Bouwen en implementeren ms app pack Bouw de app lokaal en faseer de uitvoer voor inspectie.
Bouwen en implementeren ms app build Activeer een platformbuild voor een specifieke doorvoer.
Bouwen en implementeren ms app build-status Controleer de status van een build.
Bouwen en implementeren ms app deploy Een groene build promoveren naar de live-app.
Afspelen ms app play Open een app en druk de start-URL af.
Delen ms app share Toegang verlenen aan gebruikers of groepen.
Delen ms app share list Vermeld de gebruikers en groepen waarmee een app wordt gedeeld.
Delen ms app unshare Eerder verleende toegang intrekken.
Delen ms app share link create Maak een koppeling voor het delen van de app op tenantniveau.
Delen ms app share link list Koppelingen voor lijstshare die zijn uitgegeven voor de app.
Delen ms app share link revoke Een koppeling voor delen intrekken op basis van een id.
Inspecteren en beheren ms app list Vermeld apps in de omgeving waartoe u toegang hebt.
Inspecteren en beheren ms app show Lokale app-configuratie en afhankelijke bronnen weergeven.
Inspecteren en beheren ms app info De serverstatus van de app weergeven.
Inspecteren en beheren ms app get-settings Geef alle app-instellingen en hun huidige waarden weer.
Inspecteren en beheren ms app set-setting Werk een of meer app-instellingen bij.
Inspecteren en beheren ms app delete Verwijder de app uit de omgeving.
Telemetrie ms telemetry enable Schakel telemetrieverzameling in.
Telemetrie ms telemetry disable Schakel telemetrieverzameling uit.
Telemetrie ms telemetry status Huidige instellingen voor telemetrie weergeven.

Opdrachtindex

De volgende tabel bevat de opdrachten alfabetisch:

Opdracht Groep Beschrijving
ms app add data-source App-bronnen beheren Voeg een connector aan de app toe als een tabel of actiegegevensbron.
ms app build Bouwen en implementeren Activeer een platformbuild voor een specifieke doorvoer.
ms app build-status Bouwen en implementeren Controleer de status van een build.
ms app clone Een app maken Kloon de door het platform beheerde Git-opslagplaats van een bestaande app.
ms app create Een app maken Maak een nieuwe app en gebruik een projectsjabloon.
ms app delete Inspecteren en beheren Verwijder de app uit de omgeving.
ms app deploy Bouwen en implementeren Een groene build promoveren naar de live-app.
ms app dev Lokaal ontwikkelen Start de volledige lokale ontwikkelingslus.
ms app get-settings Inspecteren en beheren Geef alle app-instellingen en hun huidige waarden weer.
ms app info Inspecteren en beheren De serverstatus van de app weergeven.
ms app init Een app maken Een bestaand webproject registreren als app.
ms app list Inspecteren en beheren Vermeld apps in de omgeving waartoe u toegang hebt.
ms app pack Bouwen en implementeren Bouw de app lokaal en faseer de uitvoer voor inspectie.
ms app play Afspelen Open een app en druk de start-URL af.
ms app refresh data-source App-bronnen beheren Haal schema opnieuw op en genereer TypeScript opnieuw voor afhankelijke gegevensbronnen.
ms app remove data-source App-bronnen beheren Een eerder toegevoegde gegevensbron (tabel of actie) verwijderen uit de app.
ms app set-setting Inspecteren en beheren Werk een of meer app-instellingen bij.
ms app share Delen Toegang verlenen aan gebruikers of groepen.
ms app share list Delen Vermeld de gebruikers en groepen waarmee een app wordt gedeeld.
ms app share link create Delen Maak een koppeling voor het delen van de app op tenantniveau.
ms app share link list Delen Koppelingen voor lijstshare die zijn uitgegeven voor de app.
ms app share link revoke Delen Een koppeling voor delen intrekken op basis van een id.
ms app show Inspecteren en beheren Lokale app-configuratie en afhankelijke bronnen weergeven.
ms app unshare Delen Eerder verleende toegang intrekken.
ms auth login Verificatie Meld je via de browser aan bij Microsoft Entra ID.
ms auth logout Verificatie Wis referenties in de cache en verwijder de aanwijzer van het actieve account.
ms auth status Verificatie Maak een lijst van accounts in de cache en geef de actieve accounts aan.
ms auth switch Verificatie Maak een ander account in de cache actief.
ms connector list Connectors ontdekken Lijstconnectors die beschikbaar zijn in een omgeving.
ms connector list-actions Connectors ontdekken Lijstbewerkingen die worden weergegeven door een connector.
ms git auth refresh Verificatie De identiteitstoewijzing van Entra aan GitHub vernieuwen of tot stand brengen.
ms telemetry disable Telemetrie Schakel telemetrieverzameling uit.
ms telemetry enable Telemetrie Schakel telemetrieverzameling in.
ms telemetry status Telemetrie Huidige instellingen voor telemetrie weergeven.

Wereldwijde vlaggen

Voor elke opdracht worden de volgende vlaggen geaccepteerd.

Vlag Alias Vereist? Beschrijving
--json Nee Voer het resultaat uit als één JSON-object (of NDJSON voor streamingopdrachten). Gebruik dit in scripts en CI.
--non-interactive Nee Uitvoeren zonder prompts. Alle vereiste waarden moeten worden opgegeven via vlaggen of omgevingsvariabelen. Gebruik dit in scripts en CI.
--no-color Nee Gekleurde uitvoer uitschakelen.
--cloud <cloud> Nee Cloudomgeving te targeten. Geldige waarden zijn public (standaard), usgov, usgovhigh, usgovdod, en china.
--version -v Nee Druk de CLI-versie af.
--help -h Nee Hulp weergeven voor de opdracht, inclusief alle beschikbare vlaggen.

Tip

Voer uit ms zonder argumenten voor gegroepeerde Help op het hoogste niveau, ms app voor app-subopdrachten en ms app <verb> --help voor de vlaggen van een werkwoord. De mogelijkheden komen geleidelijk naar boven als u inzoomt.

Verificatie

Meld u eenmaal per computer aan. Alle andere opdrachten gaan uit van een geverifieerde sessie voor een tenant met Copilot Managed Runtime.

ms auth login

Meld je via de browser aan bij Microsoft Entra ID. Hiermee voegt u het nieuwe account toe aan de cache en activeert u het.

ms auth login [--account <email>]

ms auth login account parameter

Hiermee wordt geprobeerd u aan te melden met het geselecteerde account, wat handig is voor scenario's met meerdere accounts. Als u wilt kiezen uit accounts die al in de cache zijn opgeslagen, gebruikt u ms auth switch in plaats daarvan.

ms auth logout

Wis alle referenties in de cache en verwijder de aanwijzer van het actieve account.

ms auth logout

Als u wilt wijzigen welk account actief is zonder u af te melden, gebruikt u ms auth switch.

ms auth status

Accounts in de cache weergeven. Wanneer meer dan één account in de cache is opgeslagen, wordt het actieve account (het account dat door andere opdrachten wordt gebruikt) gemarkeerd met *.

ms auth status

ms auth switch

Maak een ander account in de cache actief voor volgende opdrachten.

ms auth switch [--account <email>]

ms auth switch account parameter

Het account dat actief moet worden gemaakt. In de interactieve modus met meerdere accounts in de cache vraagt de CLI om selectie als deze vlag wordt weggelaten. Vereist in niet-interactieve modus en bij gebruik van --json.

Git-verificatie

Bij sommige opdrachten moet worden geverifieerd dat uw Microsoft Entra-identiteit is toegewezen aan een GitHub-gebruiker met toegang tot de gebonden opslagplaats. De eerste keer dat een toewijzing nodig is, ms app create, ms app builden ms app deploy voer de GitHub-apparaatcodestroom inline uit. U hoeft niet proactief te vernieuwen voor de eerste installatie. Gebruik deze optie ms git auth refresh expliciet voor opnieuw verifiëren (bijvoorbeeld bij het wisselen van GitHub-account).

ms git auth refresh

Vernieuw of breng de Microsoft Entra ↔ GitHub-identiteitstoewijzing tot stand voor een repository die eigendom is van een GitHub Enterprise Cloud-organisatie.

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

Met de opdracht worden de verificatie-URL en een gebruikerscode afgedrukt die u in een browser kunt plakken. Als dit gelukt is, worden de geverifieerde GitHub-aanmelding en het tijdstempel van de toewijzing afgedrukt. Druk hierop Ctrl+C om de poll-lus netjes te annuleren.

ms git auth refresh Parameters

Parameter Alias Vereist? Beschrijving
--repo -r Ja Een volledige URL voor een repository die eigendom is van een GitHub Enterprise Cloud-organisatie. https://contoso.ghe.com/contoso/my-app Bijvoorbeeld of https://github.com/contoso/my-app. De CLI voert slechts een minimale controle uit of de URL een host heeft (wordt gebruikt om het aanmeldingseindpunt af te leiden) en dwingt zelf geen host- of schemaregels af. Het platform is de autoriteit waarop hosts en providers worden ondersteund. De CLI vraagt in de interactieve modus of u deze waarde niet instelt.
--open-browser Nee Best effort: start de systeembrowser naast het afdrukken van de verificatie-URL. De standaardinstelling is alleen afdrukken.

Een app maken

Gebruik deze opdrachten om een nieuwe Copilot Runtime-app te maken of een bestaand project te registreren.

Configureer de zichtbaarheid van opslagplaatsen en ander beleid voor het beheer van opslagplaatsen in GitHub Enterprise Cloud. Zie Beleid voor bibliotheekbeheer in uw onderneming afdwingen voor meer informatie.

ms app create

Maak een nieuwe app, plaats een projectsjabloon in de map en stel bronbeheer in.

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

ms app create Parameters

Parameter Alias Vereist? Beschrijving
--display-name <name> -n Ja De weergavenaam van de app.
[directory] Nee Doelmap. De standaardwaarde is de huidige map. Moet leeg zijn.
--environment-id <id> -e Nee Doelomgeving. Als deze optie wordt weggelaten, gebruikt de CLI uw ontwikkelaarsomgeving, waarbij er één wordt ingericht bij de eerste uitvoering.
--description <text> -d Nee Beschrijving in vrije tekst opgeslagen in de app-record.
--template <name> -t Nee GitHub-opslagplaats of subpad van waaruit de app wordt ondersteund (bijvoorbeeld). github:owner/repo/subdir Standaard is de ingebouwde Vite-sjabloon gebruikt. Van toepassing op elke --repo modus.
--repo <url> Nee Bronbeheerbinding. Laat weg voor platform-managed (GRS) Git (standaard). Geef een volledige https:// URL door voor een repository die eigendom is van een GitHub Enterprise Cloud-organisatie, https://contoso.ghe.com/contoso/my-app bijvoorbeeld of https://github.com/contoso/my-app om een bestaande lege externe GitHub-opslagplaats te klonen en te binden. Geef alle none Git-binding over (steiger de sjabloon en schrijf ms.config.json alleen, zonder lokale opslagplaats of afstandsbediening). Kan niet worden gecombineerd met --repository-id.
--repository-id <id> -r Nee Bibliotheek-id die wordt gekoppeld aan de app voor bronbeheer. Kan niet worden gecombineerd met --repo.
--build-path <path> -b Nee Build output directory. De standaardinstelling is ./dist.
--build-command <cmd> -S Nee Volledige shell-opdracht die is gebruikt om de app te bouwen. De standaardinstelling is npm run build.
--build-entry-point <file> Nee HTML-bestand van toegangspunt. De standaardinstelling is index.html.
--open-browser Nee Best effort om de systeembrowser te starten als Device Code Flow opnieuw moet worden geverifieerd. Heeft geen effect op --json.
--force-reauth Nee Omzeil de opgeslagen GitHub-toewijzing en forceer Device Code Flow, alsof de toewijzing is verlopen. Dit geldt alleen voor apps die zijn gebonden aan een externe GitHub-opslagplaats.

Opmerking

  • De --repo <url>CLI kloont bijvoorbeeld de externe GitHub-repository in de map en overlapt de sjabloon. De opslagplaats moet bestaan en leeg zijn.
  • Voor --repo none, de CLI steigert de sjabloon en schrijft ms.config.json , maar initialiseert niet een lokale Git-repo of bindt een afstandsbediening niet. Hiermee maakt u een app voor de implementatie van externe artefacten die u zelf bouwt en implementeert. Zie Deploy Microsoft Copilot Managed Runtime apps with GitHub Actions (Beheerde runtime-apps implementeren met ) voor een voorbeeld.
  • Als de GitHub-toewijzing ontbreekt of is verlopen, ms app create voert u de Device Code Flow in-band uit en probeert u het eenmaal opnieuw.

ms app init

Registreer een bestaand webproject als app, zonder steigerbestanden.

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

ms app init Parameters

Parameter Alias Vereist? Beschrijving
--display-name <name> -n Ja De weergavenaam van de app.
--environment-id <id> -e Nee Doelomgeving. De standaardinstelling is de ontwikkelaarsomgeving van de gebruiker.
--description <text> -d Nee Beschrijving in vrije tekst.
--build-path <path> -b Nee Build output directory. De standaardinstelling is ./dist.
--build-command <cmd> -S Nee Volledige shell-opdracht die is gebruikt om de app te bouwen. De standaardinstelling is npm run build.
--build-entry-point <file> Nee HTML-bestand van toegangspunt. De standaardinstelling is index.html.
--repo <value> Nee Gedrag van de opslagplaats. Laat weg om de huidige Git-instelling automatisch te detecteren (en vraag in de interactieve modus). Pass native om een platformbeheerde (GRS) opslagplaats te forceren, none voor implementatie van externe artefacten (geen door het platform beheerde opslagplaats), of een repository-URL om te binden aan een bestaande GitHub-opslagplaats die al in de huidige map is gekloond.
--icon-path <path> Nee Optioneel pad naar een .png of .jpg app-pictogram, geschreven naar ms.config.json als iconPath.
--local-app-url <url> Nee Optionele URL voor lokale ontwikkeling, geschreven als ms.config.jsonlocalAppUrl.
--open-browser Nee Best effort om de systeembrowser te starten tijdens Device Code Flow. Heeft geen effect op --json.
--force-reauth Nee Omzeil de opgeslagen GitHub-toewijzing en forceer de Device Code Flow bij de eerste poging. Handig voor het herstellen van een beschadigde toewijzing.

Opmerking

  • Mislukt als de huidige adreslijst al een app is.
  • Ondersteunt geen sjabloonbestanden. Het gedrag van bronbeheer hangt af van --repo (automatisch gedetecteerd in de huidige map wanneer dit wordt weggelaten).
  • Voor de externe GitHub-vertakking is dezelfde inline apparaatcodestroom van toepassing als bij ms app create.

ms app clone

Kloon de door het platform beheerde Git-opslagplaats van een bestaande app en configureer Git-verificatie voor toekomstige ophaal- en pushbewerkingen.

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

ms app clone Parameters

Parameter Alias Vereist? Beschrijving
--app <app-id> Ja App-id van een app waarvoor u bewerkingstoegang hebt. Hiermee ms app list --permission edit zoekt u de app-id.
[directory] Nee Doelmap voor de gekloonde opslagplaats. Indien weggelaten, gebruikt de CLI de huidige map, die leeg moet zijn.

Opmerking

ms app clone ondersteunt door het platform beheerde Git-repositories. Voor een app die gebruikmaakt van een externe GitHub- of GitHub Enterprise Cloud-opslagplaats, gebruikt u git clone <repository-url> in plaats daarvan. U kunt geen app klonen die geen bronbeheerbinding heeft.

Connectors ontdekken

Gebruik deze opdrachten om beschikbare connectors te vinden en hun werking te controleren voordat u ze toevoegt aan uw app.

ms connector list

Lijstconnectors die beschikbaar zijn in een omgeving.

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

De uitvoer bevat de connector-id, het verificatietype, de tabelvormige ondersteuningsvlag en de status van Data Loss Prevention (DLP) en Advanced Connector Policy (ACP). Als u de beheerstatus ziet tijdens het ontwerpen, voorkomt u dat u bouwt op basis van een connector die door beleid wordt geblokkeerd tijdens implementatie of runtime.

ms connector list Parameters

Parameter Alias Vereist? Beschrijving
--environment-id <id> -e Nee Omgeving om een query uit te voeren. Standaard vanaf ms.config.json indien aanwezig.
--search <term> -s Nee Filteren op subtekenreeksovereenkomst op weergavenaam of id van connector (niet hoofdlettergevoelig).
--include-blocked Nee Vermeld ook connectors die door tenantbeleid worden geblokkeerd. Standaard worden alleen toegestane verbindingslijnen weergegeven.

ms connector list-actions

Vermeld de bewerkingen die worden weergegeven door een connector, inclusief de DLP-status per bewerking.

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

ms connector list-actions Parameters

Parameter Alias Vereist? Beschrijving
--connector <connector> Ja Connector die moet worden geïnspecteerd, op id.
--environment-id <id> -e Nee Omgeving om een query uit te voeren. Standaard vanaf ms.config.json indien aanwezig.
--search <term> -s Nee Filteren op subtekenreeksovereenkomst op samenvatting van bewerking of actie-id (niet hoofdlettergevoelig).

App-bronnen beheren

Gebruik deze opdrachten om de gegevensbronnen waarvan uw app afhankelijk is, toe te voegen, te verwijderen en te vernieuwen.

App-bronnen toevoegen

Voer alle add opdrachten uit vanuit de map waarin de app zich bevindt. Standaard genereren ze TypeScript-modellen en -services onder generated/.

ms app add data-source

Een connector aan de app toevoegen, waarbij automatisch wordt gekozen tussen tabel- en actiegegevensbronnen.

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

Opmerking

  • Met de CLI worden niet-tabelvormige connectors automatisch als acties toegevoegd.
  • De CLI vraagt om tabel versus actie in interactieve modus voor tabelvormige connectors. U moet opgeven --as in de niet-interactieve modus.
  • DLP en ACP Preflight worden uitgevoerd voordat er een actie of tabel is toegevoegd. De CLI filtert geblokkeerde bewerkingen uit en rapporteert dat de telling is overgeslagen.

ms app add data-source Parameters

Parameter Alias Vereist? Beschrijving
--connector <connector> Ja Connector die moet worden toegevoegd, met een id (bijvoorbeeld ) of weergavenaam, shared_office365van ms connector list.
--as <mode> Voorwaardelijk Force table of action dispatch. Vereist in niet-interactieve modus wanneer de connector tabellen ondersteunt.
--connection-id <id> -c Nee Bestaande verbinding om te gebruiken. De CLI vraagt wanneer deze wordt weggelaten.
--dataset <name> -d Nee Gegevensset (gebruikt met --as table).
--table <name> -t Nee Op te tellen tabel (gebruikt met --as table). Voor Dataverse (shared_commondataserviceforapps), is dit de logische tabelnaam.
--dataverse-environment-id <guid> Nee Dataverse-omgevings-id. Alleen gebruikt voor --connector shared_commondataserviceforapps binding aan een specifieke tabel.
--use-sso Nee Geef de voorkeur aan een verbinding voor eenmalige aanmelding (Entra ID): gebruik de eerste bestaande SSO-verbinding opnieuw of maak er een op de achtergrond. Fouten als de connector niet geschikt is voor eenmalige aanmelding. Wordt genegeerd wanneer --connection-id opgegeven.

App-bronnen verwijderen

Verwijderopdrachten vragen om bevestiging, tenzij u slaagt --force.

ms app remove data-source

Een eerder toegevoegde gegevensbron (tabel of actie) verwijderen uit de app.

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

ms app remove data-source Parameters

Parameter Alias Vereist? Beschrijving
--name <name> -n Nee De naam van de gegevensbron die u wilt verwijderen. De CLI vraagt je om te kiezen uit de gegevensbronnen van de app wanneer deze wordt weggelaten.
--force -f Nee Hiermee wordt de bevestigingsprompt overgeslagen.

App-bronnen vernieuwen

Gebruik deze opdracht om gegenereerde app-typen te synchroniseren met de meest recente wijzigingen in het bronschema.

ms app refresh data-source

Haal het schema opnieuw op en genereer TypeScript opnieuw voor afhankelijke gegevensbronnen.

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

Voer deze opdracht uit nadat het onderliggende schema is gewijzigd (bijvoorbeeld een nieuwe kolom in een SharePoint-lijst) om het gegenereerde TypeScript gesynchroniseerd te houden.

ms app refresh data-source Parameters

Parameter Alias Vereist? Beschrijving
--name <name> -n Nee Een bepaalde gegevensbron vernieuwen. Laat weg om alle afhankelijke bronnen te vernieuwen.

Lokaal ontwikkelen

Gebruik deze opdrachten om uw app lokaal uit te voeren met de configuratieserver voor iteratieve ontwikkeling.

ms app dev

Start de volledige lokale ontwikkelingslus.

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

De CLI start het ontwikkelproces van het project naast een lokale configuratieserver. De afspeel-URL wordt afgedrukt zodra beide bereikbaar zijn. Druk Ctrl+C om ze netjes te stoppen.

ms app dev Parameters

Parameter Alias Vereist? Beschrijving
--port <n> -p Nee Poort voor de configuratieserver. De standaardinstelling is 8080.
--local-app-url <url> -l Nee URL waar de ontwikkelaarsserver bereikbaar is. De standaardinstelling is http://localhost:3000.
--config-only -C Nee Start alleen de configuratieserver, wanneer u de ontwikkelaarsserver afzonderlijk uitvoert (bijvoorbeeld onder een procesbeheerder).

Bouwen en implementeren

Gebruik deze opdrachten om lokaal in te pakken, externe builds uit te voeren en een gevalideerde doorvoering te implementeren.

ms app pack

Bouw de app lokaal en faseer de uitvoer voor inspectie zonder deze ergens naartoe te uploaden.

ms app pack

Gebruik deze opdracht om te controleren of een schone lokale build slaagt voordat u een externe build activeert.

ms app build

Activeer een platformbuild voor een specifieke commit op een door Git ondersteunde app.

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

ms app build Parameters

Parameter Alias Vereist? Beschrijving
--app <name> Nee App-naam. Standaard vanaf ms.config.json indien aanwezig.
--commit <sha> -c Nee Commit to build. De standaardinstelling is het huidige HEAD.
--no-wait Nee Retourneer onmiddellijk na verzending en druk een hint af om op te volgen ms app build-status. Standaard wacht de opdracht totdat de build een terminalstatus heeft bereikt.
--open-browser Nee Best-effort: start de systeembrowser als Device Code Flow opnieuw moet worden geverifieerd voor externe GitHub-opslaglocaties. Heeft geen effect op --json.
--force-reauth Nee Omzeil de opgeslagen GitHub-toewijzing en forceer Device Code Flow. Dit geldt alleen voor apps die zijn gebonden aan een externe GitHub-opslagplaats.

ms app build-status

Controleer de status van een build.

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

Als de build is mislukt, bevat de uitvoer de reden, zodat je de code kunt herstellen en opnieuw kunt pushen.

ms app build-status Parameters

Parameter Alias Vereist? Beschrijving
--app <name> Nee App om te inspecteren. Standaard vanaf ms.config.json indien aanwezig.
--commit <sha> -c Nee Commit to check for build status. De standaardinstelling is het huidige HEAD.
--show-log Nee Haal het buildlogboek op en druk het af, indien beschikbaar.

ms app deploy

Een groene build promoveren naar de live-app.

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

Opmerking

  • De opdracht wordt geïmplementeerd in de omgeving die aan de app is gekoppeld. Er wordt geen implementatieomgeving geselecteerd.
  • Voor door Git ondersteunde apps lost de CLI de doorvoer op (standaard HEAD), waarschuwt voor niet-vastgelegde lokale wijzigingen, plaatst een externe build in de wachtrij, peilt tot voltooiing en implementeert de resulterende build.
  • Voor apps zonder bronbeheer (repoType: none), pakt en uploadt de CLI de lokale build, of uploadt een vooraf gemaakte .zip build wanneer --artifact deze wordt geleverd.

ms app deploy Parameters

Parameter Alias Vereist? Beschrijving
--app <name> Nee Te implementeren app. Standaardinstelling van ms.config.json.
--commit <sha> -c Nee Commit to deploy (alleen apps met Git-ondersteuning). De standaardinstelling is het huidige HEAD. Wederzijds exclusief met --artifact.
--artifact <path> Nee Pad naar een lokaal .zip buildartefact om te uploaden en implementeren. Alleen geldig voor apps die zijn gemaakt zonder bronbeheer (repoType: none); geweigerd op apps die door Git worden ondersteund. Wederzijds exclusief met --commit.
--open-browser Nee Best effort om de systeembrowser te starten als Device Code Flow opnieuw moet worden geverifieerd. Heeft geen effect op --json.
--force-reauth Nee Omzeil de opgeslagen GitHub-toewijzing en forceer Device Code Flow. Dit geldt alleen voor apps die zijn gebonden aan een externe GitHub-opslagplaats.

ms app deploy --artifact <path> uploadt en implementeert het artefact zonder een door een platform beheerde build. De implementatie van externe artefacten is standaard niet toegestaan. Zie Implementatie van externe artefacten.

Uw organisatie is verantwoordelijk voor het valideren van extern gebouwde artefacten en het beveiligen van de build-pijplijn vóór de implementatie.

Afspelen

Gebruik deze opdracht om uw app te openen in de live- of preview-modus.

ms app play

Open een app in de browser en druk de start-URL af.

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

ms app play Parameters

Parameter Alias Vereist? Beschrijving
--app <name> Nee Te openen app. Standaardinstelling van ms.config.json.
--mode <mode> -m Nee live Hiermee opent u de geïmplementeerde app. preview Hiermee open je de nieuwste build op main, of een specifieke doorvoering in combinatie met --commit. De standaardinstelling is live.
--commit <sha> -c Nee Open het voorbeeld met een specifieke doorvoer. Alleen geldig met --mode preview.
--no-browser Nee Druk de start-URL af zonder de standaardbrowser te openen. Handig voor SSH-sessies, CI en scripts.

Opmerking

--mode live Waarschuwt dat de live-versie een momentopname is en niet automatisch wordt bijgewerkt. Opnieuw uitvoeren ms app deploy om het te vernieuwen. Als de app nooit wordt geïmplementeerd, --mode live mislukt deze met een gebruiksfout die u verwijst naar ms app deploy.

Delen

Gebruik deze opdrachten om app-toegang te verlenen, in te trekken en te beheren en om koppelingen te delen.

ms app share

Toegang verlenen aan gebruikers of groepen.

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

Met deze opdracht wordt automatisch gezocht naar e-mailadressen. Er worden waarschuwingen gerapporteerd voor meldingen die niet worden opgelost, maar er wordt verder gegaan met de invoer die dat wel doet. De opdracht mislukt als er geen vermeldingen zijn opgelost.

ms app share Parameters

Parameter Alias Vereist? Beschrijving
<principals> Ja Door komma's gescheiden lijst met e-mailadressen of Microsoft Entra-object-id's.
--app <name> Nee App om te delen. Standaardinstelling van ms.config.json.
--access <level> Nee Toegang tot runtime verlenen (playstandaard) of repository-edit (edit).

ms app unshare

Eerder verleende toegang intrekken.

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

De unshare opdracht is alleen van invloed op het gevraagde toegangsniveau. Hiermee unshare --access edit blijft play bijvoorbeeld de toegang intact. Principals zonder een bestaande roltoewijzing op het gevraagde niveau zijn no-ops.

ms app unshare Parameters

Parameter Alias Vereist? Beschrijving
<principals> Ja Door komma's gescheiden lijst met e-mailadressen of Microsoft Entra-object-id's.
--app <name> Nee App om delen ongedaan te maken. Standaardinstelling van ms.config.json.
--access <level> Nee Trek runtime-toegang in (play, standaard) of toegang tot repository-bewerken (edit).

ms app share list

Vermeld de gebruikers en groepen waarmee een app wordt gedeeld op een bepaald toegangsniveau.

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

ms app share list Parameters

Parameter Alias Vereist? Beschrijving
--access <level> Ja Toegangsniveau naar lijst. ( play Voer de app uit) of edit (wijzig de onderliggende opslagplaats).
--app <name> Nee App om te inspecteren. Standaardinstelling van ms.config.json.
--environment-id <id> -e Nee Overschrijf de omgevings-id. Standaard vanaf ms.config.json indien aanwezig.

Maak een koppeling voor het delen van de app op tenantniveau.

ms app share link create [--app <name>] [--environment-id <id>]
Parameter Alias Vereist? Beschrijving
--app <name> Nee App om te delen. Standaardinstelling van ms.config.json.
--environment-id <id> -e Nee Overschrijf de omgevings-id. Standaard vanaf ms.config.json indien aanwezig.

Koppelingen voor lijstshare die zijn uitgegeven voor de app.

ms app share link list [--app <name>] [--environment-id <id>]
Parameter Alias Vereist? Beschrijving
--app <name> Nee App om te inspecteren. Standaardinstelling van ms.config.json.
--environment-id <id> -e Nee Overschrijf de omgevings-id. Standaard vanaf ms.config.json indien aanwezig.

Een koppeling voor delen intrekken op basis van een id. Met deze opdracht wordt elke eerdere rol van de verlosser verwijderd voordat de koppelingsrecord wordt afgebroken.

ms app share link revoke --link-id <id> [--app <name>] [--environment-id <id>] [--force]
Parameter Alias Vereist? Beschrijving
--link-id <id> -l Ja De koppelings-id die wordt geretourneerd van ms app share link create.
--app <name> Nee App die eigenaar is van de koppeling. Standaardinstelling van ms.config.json.
--environment-id <id> -e Nee Overschrijf de omgevings-id. Standaard vanaf ms.config.json indien aanwezig.
--force -f Nee Hiermee wordt de bevestigingsprompt overgeslagen.

Inspecteren en beheren

Gebruik deze opdrachten om de app-status te bekijken, instellingen bij te werken en zo nodig apps te verwijderen.

ms app list

Lijst met alle apps waartoe u toegang hebt. Standaard worden alle apps in de tenant weergegeven; Ga --environment-id naar het bereik over op één enkele omgeving.

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

Retourneert weergavenaam, app-id, bibliotheek-URL en eigenaren voor elke app.

ms app list Parameters

Parameter Alias Vereist? Beschrijving
--environment-id <id> -e Nee Beperk het bereik van de vermelding tot één enkele omgeving. Als u dit argument weglaat, worden alle apps geretourneerd die u in de tenant kunt openen.
--permission <level> -p Nee Filter voor machtigingen. Ofwel edit (apps waaraan u kunt bijdragen; standaard) of play (apps die u kunt afspelen/bekijken). Niet hoofdlettergevoelig.

ms app show

De lokale app-configuratie en alle afhankelijke bronnen weergeven.

ms app show

Hiermee wordt de lokale configuratie van de app in de huidige map gelezen.

ms app info

Geeft de serverstatus van de app weer.

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

Retourneert weergavenaam, app-id, bibliotheek-URL, eigenaren, omgevings-id, laatst geïmplementeerde doorvoer en de live- en preview-URL's.

ms app info Parameters

Parameter Alias Vereist? Beschrijving
--app <name> Nee Naam van de app die moet worden gecontroleerd. Standaardinstelling van ms.config.json. Geef een expliciete naam op om een app buiten de huidige werkmap te inspecteren.
--environment-id <id> -e Nee Overschrijf de omgevings-id. Standaardinstelling van; wanneer geen van beide is ingesteld, wordt de omgeving automatisch omgezet op basis van ms.config.jsonde app-naam.

ms app get-settings

Toont alle app-instellingen en hun huidige waarden.

ms app get-settings

Informatie over het weergeven van app-instellingen

ms app set-setting

Updates een of meer app-instellingen.

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

Geef instellingen door als benoemde vlaggen. Alleen de opgegeven toetsen worden bijgewerkt.

ms app set-setting Parameters

Parameter Alias Vereist? Beschrijving
--show-header <bool> Nee De koptekstbalk van de app weergeven of verbergen.
[other-settings...] Nee Een of meer benoemde instellingvlaggen om bij te werken. Alleen de opgegeven toetsen worden gewijzigd.

Meer informatie over het configureren van een app-instelling

ms app delete

Hiermee verwijdert u de app uit de omgeving. Hiermee wordt de lokale broncode of de Git-opslagplaats niet verwijderd.

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

Als de app niet bestaat, wordt de opdracht foutloos afgesloten.

ms app delete Parameters

Parameter Alias Vereist? Beschrijving
--app <name> Nee App om te verwijderen. Standaardinstelling van ms.config.json.
--environment-id <id> -e Nee Overschrijf de omgevings-id. Wanneer dit argument wordt weggelaten, wordt de omgeving automatisch vanuit de app omgezet. Handig voor het verwijderen van een app van buiten de steigermap.
--force -f Nee Hiermee wordt de bevestigingsprompt overgeslagen.

Telemetrie

De CLI verzendt standaard geanonimiseerde telemetrie. Gebruik deze opdrachten om het verzamelen te beheren.

ms telemetry enable

Schakel telemetrieverzameling in.

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

ms telemetry enable Parameters

Parameter Alias Vereist? Beschrijving
--remote Nee Het verzenden van telemetrie naar de externe service beheren. Dit is de standaardoptie wanneer er geen vlag wordt gegeven.
--console Nee Telemetriegebeurtenissen afdrukken naar de lokale console.

Geef beide vlaggen door om beide doelen tegelijk in of uit te schakelen.

ms telemetry disable

Schakel telemetrieverzameling uit.

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

ms telemetry disable Parameters

Parameter Alias Vereist? Beschrijving
--remote Nee Stop met het verzenden van telemetriegegevens naar de externe service. Dit is de standaardoptie wanneer er geen vlag wordt gegeven.
--console Nee Het afdrukken van telemetriegebeurtenissen naar de lokale console stoppen.

Geef beide vlaggen door om beide doelen tegelijk uit te schakelen.

ms telemetry status

De huidige instellingen voor telemetrie weergeven.

ms telemetry status
  • Laatst bijgewerkt om