Freigeben über


Befehle

Installation

Schritt 1: Installieren von .NET Windows Runtime

Wenn dies noch nicht geschehen ist, installieren Sie die neueste Version von .NET 8 Desktop Runtime. Dies ist notwendig, damit Microsoft Store Developer CLI ausgeführt werden kann.

Die einfachste Möglichkeit der Installation ist die Verwendung von winget:

winget install Microsoft.DotNet.DesktopRuntime.8

Schritt 2: Installieren der Microsoft Store Developer CLI unter Windows

Sie können Microsoft Store Developer CLI aus Microsoft Store herunterladen. Alternativ können Sie auch winget verwenden:

winget install "Microsoft Store Developer CLI"

Schritt 1: Installieren von .NET macOS Runtime

Wenn dies noch nicht geschehen ist, installieren Sie die neueste Version von .NET 8 Runtime. Dies ist notwendig, damit Microsoft Store Developer CLI ausgeführt werden kann.

Schritt 2: Installieren der Microsoft Store Developer CLI unter macOS

Sie können die macOS .tar.gz für Ihre spezifische Architektur (x64 oder Arm64) von der Microsoft Store Developer CLI-Veröffentlichungsseite herunterladen. Extrahieren Sie nach dem erfolgreichen Download das Archiv und fügen Sie es nach Belieben in Ihren PFAD ein, z. B.:

mkdir MSStoreCLI
curl https://github.com/microsoft/msstore-cli/releases/latest/download/MSStoreCLI-osx-x64.tar.gz -o MSStoreCLI-osx-x64.tar.gz
tar -xvf MSStoreCLI-osx-x64.tar.gz -C ./MSStoreCLI
sudo cp -R MSStoreCLI/. /usr/local/bin

Alternativ können Sie auch brew verwenden:

brew install microsoft/msstore-cli/msstore-cli

Schritt 1: Installieren von .NET Linux Runtime

Wenn dies noch nicht geschehen ist, installieren Sie die neueste Version von .NET 8 Runtime. Dies ist notwendig, damit Microsoft Store Developer CLI ausgeführt werden kann.

Schritt 2: Installieren der Microsoft Store Developer CLI unter Linux

Sie können die .tar.gz für Linux für Ihre spezifische Architektur (x64 oder Arm64) von der Microsoft Store Developer CLI-Veröffentlichungsseite herunterladen. Extrahieren Sie nach dem erfolgreichen Download das Archiv und fügen Sie es nach Belieben in Ihren PFAD ein, z. B.:

mkdir MSStoreCLI
wget https://github.com/microsoft/msstore-cli/releases/latest/download/MSStoreCLI-linux-x64.tar.gz
tar -xvf MSStoreCLI-linux-x64.tar.gz -C ./MSStoreCLI
sudo cp -R MSStoreCLI/. /usr/local/bin

Alternativ können Sie auch brew verwenden:

brew install microsoft/msstore-cli/msstore-cli

Befehl „Info“

Vorhandene Konfiguration drucken.

Infobefehl – Verwendung

msstore info

Infobefehl - Optionen

Option Beschreibung
-v, --verbose Ausführliche Ausgabe drucken.

Befehl „reconfigure“

Konfigurieren Sie die Microsoft Store Developer CLI erneut. Sie können entweder einen geheimen Clientschlüssel oder ein Zertifikat angeben. Zertifikate können entweder über den Fingerabdruck oder durch Bereitstellen eines Dateipfads (mit oder ohne Kennwort) bereitgestellt werden.

Neukonfiguration – Verwendung

msstore reconfigure

Neu konfigurieren – Optionen

Option Beschreibung
-t, --tenantId Geben Sie die Mandanten-ID an, die verwendet werden soll.
-s, --sellerId Geben Sie die Verkäufer-ID an, die verwendet werden soll.
-c, --clientId Geben Sie die Client-ID an, die verwendet werden soll.
-cs, --clientSecret Geben Sie den geheimen Clientschlüssel an, der verwendet werden soll.
-ct, --certificateThumbprint Geben Sie den Zertifikatfingerabdruck an, der verwendet werden soll.
-cfp, --certificateFilePath Geben Sie den Zertifikatdateipfad an, der verwendet werden soll.
-cp, --certificatePassword Geben Sie das Zertifikatkennwort an, das verwendet werden soll.
--zurücksetzen Setzen Sie die Anmeldeinformationen nur zurück, ohne zu beginnen.

Settings-Befehl

Ändern Sie die Einstellungen der Microsoft Store Developer CLI.

Einstellungen – Verwendung

msstore settings
Unterbefehl Beschreibung
setpdn Legen Sie die Publisher-Anzeigename-Eigenschaft fest, die vom Init-Befehl verwendet wird.

Einstellungen – Optionen

Option Beschreibung
-t, --enableTelemetry Aktivieren (leer/true) oder Deaktivieren (false) Telemetrie.
-v, --verbose Ausführliche Ausgabe drucken.

Einstellungen – SetPDN-Befehlsverwendung

msstore settings setpdn <publisherDisplayName>

Argumente

Argument Beschreibung
publisherDisplayName Die Publisher-Anzeigename-Eigenschaft, die global festgelegt wird.

Hilfe

msstore settings setpdn --help

Befehl „apps“

Unterbefehl Beschreibung
list Listet alle Anwendungen in Ihrem Konto auf.
get Ruft die Details einer bestimmten Anwendung ab.

Apps – Verwendung von Listenbefehlen

msstore apps list

Listenbefehl – Hilfe

msstore apps list --help

Apps – Abrufen der Befehlsverwendung

msstore apps get <productId>

Apps – Befehlsargumente abrufen

Argument Beschreibung
productId Die Produkt-ID.

Apps – Befehlshilfe abrufen

msstore apps get --help

Befehl „submission“

Unterbefehl Beschreibung
status Ruft den Status einer Übermittlung ab.
get Ruft die Details einer bestimmten Übermittlung ab.
getListingAssets Ruft die Auflistungsressourcen einer bestimmten Übermittlung ab.
updateMetadata Aktualisiert die Metadaten einer bestimmten Übermittlung.
Aktualisierung Aktualisiert die Details einer bestimmten Übermittlung.
Umfrage Fragt den Status einer Übermittlung ab.
Veröffentlichen Veröffentlicht eine bestimmte Übermittlung.
Löschen Löscht eine bestimmte Übermittlung.

Übermittlung – Statusbefehlsverwendung

msstore submission status <productId>

Übermittlung – Statusbefehlsargumente

Argument Beschreibung
productId Die Produkt-ID.

Übermittlung – Hilfe zum Statusbefehl

msstore submission status --help

Übermittlung – Abrufen der Befehlsverwendung

msstore submission get <productId>

Übermittlung – Befehlsargumente abrufen

Argument Beschreibung
productId Die Produkt-ID.

Übermittlung – Befehlsoptionen abrufen

Option Beschreibung
-m, --module Wählen Sie aus, welches Modul Sie abrufen möchten ('Verfügbarkeit', 'Auflistungen' oder 'Eigenschaften').
-l, --language Wählen Sie aus, welche Sprache Sie abrufen möchten. [standard: en]

Übermittlung – Befehlshilfe abrufen

msstore submission get --help

Übermittlung – Verwendung des Befehls "GetListingAssets"

Ruft die vorhandenen Entwurfsauflistungsressourcen aus der Store-Übermittlung ab.

msstore submission getListingAssets <productId>

Übermittlung – GetListingAssets-Befehlsargumente

Argument Beschreibung
productId Die Produkt-ID.

Übermittlung – GetListingAssets-Befehlsoptionen

Option Beschreibung
-l, --language Wählen Sie aus, welche Sprache Sie abrufen möchten. [standard: en]

Übermittlung – GetListingAssets-Befehlshilfe

msstore submission getListingAssets --help

Übermittlung – UpdateMetadata-Befehlsverwendung

msstore submission updateMetadata <productId> <metadata>

Übermittlung – UpdateMetadata-Befehlsargumente

Argument Beschreibung
productId Die Produkt-ID.
metadata Die aktualisierte JSON-Metadatendarstellung.

Übermittlung – UpdateMetadata-Befehlsoptionen

Option Beschreibung
-s, --skipInitialPolling Überspringen Sie die anfängliche Abfrage, bevor Sie die Aktion ausführen. [Standard: False]

Übermittlung – UpdateMetadata-Befehlshilfe

msstore submission updateMetadata --help

Übermittlung – Befehlsverwendung aktualisieren

msstore submission update <productId> <product>

Übermittlung – Befehlsargumente aktualisieren

Argument Beschreibung
productId Die Produkt-ID.
product Die aktualisierte JSON-Produktdarstellung.

Übermittlung – Befehlsoptionen aktualisieren

Option Beschreibung
-s, --skipInitialPolling Überspringen Sie die anfängliche Abfrage, bevor Sie die Aktion ausführen. [Standard: False]

Übermittlung – Hilfe zum Aktualisieren von Befehlen

msstore submission update --help

Übermittlung – Verwendung des Abrufbefehls

msstore submission poll <productId>

Übermittlung – Abfragebefehlsargumente

Argument Beschreibung
productId Die Produkt-ID.

Übermittlung – Hilfe zum Abrufen von Befehlen

msstore submission poll --help

Übermittlung – Verwendung des Befehls veröffentlichen

msstore submission publish <productId>

Übermittlung – Befehlsargumente veröffentlichen

Argument Beschreibung
productId Die Produkt-ID.

Übermittlung – Hilfe zum Veröffentlichen von Befehlen

msstore submission publish --help

Übermittlung – Befehlsverwendung löschen

Löscht die ausstehende Übermittlung aus dem Speicher.

Übermittlung – Befehlsargumente löschen

Argument Beschreibung
productId Die Produkt-ID.

Übermittlung – Befehlsoptionen löschen

Option Beschreibung
--no-confirm Nicht zur Bestätigung auffordern [Standard: False]

Übermittlung – Hilfe zum Löschen von Befehlen

msstore submission delete --help

Befehl „init“

Mit init dem Befehl können Sie Ihre Anwendung so einrichten, dass sie im Microsoft Store veröffentlicht wird. Es unterstützt derzeit die folgenden Anwendungstypen:

  • Windows App SDK/WinUI 3
  • UWP
  • .NET MAUI
  • Flutter
  • Electron
  • React Native für Desktop
  • PWA

Befehl "Init" – Verwendungsbeispiele

Befehl "Init" – Windows App SDK/WinUI 3

msstore init "C:\path\to\winui3_app"

Befehl "Init" – UWP

msstore init "C:\path\to\uwp_app"

Befehl "Init" – .NET MAUI

msstore init "C:\path\to\maui_app"

Befehl "Init" – Flöte

msstore init "C:\path\to\flutter_app"

Init-Befehl - Elektronen

msstore init "C:\path\to\electron_app"

Befehl "Init" – React Native für Desktop

msstore init "C:\path\to\react_native_app"

Hinweis

Sowohl für Electron als auch React Native for Desktop-Projekte werden Yarn beide Npm unterstützt. Das Vorhandensein der Yarn Sperrdatei (yarn.lock) wird verwendet, um zu bestimmen, welcher Paket-Manager verwendet werden soll. Stellen Sie daher sicher, dass Sie die Sperrdatei in Ihrem Quellcodeverwaltungssystem einchecken.

Befehl "Init" – PWA

msstore init https://contoso.com --output .

Befehl "Init" – Argumente

Argument Beschreibung
pathOrUrl Der Stammverzeichnispfad, in dem sich die Projektdatei befindet, oder eine öffentliche URL, die auf eine PWA verweist.

Befehl "Init" – Optionen

Option Beschreibung
-n, --publisherDisplayName Der Publisher-Anzeigename, der zum Konfigurieren der Anwendung verwendet wird. Wenn angegeben, vermeiden Sie einen zusätzlichen APIs-Aufruf.
--Paket Wenn der App-Typ unterstützt wird, packt das Projekt automatisch.
--veröffentlichen Wenn der App-Typ unterstützt wird, veröffentlicht das Projekt automatisch. Impliziert "--package true"
-f, --flightId Gibt die Flight-ID an, in der das Paket veröffentlicht wird.
-prp, --packageRolloutPercentage Gibt den Rollout-Prozentsatz des Pakets an. Der Wert muss zwischen 0 und 100 liegen.
-a, --arch Die zu erstellenden Architekturen. Wenn nicht angegeben, wird die Standardarchitektur für das aktuelle Betriebssystem und den Projekttyp verwendet. Zulässige Werte: "x86", "x64", "arm64". Wird nur in Verbindung mit "--package true" verwendet.
-o, --output Das Ausgabeverzeichnis, in dem die verpackte App gespeichert wird. Wenn nicht angegeben, wird das Standardverzeichnis für jeden anderen App-Typ verwendet.
-ver, --version Die Version, die beim Erstellen der App verwendet wird. Wenn nicht angegeben, wird die Version aus der Projektdatei verwendet.

Befehl „package“

Hilft Ihnen, Ihre Microsoft Store-Anwendung als MSIX zu verpacken.

Paketbefehl – Verwendungsbeispiele

Paketbefehl – Windows App SDK/WinUI 3

msstore package "C:\path\to\winui3_app"

Paketbefehl – UWP

msstore package "C:\path\to\uwp_app"

Paketbefehl - .NET MAUI

msstore package "C:\path\to\maui_app"

Befehl 'Paket' – Flöte

msstore package "C:\path\to\flutter_app"

Paketbefehl - Electron

msstore package "C:\path\to\electron_app"

Paketbefehl – React Native für Desktop

msstore package "C:\path\to\react_native_app"

Paketbefehl - PWA

msstore package "C:\path\to\pwa_app"

Paketbefehl - Argumente

Option Beschreibung
pathOrUrl Der Stammverzeichnispfad, in dem sich die Projektdatei befindet, oder eine öffentliche URL, die auf eine PWA verweist.

Befehl 'Paket' – Optionen

Option Beschreibung
-o, --output Das Ausgabeverzeichnis, in dem die verpackte App gespeichert wird. Wenn nicht angegeben, wird das Standardverzeichnis für jeden anderen App-Typ verwendet.
-a, --arch Die zu erstellenden Architekturen. Wenn nicht angegeben, wird die Standardarchitektur für das aktuelle Betriebssystem und den Projekttyp verwendet. Zulässige Werte: "x86", "x64", "arm64".
-ver, --version Die Version, die beim Erstellen der App verwendet wird. Wenn nicht angegeben, wird die Version aus der Projektdatei verwendet.

Befehl „Publish“

Veröffentlicht Ihre Anwendungen im Microsoft Store.

Befehl "Veröffentlichen" – Verwendungsbeispiele

Befehl "Veröffentlichen" – Windows App SDK/WinUI 3

msstore publish "C:\path\to\winui3_app"

Befehl "Veröffentlichen" – UWP

msstore publish "C:\path\to\uwp_app"

Befehl 'Veröffentlichen' – .NET MAUI

msstore publish "C:\path\to\maui_app"

Befehl 'Veröffentlichen' – Fluter

msstore publish "C:\path\to\flutter_app"

Befehl "Veröffentlichen" – Electron

msstore publish "C:\path\to\electron_app"

Befehl "Veröffentlichen" – React Native für Desktop

msstore publish "C:\path\to\react_native_app"

Befehl 'Veröffentlichen' – PWA

msstore publish "C:\path\to\pwa_app"

Befehl 'Veröffentlichen' – Argumente

Option Beschreibung
pathOrUrl Der Stammverzeichnispfad, in dem sich die Projektdatei befindet, oder eine öffentliche URL, die auf eine PWA verweist.

Befehl "Veröffentlichen" – Optionen

Option Beschreibung
-i, --inputDirectory Das Verzeichnis mit der „.msix“- oder „.msixupload“-Datei, die für den Veröffentlichungsbefehl verwendet werden soll. Wenn nicht angegeben, versucht die CLI die beste Option auf Basis des Arguments „pathOrUrl“ zu finden.
-id, --appId Gibt die Anwendungs-ID an. Nur erforderlich, wenn das Projekt noch nicht mit dem Befehl „init“ initialisiert wurde.
-nc, --noCommit Deaktiviert das Commit für die Übermittlung und behält sie im Entwurfszustand bei.
-f, --flightId Gibt die Flight-ID an, in der das Paket veröffentlicht wird.
-prp, --packageRolloutPercentage Gibt den Rollout-Prozentsatz des Pakets an. Der Wert muss zwischen 0 und 100 liegen.

CI/CD-Umgebungen

Die Microsoft Store Developer CLI (Vorschau) unterstützt die Ausführung in CI/CD-Umgebungen. Dies bedeutet, dass Sie die Microsoft Store Developer CLI (Vorschau) in Ihren CI/CD-Pipelines verwenden können, um beispielsweise Ihre Anwendungen automatisch im Microsoft Store zu veröffentlichen.

Der erste Schritt, um dies zu erreichen, um die Microsoft Store Developer CLI (Vorschau) in Ihrer CI/CD-Umgebung zu installieren. Anleitungen dazu finden Sie hier.

Nach der Installation der Microsoft Store Developer CLI (Vorschau) müssen Sie Ihre Umgebung so konfigurieren, dass Befehle ausgeführt werden können. Dazu können Sie den msstore reconfigure Befehl mit den spezifischen Parametern ausführen, die Ihr Partner Center-Konto (TenantId, SellerId, ClientId) identifizieren. Außerdem müssen Sie entweder einen ClientSecret oder ein Zertifikat angeben.

Es ist sehr wichtig, diese Anmeldeinformationen auszublenden, da sie in den Protokollen Ihrer CI/CD-Pipeline sichtbar sind. Dazu können Sie geheime Schlüssel verwenden. Jedes CI/CD-Pipelinesystem hat für diese geheimen Schlüssel unterschiedliche Namen. Beispielsweise rufen Azure DevOps sie geheime Variablen auf, aber GitHub Action ruft sie verschlüsselte Geheime Schlüssel auf. Erstellen Sie einen geheimen Schlüssel für jeden Parameter (TenantId, SellerId, ClientId und ClientSecret oder ein Zertifikat), und verwenden Sie dann den reconfigure Befehl, um Ihre Umgebung einzurichten.

Zum Beispiel:

Azure DevOps

- task: UseMSStoreCLI@0
  displayName: Setup Microsoft Store Developer CLI
- script: msstore reconfigure --tenantId $(PARTNER_CENTER_TENANT_ID) --sellerId $(PARTNER_CENTER_SELLER_ID) --clientId $(PARTNER_CENTER_CLIENT_ID) --clientSecret $(PARTNER_CENTER_CLIENT_SECRET)
  displayName: Configure Microsoft Store Developer CLI

GitHub Actions

- name: Setup Microsoft Store Developer CLI
  uses: microsoft/setup-msstore-cli@v1
- name: Configure Microsoft Store Developer CLI
  run: msstore reconfigure --tenantId ${{ secrets.PARTNER_CENTER_TENANT_ID }} --sellerId ${{ secrets.PARTNER_CENTER_SELLER_ID }} --clientId ${{ secrets.PARTNER_CENTER_CLIENT_ID }} --clientSecret ${{ secrets.PARTNER_CENTER_CLIENT_SECRET }}

Sobald dieser Befehl ausgeführt wird, wird die Microsoft Store Developer CLI (Vorschau) für die Verwendung der bereitgestellten Anmeldeinformationen konfiguriert. Sie können jetzt die Microsoft Store Developer CLI (Vorschau) in Ihrer CI/CD-Pipeline verwenden.