Skip to content

Commit e03d441

Browse files
GrantMeStrengthGrantMeStrength
authored
Merge pull request #6149 from MicrosoftDocs/update-flights-commands
Update flights commands
2 parents fd7bc87 + 0b7b3b5 commit e03d441

2 files changed

Lines changed: 321 additions & 0 deletions

File tree

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

Lines changed: 320 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,326 @@ msstore publish "C:\path\to\pwa_app"
553553
| -f, --flightId | Specifies the Flight Id where the package will be published. |
554554
| -prp, --packageRolloutPercentage | Specifies the rollout percentage of the package. The value must be between 0 and 100. |
555555

556+
## Flights Command
557+
558+
| Sub-Command | Description |
559+
|-----------------------------------------------------------------------------------------------------------|----------------------|
560+
| [list](#flights---list---usage) | Retrieves all the Flights for the specified Application. |
561+
| [get](#flights---get---usage) | Retrieves a flight for the specified Application and flight. |
562+
| [delete](#flights---delete---usage) | Deletes a flight for the specified Application and flight. |
563+
| [create](#flights---create---usage) | Creates a flight for the specified Application and flight. |
564+
| [submission](#flights---submission) | Execute flight submissions related tasks. |
565+
566+
#### Flights - List - Usage
567+
568+
```console
569+
msstore flights list <productId>
570+
```
571+
572+
#### Arguments
573+
574+
| Argument | Description |
575+
|-------------|-------------|
576+
| `productId` | The product ID. |
577+
578+
#### Options
579+
580+
| Option | Description |
581+
| --------------------- | -------------------------------- |
582+
| -v, --verbose | Print verbose output. |
583+
| -?, -h, --help | Show help and usage information. |
584+
585+
#### Flights - Get - Usage
586+
587+
```console
588+
msstore flights get <productId> <flightId>
589+
```
590+
591+
#### Arguments
592+
593+
| Argument | Description |
594+
|-------------|-------------|
595+
| `productId` | The product ID. |
596+
| `flightId` | The flight ID. |
597+
598+
#### Options
599+
600+
| Option | Description |
601+
| --------------------- | -------------------------------- |
602+
| -v, --verbose | Print verbose output. |
603+
| -?, -h, --help | Show help and usage information. |
604+
605+
#### Flights - Delete - Usage
606+
607+
```console
608+
msstore flights delete <productId> <flightId>
609+
```
610+
611+
#### Arguments
612+
613+
| Argument | Description |
614+
|-------------|-------------|
615+
| `productId` | The product ID. |
616+
| `flightId` | The flight ID. |
617+
618+
#### Options
619+
620+
| Option | Description |
621+
| --------------------- | -------------------------------- |
622+
| -v, --verbose | Print verbose output. |
623+
| -?, -h, --help | Show help and usage information. |
624+
625+
#### Flights - Create - Usage
626+
627+
```console
628+
msstore flights create <productId> <friendlyName> --group-ids <group-ids>
629+
```
630+
631+
#### Arguments
632+
633+
| Argument | Description |
634+
|-------------|-------------|
635+
| `productId` | The product ID. |
636+
| `friendlyName` | The friendly name of the flight. |
637+
638+
#### Options
639+
640+
| Option | Description |
641+
|--------|-------------|
642+
| -g, --group-ids | The group IDs to associate with the flight. |
643+
| -r, --rank-higher-than | The flight ID to rank higher than. |
644+
| -v, --verbose | Print verbose output. |
645+
| -?, -h, --help | Show help and usage information. |
646+
647+
### Flights - Submission
648+
649+
| Sub-Command | Description |
650+
|-----------------------------------------------------------------------------------------------------------|----------------------|
651+
| [get](#flights---submission---get---usage) | Retrieves the existing package flight submission, either the existing draft or the last published one. |
652+
| [delete](#flights---submission---delete---usage) | Deletes the pending package flight submission from the store. |
653+
| [update](#flights---submission---update---usage) | Updates the existing flight draft with the provided JSON. |
654+
| [publish](#flights---submission---publish---usage) | Starts the flight submission process for the existing Draft. |
655+
| [poll](#flights---submission---poll---usage) | Polls until the existing flight submission is PUBLISHED or FAILED. |
656+
| [status](#flights---submission---status---usage) | Retrieves the current status of the store flight submission. |
657+
| [rollout](#flights---submission---rollout) | Execute flight rollout related operations. |
658+
659+
#### Flights - Submission - Get - Usage
660+
661+
```console
662+
msstore flights submission get <productId> <flightId>
663+
```
664+
665+
#### Arguments
666+
667+
| Argument | Description |
668+
|-------------|-------------|
669+
| `productId` | The product ID. |
670+
| `flightId` | The flight ID. |
671+
672+
#### Options
673+
674+
| Option | Description |
675+
| --------------------- | -------------------------------- |
676+
| -v, --verbose | Print verbose output. |
677+
| -?, -h, --help | Show help and usage information. |
678+
679+
#### Flights - Submission - Delete - Usage
680+
681+
```console
682+
msstore flights submission delete <productId> <flightId>
683+
```
684+
685+
#### Arguments
686+
687+
| Argument | Description |
688+
|-------------|-------------|
689+
| `productId` | The product ID. |
690+
| `flightId` | The flight ID. |
691+
692+
#### Options
693+
694+
| Option | Description |
695+
| --------------------- | -------------------------------- |
696+
| --no-confirm | Do not prompt for confirmation. |
697+
| -v, --verbose | Print verbose output. |
698+
| -?, -h, --help | Show help and usage information. |
699+
700+
#### Flights - Submission - Update - Usage
701+
702+
```console
703+
msstore flights submission update <productId> <flightId> <product>
704+
```
705+
706+
#### Arguments
707+
708+
| Argument | Description |
709+
|-------------|-------------|
710+
| `productId` | The product ID. |
711+
| `flightId` | The flight ID. |
712+
| `product` | The updated JSON product representation. |
713+
714+
#### Options
715+
716+
| Option | Description |
717+
|--------|-------------|
718+
| -s, --skipInitialPolling | Skip the initial polling before executing the action. [default: False] |
719+
| -v, --verbose | Print verbose output. |
720+
| -?, -h, --help | Show help and usage information. |
721+
722+
#### Flights - Submission - Publish - Usage
723+
724+
```console
725+
msstore flights publish <productId> <flightId>
726+
```
727+
728+
#### Arguments
729+
730+
| Argument | Description |
731+
|-------------|-------------|
732+
| `productId` | The product ID. |
733+
| `flightId` | The flight ID. |
734+
735+
#### Options
736+
737+
| Option | Description |
738+
| --------------------- | -------------------------------- |
739+
| -v, --verbose | Print verbose output. |
740+
| -?, -h, --help | Show help and usage information. |
741+
742+
#### Flights - Submission - Poll - Usage
743+
744+
```console
745+
msstore flights poll <productId> <flightId>
746+
```
747+
748+
#### Arguments
749+
750+
| Argument | Description |
751+
|-------------|-------------|
752+
| `productId` | The product ID. |
753+
| `flightId` | The flight ID. |
754+
755+
#### Options
756+
757+
| Option | Description |
758+
| --------------------- | -------------------------------- |
759+
| -v, --verbose | Print verbose output. |
760+
| -?, -h, --help | Show help and usage information. |
761+
762+
#### Flights - Submission - Status - Usage
763+
764+
```console
765+
msstore flights status <productId> <flightId>
766+
```
767+
768+
#### Arguments
769+
770+
| Argument | Description |
771+
|-------------|-------------|
772+
| `productId` | The product ID. |
773+
| `flightId` | The flight ID. |
774+
775+
#### Options
776+
777+
| Option | Description |
778+
| --------------------- | -------------------------------- |
779+
| -v, --verbose | Print verbose output. |
780+
| -?, -h, --help | Show help and usage information. |
781+
782+
### Flights - Submission - Rollout
783+
784+
| Sub-Command | Description |
785+
|-----------------------------------------------------------------------------------------------------------|----------------------|
786+
| [get](#flights---submission---rollout---get---usage) | Retrieves the flight rollout status of a submission. |
787+
| [update](#flights---submission---rollout---update---usage) | Update the flight rollout percentage of a submission. |
788+
| [halt](#flights---submission---rollout---halt---usage) | Halts the flight rollout of a submission. |
789+
| [finalize](#flights---submission---rollout---finalize---usage) | Finalizes the flight rollout of a submission. |
790+
791+
#### Flights - Submission - Rollout - Get - Usage
792+
793+
```console
794+
msstore flights submission rollout get <productId> <flightId>
795+
```
796+
797+
#### Arguments
798+
799+
| Argument | Description |
800+
|-------------|-------------|
801+
| `productId` | The product ID. |
802+
| `flightId` | The flight ID. |
803+
804+
#### Options
805+
806+
| Option | Description |
807+
|--------|-------------|
808+
| -s, --submissionId | The submission ID. |
809+
| -v, --verbose | Print verbose output. |
810+
| -?, -h, --help | Show help and usage information. |
811+
812+
#### Flights - Submission - Rollout - Update - Usage
813+
814+
```console
815+
msstore flights submission rollout update <productId> <flightId> <percentage>
816+
```
817+
818+
#### Arguments
819+
820+
| Argument | Description |
821+
|-------------|-------------|
822+
| `productId` | The product ID. |
823+
| `flightId` | The flight ID. |
824+
| `percentage` | The percentage of users that will receive the submission rollout. |
825+
826+
#### Options
827+
828+
| Option | Description |
829+
|--------|-------------|
830+
| -s, --submissionId | The submission ID. |
831+
| -v, --verbose | Print verbose output. |
832+
| -?, -h, --help | Show help and usage information. |
833+
834+
#### Flights - Submission - Rollout - Halt - Usage
835+
836+
```console
837+
msstore flights submission rollout halt <productId> <flightId>
838+
```
839+
840+
#### Arguments
841+
842+
| Argument | Description |
843+
|-------------|-------------|
844+
| `productId` | The product ID. |
845+
| `flightId` | The flight ID. |
846+
847+
#### Options
848+
849+
| Option | Description |
850+
|--------|-------------|
851+
| -s, --submissionId | The submission ID. |
852+
| -v, --verbose | Print verbose output. |
853+
| -?, -h, --help | Show help and usage information. |
854+
855+
#### Flights - Submission - Rollout - Finalize - Usage
856+
857+
```console
858+
msstore flights submission rollout finalize <productId> <flightId>
859+
```
860+
861+
#### Arguments
862+
863+
| Argument | Description |
864+
|-------------|-------------|
865+
| `productId` | The product ID. |
866+
| `flightId` | The flight ID. |
867+
868+
#### Options
869+
870+
| Option | Description |
871+
|--------|-------------|
872+
| -s, --submissionId | The submission ID. |
873+
| -v, --verbose | Print verbose output. |
874+
| -?, -h, --help | Show help and usage information. |
875+
556876
## CI/CD Environments
557877

558878
The Microsoft Store Developer CLI (preview) supports running in CI/CD environments. This means that you can use the Microsoft Store Developer CLI (preview) in your CI/CD pipelines to, for example, automatically publish your applications to the Microsoft Store.

‎hub/apps/publish/msstore-dev-cli/overview.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,6 @@ These are the Microsoft Store Developer CLI available commands:
6060
| [init](./commands.md#init-command) | Helps you setup your application to publish to the Microsoft Store. |
6161
| [package](./commands.md#package-command) | Helps you package your Microsoft Store Application as an MSIX. |
6262
| [publish](./commands.md#publish-command) | Publishes your application to the Microsoft Store. |
63+
| [flights](./commands.md#flights-command) | Flights related commands, such as 'list', 'get', 'delete', 'create', 'submission'. |
6364

6465
For more info, see: [Commands](commands.md).

0 commit comments

Comments
 (0)