@pnp/cli-microsoft365 7.0.0-beta.99e75a7 → 7.0.0-beta.aa2d71e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/.eslintrc.cjs +0 -2
  2. package/dist/GlobalOptions.js +1 -7
  3. package/dist/cli/Cli.js +19 -2
  4. package/dist/m365/aad/commands/app/app-add.js +8 -8
  5. package/dist/m365/aad/commands/app/app-role-add.js +5 -5
  6. package/dist/m365/aad/commands/app/app-set.js +5 -5
  7. package/dist/m365/aad/commands/policy/policy-list.js +5 -5
  8. package/dist/m365/cli/commands/cli-issue.js +5 -5
  9. package/dist/m365/cli/commands/config/config-get.js +5 -5
  10. package/dist/m365/cli/commands/config/config-reset.js +5 -5
  11. package/dist/m365/cli/commands/config/config-set.js +5 -5
  12. package/dist/m365/commands/login.js +5 -5
  13. package/dist/m365/commands/request.js +1 -1
  14. package/dist/m365/flow/commands/owner/owner-ensure.js +5 -5
  15. package/dist/m365/pa/commands/app/app-owner-set.js +5 -5
  16. package/dist/m365/pa/commands/app/app-permission-ensure.js +5 -5
  17. package/dist/m365/pa/commands.js +1 -4
  18. package/dist/m365/planner/commands/task/task-add.js +17 -11
  19. package/dist/m365/planner/commands/task/task-get.js +35 -25
  20. package/dist/m365/planner/commands/task/task-list.js +26 -19
  21. package/dist/m365/planner/commands/task/task-remove.js +39 -34
  22. package/dist/m365/planner/commands/task/task-set.js +35 -23
  23. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +14 -14
  24. package/dist/m365/spfx/commands/package/package-generate.js +15 -15
  25. package/dist/m365/spfx/commands/project/DeployWorkflow.js +55 -0
  26. package/dist/m365/spfx/commands/project/project-doctor/{doctor-1.18.0-beta.1.js → doctor-1.18.0-beta.5.js} +1 -1
  27. package/dist/m365/spfx/commands/project/project-doctor.js +9 -9
  28. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +157 -0
  29. package/dist/m365/spfx/commands/project/project-github-workflow-model.js +2 -0
  30. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +1 -1
  31. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.18.0-beta.1.js → upgrade-1.18.0-beta.5.js} +26 -26
  32. package/dist/m365/spfx/commands/project/project-upgrade.js +14 -14
  33. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  34. package/dist/m365/spfx/commands.js +1 -0
  35. package/dist/m365/spo/commands/app/SpoAppBaseCommand.js +27 -26
  36. package/dist/m365/spo/commands/app/app-add.js +9 -9
  37. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +5 -5
  38. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-list.js +5 -5
  39. package/dist/m365/spo/commands/commandset/commandset-add.js +11 -11
  40. package/dist/m365/spo/commands/commandset/commandset-get.js +8 -8
  41. package/dist/m365/spo/commands/commandset/commandset-list.js +5 -5
  42. package/dist/m365/spo/commands/commandset/commandset-remove.js +5 -5
  43. package/dist/m365/spo/commands/commandset/commandset-set.js +11 -11
  44. package/dist/m365/spo/commands/file/file-move.js +73 -97
  45. package/dist/m365/spo/commands/file/file-sharinglink-add.js +8 -8
  46. package/dist/m365/spo/commands/file/file-sharinglink-list.js +5 -5
  47. package/dist/m365/spo/commands/folder/folder-copy.js +89 -45
  48. package/dist/m365/spo/commands/folder/folder-move.js +89 -47
  49. package/dist/m365/spo/commands/list/list-add.js +4 -4
  50. package/dist/m365/spo/commands/list/list-set.js +4 -4
  51. package/dist/m365/spo/commands/orgassetslibrary/orgassetslibrary-add.js +34 -5
  52. package/dist/m365/spo/commands/page/clientsidepages.js +1 -81
  53. package/dist/m365/spo/commands/propertybag/propertybag-base.js +63 -59
  54. package/dist/m365/spo/commands/propertybag/propertybag-remove.js +28 -31
  55. package/dist/m365/spo/commands/serviceprincipal/serviceprincipal-set.js +30 -32
  56. package/dist/m365/spo/commands/site/FlowsPolicy.js +7 -0
  57. package/dist/m365/spo/commands/site/site-add.js +114 -161
  58. package/dist/m365/spo/commands/site/site-apppermission-add.js +15 -18
  59. package/dist/m365/spo/commands/site/site-apppermission-remove.js +34 -38
  60. package/dist/m365/spo/commands/site/site-apppermission-set.js +11 -14
  61. package/dist/m365/spo/commands/site/site-ensure.js +14 -67
  62. package/dist/m365/spo/commands/site/site-hubsite-disconnect.js +22 -22
  63. package/dist/m365/spo/commands/site/site-list.js +27 -43
  64. package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +6 -6
  65. package/dist/m365/spo/commands/site/site-remove.js +166 -210
  66. package/dist/m365/spo/commands/site/site-set.js +177 -198
  67. package/dist/m365/spo/commands/tenant/tenant-commandset-add.js +8 -8
  68. package/dist/m365/spo/commands/tenant/tenant-commandset-set.js +8 -8
  69. package/dist/m365/spo/commands/tenant/tenant-settings-set.js +4 -4
  70. package/dist/m365/spo/commands/theme/theme-remove.js +24 -24
  71. package/dist/m365/spo/commands/theme/theme-set.js +0 -1
  72. package/dist/m365/spo/commands/user/user-remove.js +27 -27
  73. package/dist/m365/spo/commands/web/web-reindex.js +35 -42
  74. package/dist/m365/spo/commands/web/web-remove.js +21 -21
  75. package/dist/m365/spo/commands/web/web-roleassignment-add.js +16 -31
  76. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +33 -44
  77. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +18 -18
  78. package/dist/m365/spo/commands/web/web-roleinheritance-reset.js +19 -19
  79. package/dist/m365/spo/commands/web/web-set.js +5 -5
  80. package/dist/m365/teams/commands/app/app-list.js +5 -5
  81. package/dist/m365/teams/commands/chat/chat-member-add.js +5 -5
  82. package/dist/m365/teams/commands/funsettings/funsettings-set.js +4 -4
  83. package/dist/m365/teams/commands/guestsettings/guestsettings-set.js +4 -4
  84. package/dist/m365/teams/commands/membersettings/membersettings-set.js +4 -4
  85. package/dist/m365/teams/commands/messagingsettings/messagingsettings-set.js +5 -5
  86. package/dist/m365/teams/commands/team/team-set.js +3 -3
  87. package/dist/m365/todo/commands/task/task-add.js +6 -6
  88. package/dist/m365/yammer/commands/message/message-like-set.js +27 -28
  89. package/dist/m365/yammer/commands/message/message-list.js +67 -86
  90. package/dist/m365/yammer/commands/message/message-remove.js +18 -18
  91. package/dist/m365/yammer/commands/yammer-search.js +58 -74
  92. package/dist/utils/aadGroup.js +18 -0
  93. package/dist/utils/fsUtil.js +5 -0
  94. package/dist/utils/spo.js +594 -53
  95. package/dist/utils/validation.js +0 -3
  96. package/docs/docs/cmd/planner/task/task-add.mdx +22 -7
  97. package/docs/docs/cmd/planner/task/task-get.mdx +13 -4
  98. package/docs/docs/cmd/planner/task/task-list.mdx +22 -7
  99. package/docs/docs/cmd/planner/task/task-remove.mdx +25 -8
  100. package/docs/docs/cmd/planner/task/task-set.mdx +22 -7
  101. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +94 -0
  102. package/docs/docs/cmd/spo/file/file-move.mdx +36 -18
  103. package/docs/docs/cmd/spo/folder/folder-copy.mdx +39 -12
  104. package/docs/docs/cmd/spo/folder/folder-move.mdx +40 -13
  105. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.mdx +14 -1
  106. package/docs/docs/cmd/spo/site/site-ensure.mdx +1 -1
  107. package/docs/docs/cmd/spo/site/site-list.mdx +3 -78
  108. package/npm-shrinkwrap.json +240 -1417
  109. package/package.json +6 -7
  110. package/dist/m365/pa/cds-project-mutator.js +0 -91
  111. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/dataset-template/generated/ManifestTypes.d.ts +0 -11
  112. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/dataset-template/template_ControlManifest.Input.xml +0 -31
  113. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/dataset-template/template_index.ts +0 -51
  114. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/field-template/generated/ManifestTypes.d.ts +0 -12
  115. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/field-template/template_ControlManifest.Input.xml +0 -37
  116. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/field-template/template_index.ts +0 -48
  117. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/index.ts +0 -0
  118. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/virtual-dataset-template/template_ControlManifest.Input.xml +0 -31
  119. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/virtual-dataset-template/template_index.tsx +0 -58
  120. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/virtual-field-template/template_ControlManifest.Input.xml +0 -37
  121. package/dist/m365/pa/commands/pcf/pcf-init/assets/control/virtual-field-template/template_index.tsx +0 -55
  122. package/dist/m365/pa/commands/pcf/pcf-init/assets/package.json +0 -19
  123. package/dist/m365/pa/commands/pcf/pcf-init/assets/pcfconfig.json +0 -3
  124. package/dist/m365/pa/commands/pcf/pcf-init/assets/template_.gitignore +0 -14
  125. package/dist/m365/pa/commands/pcf/pcf-init/assets/template_pcfprojecttype.pcfproj +0 -45
  126. package/dist/m365/pa/commands/pcf/pcf-init/pcf-init-variables.js +0 -2
  127. package/dist/m365/pa/commands/pcf/pcf-init.js +0 -120
  128. package/dist/m365/pa/commands/solution/solution-init/assets/Other/Customizations.xml +0 -18
  129. package/dist/m365/pa/commands/solution/solution-init/assets/Other/Relationships.xml +0 -2
  130. package/dist/m365/pa/commands/solution/solution-init/assets/Other/template_Solution.xml +0 -94
  131. package/dist/m365/pa/commands/solution/solution-init/assets/template_.gitignore +0 -2
  132. package/dist/m365/pa/commands/solution/solution-init/assets/template_solutionprojecttype.cdsproj +0 -44
  133. package/dist/m365/pa/commands/solution/solution-init/solution-init-variables.js +0 -2
  134. package/dist/m365/pa/commands/solution/solution-init.js +0 -126
  135. package/dist/m365/pa/commands/solution/solution-reference-add.js +0 -88
  136. package/dist/m365/pa/template-instantiator.js +0 -57
  137. package/docs/docs/cmd/pa/pcf/pcf-init.mdx +0 -56
  138. package/docs/docs/cmd/pa/solution/solution-init.mdx +0 -46
  139. package/docs/docs/cmd/pa/solution/solution-reference-add.mdx +0 -42
@@ -244,9 +244,6 @@ export const validation = {
244
244
  ];
245
245
  return !!input && !input.split('.').every(value => !~javascriptReservedWords.indexOf(value));
246
246
  },
247
- isValidFileName(input) {
248
- return !!input && !/^((\..*)|COM\d|CLOCK\$|LPT\d|AUX|NUL|CON|PRN|(.*[\u{d800}-\u{dfff}]+.*))$/iu.test(input) && !/^(.*\.\..*)$/i.test(input);
249
- },
250
247
  isValidTheme(input) {
251
248
  const validThemeProperties = [
252
249
  "themePrimary",
@@ -19,10 +19,13 @@ m365 planner task add [options]
19
19
  : Title of the task to add.
20
20
 
21
21
  `--planId [planId]`
22
- : ID of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
22
+ : ID of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
23
23
 
24
24
  `--planTitle [planTitle]`
25
- : Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
25
+ : Title of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
26
+
27
+ `--rosterId [rosterId]`
28
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
26
29
 
27
30
  `--ownerGroupId [ownerGroupId]`
28
31
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -89,38 +92,50 @@ When you specify an integer value for `priority`, consider the following:
89
92
 
90
93
  When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
91
94
 
95
+ :::caution
96
+
97
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
98
+
99
+ :::
100
+
92
101
  ## Examples
93
102
 
94
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
103
+ Adds a Microsoft Planner task with the name for plan with the specified ID and specified bucket with the ID.
95
104
 
96
105
  ```sh
97
106
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
98
107
  ```
99
108
 
100
- Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
109
+ Adds a Completed Microsoft Planner task with the name for plan with the specified title owned by specified group and the specified bucket with the ID.
101
110
 
102
111
  ```sh
103
112
  m365 planner task add --title "My Planner task" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
104
113
  ```
105
114
 
106
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to several users and receive a due date for _2021-12-16_
115
+ Adds a Microsoft Planner task with the specified name for the plan with the specified ID and bucket with the ID. The new task will be assigned to the specified users and receive a specified due date.
107
116
 
108
117
  ```sh
109
118
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
110
119
  ```
111
120
 
112
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to several users who will appear first with the asssignee priority _' !'_
121
+ Adds a Microsoft Planner task with the specified name for the plan with the specified ID and bucket with the ID. The new task will be assigned to the specified users who will appear first with the asssignee priority _' !'_
113
122
 
114
123
  ```sh
115
124
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --asssigneePriority ' !'
116
125
  ```
117
126
 
118
- Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will receive the categories _category1,category3_ and get a preview with the type _noPreview_
127
+ Adds a Microsoft Planner task with the specified name for the plan with the specified ID and the bucket with the ID. The new task will receive the specified categories and get a specified preview with the type.
119
128
 
120
129
  ```sh
121
130
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --appliedCategories "category1,category3" --previewType "noPreview"
122
131
  ```
123
132
 
133
+ Adds a Microsoft Planner task with the specified name for the plan with the specified rosterId and bucket with the ID.
134
+
135
+ ```sh
136
+ m365 planner task add --title "My Planner Task" --rosterId "DjL5xiKO10qut8LQgztpKskABWna" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
137
+ ```
138
+
124
139
  ## Response
125
140
 
126
141
  ### Standard response
@@ -28,10 +28,13 @@ m365 planner task get [options]
28
28
  : Name of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
29
29
 
30
30
  `--planId [planId]`
31
- : ID of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
31
+ : ID of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
32
32
 
33
33
  `--planTitle [planTitle]`
34
- : Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
34
+ : Title of the plan to which the task belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
+
36
+ `--rosterId [rosterId]`
37
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
38
 
36
39
  `--ownerGroupId [ownerGroupId]`
37
40
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -44,18 +47,24 @@ m365 planner task get [options]
44
47
 
45
48
  ## Examples
46
49
 
47
- Retrieve the specified planner task by id
50
+ Returns the Microsoft Planner task by id.
48
51
 
49
52
  ```sh
50
53
  m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"
51
54
  ```
52
55
 
53
- Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_.
56
+ Retrieve the Microsoft Planner task by title from the specified bucket. Based on the specified plan with the title owned by the specified group.
54
57
 
55
58
  ```sh
56
59
  m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
57
60
  ```
58
61
 
62
+ Returns the Microsoft Planner task by rosterId from the specified bucket.
63
+
64
+ ```sh
65
+ m365 planner task get --title "New Task" --bucketName "To do" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
66
+ ```
67
+
59
68
  ## Response
60
69
 
61
70
  <Tabs>
@@ -22,10 +22,13 @@ m365 planner task list [options]
22
22
  : Name of the bucket to list the tasks of. To retrieve tasks from a bucket, specify `bucketId` or `bucketName`, but not both.
23
23
 
24
24
  `--planId [planId]`
25
- : ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
25
+ : ID of a plan to list the tasks of. To retrieve all tasks from a plan, Specify either `planId`, `planTitle`, or `rosterId` but not multiple. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
26
26
 
27
27
  `--planTitle [planTitle]`
28
- : Title of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
28
+ : Title of a plan to list the tasks of. To retrieve all tasks from a plan, Specify either `planId`, `planTitle`, or `rosterId` but not multiple. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
29
+
30
+ `--rosterId [rosterId]`
31
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` but not multiple.
29
32
 
30
33
  `--ownerGroupId [ownerGroupId]`
31
34
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -44,6 +47,12 @@ This command uses API that is currently in preview to enrich the results with th
44
47
 
45
48
  :::
46
49
 
50
+ :::caution
51
+
52
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
53
+
54
+ :::
55
+
47
56
  ## Examples
48
57
 
49
58
  List tasks for the currently logged in user
@@ -52,36 +61,42 @@ List tasks for the currently logged in user
52
61
  m365 planner task list
53
62
  ```
54
63
 
55
- List the Microsoft Planner tasks in the plan _iVPMIgdku0uFlou-KLNg6MkAE1O2_
64
+ List the Microsoft Planner tasks in the plan by id.
56
65
 
57
66
  ```sh
58
67
  m365 planner task list --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"`
59
68
  ```
60
69
 
61
- List the Microsoft Planner tasks in the plan _My Plan_ in group _My Group_
70
+ List the Microsoft Planner tasks in the specified plan by title from the specified group by name.
62
71
 
63
72
  ```sh
64
73
  m365 planner task list --planTitle "My Plan" --ownerGroupName "My Group"
65
74
  ```
66
75
 
67
- List the Microsoft Planner tasks in the bucket _FtzysDykv0-9s9toWiZhdskAD67z_
76
+ List the Microsoft Planner tasks in the bucket by id.
68
77
 
69
78
  ```sh
70
79
  m365 planner task list --bucketId "FtzysDykv0-9s9toWiZhdskAD67z"
71
80
  ```
72
81
 
73
- List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _iVPMIgdku0uFlou-KLNg6MkAE1O2_
82
+ List the Microsoft Planner tasks in the bucket by name belonging to plan by id.
74
83
 
75
84
  ```sh
76
85
  m365 planner task list --bucketName "My Bucket" --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"
77
86
  ```
78
87
 
79
- List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My Plan_ in group _My Group_
88
+ List the Microsoft Planner tasks in the bucket by name belonging to plan by title in the specified group.
80
89
 
81
90
  ```sh
82
91
  m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
83
92
  ```
84
93
 
94
+ List the Microsoft Planner tasks by rosterId from the specified bucket.
95
+
96
+ ```sh
97
+ m365 planner task list --bucketName "My Bucket" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
98
+ ```
99
+
85
100
  ## Response
86
101
 
87
102
  <Tabs>
@@ -26,10 +26,13 @@ m365 planner task remove [options]
26
26
  : Name of the bucket to which the task to remove belongs. Specify either `bucketId` or `bucketName` but not both.
27
27
 
28
28
  `--planId [planId]`
29
- : ID of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
29
+ : ID of the plan to which the task to remove belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `title`.
30
30
 
31
31
  `--planTitle [planTitle]`
32
- : Title of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
32
+ : Title of the plan to which the task to remove belongs. Specify either `planId`, `planTitle`, or `rosterId` when using `title`.
33
+
34
+ `--rosterId [rosterId]`
35
+ : ID of the Planner Roster. Specify either `planId`, `planTitle`, or `rosterId` when using `title`.
33
36
 
34
37
  `--ownerGroupId [ownerGroupId]`
35
38
  : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -43,44 +46,58 @@ m365 planner task remove [options]
43
46
 
44
47
  <Global />
45
48
 
49
+ ## Remarks
50
+
51
+ :::caution
52
+
53
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
54
+
55
+ :::
56
+
46
57
  ## Examples
47
58
 
48
- Removes the Microsoft Planner task by ID
59
+ Removes the Microsoft Planner task by ID.
49
60
 
50
61
  ```sh
51
62
  m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
52
63
  ```
53
64
 
54
- Removes the Microsoft Planner task by ID without confirmation
65
+ Removes the Microsoft Planner task by ID without confirmation.
55
66
 
56
67
  ```sh
57
68
  m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --force
58
69
  ```
59
70
 
60
- Removes the Microsoft Planner task with title _My Task_ in the bucket with ID _vncYUXCRBke28qMLB-d4xJcACtNz_
71
+ Removes the Microsoft Planner task with the specified title in the bucket by ID.
61
72
 
62
73
  ```sh
63
74
  m365 planner task remove --title "My Task" --bucketId "vncYUXCRBke28qMLB-d4xJcACtNz"
64
75
  ```
65
76
 
66
- Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
77
+ Removes the Microsoft Planner task with the specified title the bucket by name in the Plan with the specified ID.
67
78
 
68
79
  ```sh
69
80
  m365 planner task remove --title "My Task" --bucketName "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
70
81
  ```
71
82
 
72
- Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
83
+ Removes the Microsoft Planner task with the specified title in the bucket with name in the Plan owned by group with the specified name.
73
84
 
74
85
  ```sh
75
86
  m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
76
87
  ```
77
88
 
78
- Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
89
+ Removes the Microsoft Planner task with the specified title in the bucket with name in the Plan owned by group with the specified ID.
79
90
 
80
91
  ```sh
81
92
  m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupId "00000000-0000-0000-0000-000000000000"
82
93
  ```
83
94
 
95
+ Removes the Microsoft Planner task by rosterId from the specified bucket.
96
+
97
+ ```sh
98
+ m365 planner task remove --title "My Task" --bucketName "My Bucket" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
99
+ ```
100
+
84
101
  ## Response
85
102
 
86
103
  The command won't return a response on success.
@@ -28,10 +28,13 @@ m365 planner task set [options]
28
28
  : Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` when using `title`.
29
29
 
30
30
  `--planId [planId]`
31
- : ID of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
31
+ : ID of the plan to which the bucket belongs to. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
32
32
 
33
33
  `--planTitle [planTitle]`
34
- : Title of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
34
+ : Title of the plan to which the bucket belongs to. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
+
36
+ `--rosterId [rosterId]`
37
+ : ID of the Planner Roster to which the bucket belongs to. Specify either `planId`, `planTitle`, or `rosterId` when using `bucketName`.
35
38
 
36
39
  `--ownerGroupId [ownerGroupId]`
37
40
  : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
@@ -91,24 +94,36 @@ You can add up to 6 categories to the task. An example to add _category1_ and _c
91
94
 
92
95
  When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
93
96
 
97
+ :::caution
98
+
99
+ When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
100
+
101
+ :::
102
+
94
103
  ## Examples
95
104
 
96
- Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
105
+ Updates a Microsoft Planner task name of the specified task by ID
97
106
 
98
107
  ```sh
99
108
  m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
100
109
  ```
101
110
 
102
- Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_
111
+ Moves a Microsoft Planner task with the specified ID to the bucket by name. Based on the plan with the specified rosterId.
112
+
113
+ ```sh
114
+ m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --bucketName "My Planner Bucket" --rosterId "DjL5xiKO10qut8LQgztpKskABWna"
115
+ ```
116
+
117
+ Moves a Microsoft Planner task with the specified ID to the bucket by name. Based on the plan with the specified title owned by the specified group by name.
103
118
 
104
119
  ```sh
105
- m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
120
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
106
121
  ```
107
122
 
108
- Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
123
+ Marks a Microsoft Planner task with the specified ID as 50% complete and assigned to categories 1 and 3.
109
124
 
110
125
  ```sh
111
- m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
126
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
112
127
  ```
113
128
 
114
129
  ## Response
@@ -0,0 +1,94 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # spfx project github workflow add
4
+
5
+ Adds a GitHub workflow for a SharePoint Framework project
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 spfx project github workflow add [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-n, --name [name]`
17
+ : Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'
18
+
19
+ `-b, --branchName [branchName]`
20
+ : Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'
21
+
22
+ `-m, --manuallyTrigger`
23
+ : When specified a manual trigger option will be added to the workflow: `workflow_dispatch`
24
+
25
+ `-l, --loginMethod [loginMethod]`
26
+ : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`'
27
+
28
+ `-s, --scope [scope]`
29
+ : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`
30
+
31
+ `-u, --siteUrl [siteUrl]`
32
+ : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`
33
+
34
+ `--skipFeatureDeployment`
35
+ : When specified and the app supports tenant-wide deployment, deploy it to the whole tenant
36
+
37
+ `--overwrite`
38
+ : When specified the workflow will overwrite the existing .sppkg if it is already deployed in the app catalog.
39
+ ```
40
+
41
+ <Global />
42
+
43
+ ## Remarks
44
+
45
+ The `spfx project github workflow add` will create a workflow .yml file in the `.github/workflows` directory in your project. If such directory does not exist the command will automatically create it.
46
+
47
+ For the `application` login method the command does not register AAD application nor create the required certificate. In order for you to proceed you will need to first obtain (create) a self-signed certificate and register a new AAD application with certificate authentication. After that in GitHub repo settings, you will need to create the following secrets:
48
+
49
+ - `APP_ID` - client id of the registered AAD application
50
+ - `CERTIFICATE_ENCODED` - application's encoded certificate
51
+ - `CERTIFICATE_PASSWORD` - certificate password. This applies only if the certificate is encoded which is the recommended approach
52
+
53
+ This use case is perfect in a production context as it does not create any dependencies on an account
54
+
55
+ For the `user` login method you will need to create the following secrets in GitHub repo settings:
56
+
57
+ - `ADMIN_USERNAME` - username
58
+ - `ADMIN_PASSWORD` - password
59
+
60
+ This method is perfect to test your workflow, in a dev context, for personal usage. It will not work for accounts with MFA.
61
+
62
+ :::info
63
+
64
+ Run this command in the SPFx solution folder.
65
+
66
+ :::
67
+
68
+ ## Examples
69
+
70
+ Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main
71
+
72
+ ```sh
73
+ m365 spfx project github workflow add
74
+ ```
75
+
76
+ Adds a GitHub workflow for a SharePoint Framework project with `user` login method triggered on push to main and when manually triggered.
77
+
78
+ ```sh
79
+ m365 spfx project github workflow add --manuallyTrigger --loginMethod "user"
80
+ ```
81
+
82
+ Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog
83
+
84
+ ```sh
85
+ m365 spfx project github workflow add --scope "sitecollection" --siteUrl "https://some.sharepoint.com/sites/someSite"
86
+ ```
87
+
88
+ ## Response
89
+
90
+ The command won't return a response on success.
91
+
92
+ ## More information
93
+
94
+ - Automate your CI/CD workflow using CLI for Microsoft 365 GitHub Actions: [https://pnp.github.io/cli-microsoft365/user-guide/github-actions](https://pnp.github.io/cli-microsoft365/user-guide/github-actions)
@@ -14,53 +14,71 @@ m365 spo file move [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : The URL of the site where the file is located
17
+ : The URL of the site where the file is located.
18
18
 
19
- `-s, --sourceUrl <sourceUrl>`
20
- : The server- or site-relative decoded URL of the file to move
19
+ `-s, --sourceUrl [sourceUrl]`
20
+ : The server-, site-relative or absolute decoded URL of the file to move. Specify either `sourceUrl` or `sourceId` but not both.
21
+
22
+ `-i, --sourceId [sourceId]`
23
+ : The ID of the file to move. Specify either `sourceUrl` or `sourceId` but not both.
21
24
 
22
25
  `-t, --targetUrl <targetUrl>`
23
- : Server-relative decoded URL where to move the file
26
+ : Server-relative or absolute decoded URL where to move the file.
27
+
28
+ `--newName [newName]`
29
+ : The new name of the destination file.
24
30
 
25
- `--deleteIfAlreadyExists`
26
- : If a file already exists at the targetUrl, it will be moved to the recycle bin. If omitted, the move operation will be canceled if the file already exists at the targetUrl location
31
+ `--nameConflictBehavior [nameConflictBehavior]`
32
+ : Behavior when a file or folder with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. The default is `fail`.
27
33
 
28
- `--allowSchemaMismatch`
29
- : Ignores any missing fields in the target document library and moves the file anyway
34
+ `--retainEditorAndModified`
35
+ : Use this option to retain the editor and modified date. When not specified, these values are reset when moving to another library.
36
+
37
+ `--bypassSharedLock`
38
+ : This indicates whether a file with a share lock can still be moved. Use this option to move a file that is locked.
30
39
  ```
31
40
 
32
41
  <Global />
33
42
 
34
43
  ## Remarks
35
44
 
36
- When you move a file using the `spo file move` command, all of the versions are being moved.
45
+ All file versions are retained while moving a file.
46
+
47
+ When you specify a value for `nameConflictBehavior`, consider the following:
48
+
49
+ - `fail` will throw an error when the destination file already exists.
50
+ - `replace` will replace the destination file if it already exists.
51
+ - `rename` will add a suffix (e.g. Document1.pdf) when the destination file already exists.
37
52
 
38
53
  ## Examples
39
54
 
40
- Move file to a document library in another site collection
55
+ Move a file to a document library in another site collection by server relative URL
41
56
 
42
57
  ```sh
43
- m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /sites/test1/Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/
58
+ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/sites/project-x/Shared Documents/sp1.pdf" --targetUrl "/sites/project-y/Archived documents"
44
59
  ```
45
60
 
46
- Move file to a document library in the same site collection
61
+ Move a file specified by a server-relative URL to a document library and rename it
47
62
 
48
63
  ```sh
49
- m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test1/HRDocuments/
64
+ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/Shared Documents/sp1.pdf" --targetUrl "/sites/project-x/My Documents" --newName Report.pdf
50
65
  ```
51
66
 
52
- Move file to a document library in another site collection. If a file with the same name already exists in the target document library, move it to the recycle bin
67
+ Move a file to another document library and replace a file with the same name
53
68
 
54
69
  ```sh
55
- m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/ --deleteIfAlreadyExists
70
+ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/Shared Documents/Report project-x.pdf" --targetUrl "/sites/project-x/My Documents" --newName Report.pdf --nameConflictBehavior replace
56
71
  ```
57
72
 
58
- Move file to a document library in another site collection. Allow for schema mismatch
73
+ Move a file referenced by its ID to another document library and retain editor and modified date
59
74
 
60
- ```sh
61
- m365 spo file move --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /sites/test1/Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/ --allowSchemaMismatch
75
+ ```sh
76
+ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/My Documents" --retainEditorAndModified
62
77
  ```
63
78
 
79
+ ## Response
80
+
81
+ The command won't return a response on success.
64
82
 
65
83
  ## More information
66
84
 
@@ -14,16 +14,28 @@ m365 spo folder copy [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : The URL of the site where the folder is located
17
+ : The URL of the site where the folder is located.
18
18
 
19
- `-s, --sourceUrl <sourceUrl>`
20
- : The server- or site-relative URL of the folder to copy
19
+ `-s, --sourceUrl [sourceUrl]`
20
+ : The server-, site-relative or absolute decoded URL of the folder to copy. Specify either `sourceUrl` or `sourceId` but not both.
21
+
22
+ `-i, --sourceId [sourceId]`
23
+ : The UniqueId (GUID) of the folder. Specify either `sourceUrl` or `sourceId` but not both.
21
24
 
22
25
  `-t, --targetUrl <targetUrl>`
23
- : Server-relative URL where to copy the folder
26
+ : Server-relative or absolute decoded URL where to copy the folder.
27
+
28
+ `--newName [newName]`
29
+ : New name of the destination folder.
30
+
31
+ `--nameConflictBehavior [nameConflictBehavior]`
32
+ : Behavior when a file or folder with the same name is already present at the destination. Possible values: `fail`, `rename`. The default is `fail`.
24
33
 
25
- `--allowSchemaMismatch`
26
- : Ignores any missing fields in the target document library and copies the folder anyway
34
+ `--resetAuthorAndCreated`
35
+ : Use this option to clear the author and created date. When not specified, the values from the source folder are used.
36
+
37
+ `--bypassSharedLock`
38
+ : This indicates whether a folder with a shared lock can still be moved. Use this option to copy a folder that is locked.
27
39
  ```
28
40
 
29
41
  <Global />
@@ -32,26 +44,41 @@ m365 spo folder copy [options]
32
44
 
33
45
  When you copy a folder with documents that have version history, only the latest document version is copied.
34
46
 
47
+ When you specify a value for `nameConflictBehavior`, consider the following:
48
+
49
+ - `fail` will throw an error when the destination folder already exists.
50
+ - `rename` will add a suffix (e.g. Folder1) when the destination folder already exists.
51
+
35
52
  ## Examples
36
53
 
37
- Copies folder from a document library located in one site collection to another site collection
54
+ Copy a folder a folder to another location using server-relative URLs
38
55
 
39
56
  ```sh
40
- m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/MyFolder --targetUrl /sites/test2/Shared%20Documents/
57
+ m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/sites/project-x/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents/Project files"
41
58
  ```
42
59
 
43
- Copies folder from a document library to another site in the same site collection
60
+ Copy a folder a folder to another location using site-relative URLs and rename it
44
61
 
45
62
  ```sh
46
- m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/MyFolder --targetUrl /sites/test1/HRDocuments/
63
+ m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents" --newName "Reports January"
47
64
  ```
48
65
 
49
- Copies folder to a document library in another site collection. Allow for schema mismatch
66
+ Copy a folder to another location and use new name on conflict
50
67
 
51
68
  ```sh
52
- m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/MyFolder --targetUrl /sites/test2/Shared%20Documents/ --allowSchemaMismatch
69
+ m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/sites/project-x/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents/Project files" --nameConflictBehavior rename
53
70
  ```
54
71
 
72
+ Copy a folder referenced by its ID to another document library and reset author and created date
73
+
74
+ ```sh
75
+ m365 spo folder copy --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/Project files" --retainEditorAndModified
76
+ ```
77
+
78
+ ## Response
79
+
80
+ The command won't return a response on success.
81
+
55
82
  ## More information
56
83
 
57
84
  - Copy items from a SharePoint document library: [https://support.office.com/en-us/article/move-or-copy-items-from-a-sharepoint-document-library-00e2f483-4df3-46be-a861-1f5f0c1a87bc](https://support.office.com/en-us/article/move-or-copy-items-from-a-sharepoint-document-library-00e2f483-4df3-46be-a861-1f5f0c1a87bc)