Skip to content

Commit dd2b108

Browse files
Merge pull request #5272 from MicrosoftDocs/msstorecli_flights_fix
Fixed MSStore CLI Flights commands
2 parents 2fc314d + bb411d3 commit dd2b108

19 files changed

Lines changed: 339 additions & 514 deletions

hub/apps/publish/msstore-dev-cli/commands.md

Lines changed: 338 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ zone_pivot_groups: msstoredevcli-installer-packaging
1414

1515
### Step 1: Install .NET Windows Runtime
1616

17-
If you haven't done so already, install the latest version of the [.NET 8 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/8.0). This is a requirement to run the Microsoft Store Developer CLI.
17+
If you haven't done so already, install the latest version of the [.NET 9 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/9.0). This is a requirement to run the Microsoft Store Developer CLI.
1818

1919
The easiest way to install it is to use _winget_:
2020

2121
```console
22-
winget install Microsoft.DotNet.DesktopRuntime.8
22+
winget install Microsoft.DotNet.DesktopRuntime.9
2323
```
2424

2525
### Step 2: Install the Microsoft Store Developer CLI on Windows
@@ -35,7 +35,7 @@ winget install "Microsoft Store Developer CLI"
3535

3636
### Step 1: Install .NET macOS Runtime
3737

38-
If you haven't done so already, install the latest version of the [.NET 8 Runtime](https://dotnet.microsoft.com/download/dotnet/8.0). This is a requirement to run the Microsoft Store Developer CLI.
38+
If you haven't done so already, install the latest version of the [.NET 9 Runtime](https://dotnet.microsoft.com/download/dotnet/9.0). This is a requirement to run the Microsoft Store Developer CLI.
3939

4040
### Step 2: Install the Microsoft Store Developer CLI on macOS
4141

@@ -59,7 +59,7 @@ brew install microsoft/msstore-cli/msstore-cli
5959

6060
### Step 1: Install .NET Linux Runtime
6161

62-
If you haven't done so already, install the latest version of the [.NET 8 Runtime](https://dotnet.microsoft.com/download/dotnet/8.0). This is a requirement to run the Microsoft Store Developer CLI.
62+
If you haven't done so already, install the latest version of the [.NET 9 Runtime](https://dotnet.microsoft.com/download/dotnet/9.0). This is a requirement to run the Microsoft Store Developer CLI.
6363

6464
### Step 2: Install the Microsoft Store Developer CLI on Linux
6565

@@ -349,6 +349,340 @@ msstore submission delete <productId>
349349
| -v, --verbose | Print verbose output. |
350350
| -?, -h, --help | Show help and usage information. |
351351

352+
## Flights Command
353+
354+
| Sub-Command | Description |
355+
| ------------------------------------------- | ------------------------------------------------------------ |
356+
| [list](#flights---list-command-usage) | Retrieves all the Flights for the specified Application. |
357+
| [get](#flights---get-command-usage) | Retrieves a flight for the specified Application and flight. |
358+
| [delete](#flights---delete-command-usage) | Deletes a flight for the specified Application and flight. |
359+
| [create](#flights---create-command-usage) | Creates a flight for the specified Application and flight. |
360+
| [submission](#flights---submission-command) | Execute flight submissions related tasks. |
361+
362+
### Flights - List Command Usage
363+
364+
```console
365+
msstore flights list <productId>
366+
```
367+
368+
#### Flights - List Command Arguments
369+
370+
| Argument | Description |
371+
| ----------- | --------------- |
372+
| `productId` | The product ID. |
373+
374+
#### Flights - List Command Help
375+
376+
```console
377+
msstore flights list --help
378+
```
379+
### Flights - Get Command Usage
380+
381+
```console
382+
msstore flights get <productId> <flightId>
383+
```
384+
385+
#### Flights - Get Command Arguments
386+
387+
| Argument | Description |
388+
| ----------- | --------------- |
389+
| `productId` | The product ID. |
390+
| `flightId` | The flight ID. |
391+
392+
#### Flights - Get Command Help
393+
394+
```console
395+
msstore flights get --help
396+
```
397+
398+
### Flights - Delete Command Usage
399+
400+
```console
401+
msstore flights delete <productId> <flightId>
402+
```
403+
404+
#### Flights - Delete Command Arguments
405+
406+
| Argument | Description |
407+
| ----------- | --------------- |
408+
| `productId` | The product ID. |
409+
| `flightId` | The flight ID. |
410+
411+
#### Flights - Delete Command Help
412+
413+
```console
414+
msstore flights delete --help
415+
```
416+
417+
### Flights - Create Command Usage
418+
419+
```console
420+
msstore flights create <productId> <friendlyName> --group-ids <group-ids>
421+
```
422+
423+
#### Flights - Create Command Arguments
424+
425+
| Argument | Description |
426+
| -------------- | -------------------------------- |
427+
| `productId` | The product ID. |
428+
| `friendlyName` | The friendly name of the flight. |
429+
430+
#### Flights - Create Command Options
431+
432+
| Option | Description |
433+
|--------|-------------|
434+
| -g, --group-ids | The group IDs to associate with the flight. |
435+
-r, --rank-higher-than | The flight ID to rank higher than. |
436+
437+
#### Flights - Create Command Help
438+
439+
```console
440+
msstore flights create --help
441+
```
442+
443+
## Flights - Submission Command
444+
445+
| Sub-Command | Description |
446+
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
447+
| [get](#flights---submission-get-command-usage) | Retrieves the existing package flight submission, either the existing draft or the last published one. |
448+
| [delete](#flights---submission-delete-command-usage) | Deletes the pending package flight submission from the store. |
449+
| [update](#flights---submission-update-command-usage) | Updates the existing flight draft with the provided JSON. |
450+
| [publish](#flights---submission-publish-command-usage) | Starts the flight submission process for the existing Draft. |
451+
| [poll](#flights---submission-poll-command-usage) | Polls until the existing flight submission is PUBLISHED or FAILED. |
452+
| [status](#flights---submission-status-command-usage) | Retrieves the current status of the store flight submission. |
453+
| [rollout](#flights---submission---rollout-command) | Execute flight rollout related operations. |
454+
455+
### Flights - Submission Get Command Usage
456+
457+
```console
458+
msstore flights submission get <productId> <flightId>
459+
```
460+
461+
#### Flights - Submission Get Command Arguments
462+
463+
| Argument | Description |
464+
| ----------- | --------------- |
465+
| `productId` | The product ID. |
466+
| `flightId` | The flight ID. |
467+
468+
#### Flights - Submission Get Command Help
469+
470+
```console
471+
msstore flights submission get --help
472+
```
473+
474+
### Flights - Submission Delete Command Usage
475+
476+
```console
477+
msstore flights submission delete <productId> <flightId>
478+
```
479+
480+
#### Flights - Submission Delete Command Arguments
481+
482+
| Argument | Description |
483+
| ----------- | --------------- |
484+
| `productId` | The product ID. |
485+
| `flightId` | The flight ID. |
486+
487+
#### Flights - Submission Delete Command Help
488+
489+
```console
490+
msstore flights submission delete --help
491+
```
492+
493+
### Flights - Submission Update Command Usage
494+
495+
```console
496+
msstore flights submission update <productId> <flightId> <product>
497+
```
498+
499+
#### Flights - Submission Update Command Arguments
500+
501+
| Argument | Description |
502+
| ----------- | ---------------------------------------- |
503+
| `productId` | The product ID. |
504+
| `flightId` | The flight ID. |
505+
| `product` | The updated JSON product representation. |
506+
507+
#### Flights - Submission Update Command Options
508+
509+
| Option | Description |
510+
| ------------------------ | ---------------------------------------------------------------------- |
511+
| -s, --skipInitialPolling | Skip the initial polling before executing the action. [default: False] |
512+
513+
#### Flights - Submission Update Command Help
514+
515+
```console
516+
msstore flights submission update --help
517+
```
518+
519+
### Flights - Submission Publish Command Usage
520+
521+
```console
522+
msstore flights submission publish <productId> <flightId>
523+
```
524+
525+
#### Flights - Submission Publish Command Arguments
526+
527+
| Argument | Description |
528+
| ----------- | --------------- |
529+
| `productId` | The product ID. |
530+
| `flightId` | The flight ID. |
531+
532+
#### Flights - Submission Publish Command Help
533+
534+
```console
535+
msstore flights submission publish --help
536+
```
537+
538+
### Flights - Submission Poll Command Usage
539+
540+
```console
541+
msstore flights submission poll <productId> <flightId>
542+
```
543+
544+
#### Flights - Submission Poll Command Arguments
545+
546+
| Argument | Description |
547+
| ----------- | --------------- |
548+
| `productId` | The product ID. |
549+
| `flightId` | The flight ID. |
550+
551+
#### Flights - Submission Poll Command Help
552+
553+
```console
554+
msstore flights submission poll --help
555+
```
556+
557+
### Flights - Submission Status Command Usage
558+
559+
```console
560+
msstore flights submission status <productId> <flightId>
561+
```
562+
563+
#### Flights - Submission Status Command Arguments
564+
565+
| Argument | Description |
566+
| ----------- |---------------- |
567+
| `productId` | The product ID. |
568+
| `flightId` | The flight ID. |
569+
570+
#### Flights - Submission Status Command Help
571+
572+
```console
573+
msstore flights submission status --help
574+
```
575+
576+
## Flights - Submission - Rollout Command
577+
578+
| Sub-Command | Description |
579+
| ------------------------------------------------------------------ | ----------------------------------------------------- |
580+
| [get](#flights---submission---rollout-get-command-usage) | Retrieves the flight rollout status of a submission. |
581+
| [update](#flights---submission---rollout-update-command-usage) | Update the flight rollout percentage of a submission. |
582+
| [halt](#flights---submission---rollout-halt-command-usage) | Halts the flight rollout of a submission. |
583+
| [finalize](#flights---submission---rollout-finalize-command-usage) | Finalizes the flight rollout of a submission. |
584+
585+
### Flights - Submission - Rollout Get Command Usage
586+
587+
```console
588+
msstore flights submission rollout get <productId> <flightId>
589+
```
590+
591+
#### Flights - Submission - Rollout Get Command Arguments
592+
593+
| Argument | Description |
594+
| ----------- | ------------- |
595+
| `productId` | The product ID. |
596+
| `flightId` | The flight ID. |
597+
598+
#### Flights - Submission - Rollout Get Command Options
599+
600+
| Option | Description |
601+
| ------------------ | ------------------ |
602+
| -s, --submissionId | The submission ID. |
603+
604+
#### Flights - Submission - Rollout Get Command Help
605+
606+
```console
607+
msstore flights submission rollout get --help
608+
```
609+
610+
### Flights - Submission - Rollout Update Command Usage
611+
612+
```console
613+
msstore flights submission rollout update <productId> <flightId> <percentage>
614+
```
615+
616+
#### Flights - Submission - Rollout Update Command Arguments
617+
618+
| Argument | Description |
619+
| ------------ | ----------------------------------------------------------------- |
620+
| `productId` | The product ID. |
621+
| `flightId` | The flight ID. |
622+
| `percentage` | The percentage of users that will receive the submission rollout. |
623+
624+
#### Flights - Submission - Rollout Update Command Options
625+
626+
| Option | Description |
627+
| ------------------ | ------------------ |
628+
| -s, --submissionId | The submission ID. |
629+
630+
#### Flights - Submission - Rollout Update Command Help
631+
632+
```console
633+
msstore flights submission rollout update --help
634+
```
635+
636+
### Flights - Submission - Rollout Halt Command Usage
637+
638+
```console
639+
msstore flights submission rollout halt <productId> <flightId>
640+
```
641+
642+
#### Flights - Submission - Rollout Halt Command Arguments
643+
644+
| Argument | Description |
645+
| ----------- | --------------- |
646+
| `productId` | The product ID. |
647+
| `flightId` | The flight ID. |
648+
649+
#### Flights - Submission - Rollout Halt Command Options
650+
651+
| Option | Description |
652+
| ------------------ | ------------------ |
653+
| -s, --submissionId | The submission ID. |
654+
655+
#### Flights - Submission - Rollout Halt Command Help
656+
657+
```console
658+
msstore flights submission rollout halt --help
659+
```
660+
661+
### Flights - Submission - Rollout Finalize Command Usage
662+
663+
```console
664+
msstore flights submission rollout finalize <productId> <flightId>
665+
```
666+
667+
#### Flights - Submission - Rollout Finalize Command Arguments
668+
669+
| Argument | Description |
670+
| ----------- | --------------- |
671+
| `productId` | The product ID. |
672+
| `flightId` | The flight ID. |
673+
674+
#### Flights - Submission - Rollout Finalize Command Options
675+
676+
| Option | Description |
677+
| ------------------ | ------------------ |
678+
| -s, --submissionId | The submission ID. |
679+
680+
#### Flights - Submission - Rollout Finalize Command Help
681+
682+
```console
683+
msstore flights submission rollout finalize --help
684+
```
685+
352686
## Init Command
353687

354688
The `init` command helps you setup your application to publish to the Microsoft Store. It currently supports the following application types:

hub/apps/publish/msstore-dev-cli/flights-command.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)