Skip to content

Commit d4f5057

Browse files
committed
Fixed MSStore CLI Flights commands
1 parent 7a9254d commit d4f5057

19 files changed

Lines changed: 335 additions & 510 deletions

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

Lines changed: 334 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,340 @@ Deletes the pending submission from the store.
385385
msstore submission delete --help
386386
```
387387

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

390724
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.

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

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

0 commit comments

Comments
 (0)