@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.bb31388

package/docs/docs/cmd/planner/plan/plan-add.mdx

@@ -0,0 +1,247 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner plan add
+
+Adds a new Microsoft Planner plan
+
+## Usage
+
+```sh
+m365 planner plan add [options]
+```
+
+## Options
+
+```md defintion-list
+`-t, --title <title>`
+: Title of the plan to add.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
+
+`--rosterId [rosterId]`
+: ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
+
+`--shareWithUserIds [shareWithUserIds]`
+: The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+
+`--shareWithUserNames [shareWithUserNames]`
+: The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+```
+
+<Global />
+
+## Remarks
+
+- Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
+
+- Hint: Unlike for groups, a Planner Roster can contain only 1 plan.
+
+## Examples
+
+Adds a Microsoft Planner plan with a Group by id
+
+```sh
+m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
+```
+
+Adds a Microsoft Planner plan with with a Group by name
+
+```sh
+m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
+```
+
+Adds a Microsoft Planner plan with a Roster by id
+
+```sh
+m365 planner plan add --title 'My Planner Plan' --rosterId 'tYqYlNd6eECmsNhN_fcq85cAGAnd'
+```
+
+Adds a Microsoft Planner plan with with a Group by name and share it with the given users
+
+```sh
+m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
+```
+
+## Response
+
+### Standard response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+    "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+    "title": "My Planner Plan",
+    "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+    "createdBy": {
+      "user": {
+        "displayName": null,
+        "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+      },
+      "application": {
+        "displayName": null,
+        "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+      }
+    },
+    "container": {
+      "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "type": "group",
+      "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdDateTime: 2015-03-30T18:36:49.2407981Z
+  id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+  owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+  title          : My Planner Plan
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,title,createdDateTime,owner
+  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
+
+  Date: 30/03/2015
+
+  ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
+
+  Property | Value
+  ---------|-------
+  createdDateTime | 2015-03-30T18:36:49.2407981Z
+  owner | ebf3b108-5234-4e22-b93d-656d7dae5874
+  title | My Planner Plan
+  id | xqQg5FS2LkCp935s-FIFm2QAFkHM
+  createdBy | {"user":{"displayName":null,"id":"95e27074-6c4a-447a-aa24-9d718a0b86fa"},"application":{"displayName":null,"id":"ebf3b108-5234-4e22-b93d-656d7dae5874"}}
+  container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
+  ```
+
+  </TabItem>
+</Tabs>
+
+### `shareWithUserIds`, `shareWithUserNames` response
+
+When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ. 
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+    "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+    "title": "My Planner Plan",
+    "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+    "createdBy": {
+      "user": {
+        "displayName": null,
+        "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+      },
+      "application": {
+        "displayName": null,
+        "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+      }
+    },
+    "container": {
+      "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "type": "group",
+      "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+    },
+    "sharedWith": {
+      "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
+      "6463a5ce-2119-4198-9f2a-628761df4a62": true
+    },
+    "categoryDescriptions": {
+      "category1": null,
+      "category2": null,
+      "category3": null,
+      "category4": null,
+      "category5": null,
+      "category6": null,
+      "category7": null,
+      "category8": null,
+      "category9": null,
+      "category10": null,
+      "category11": null,
+      "category12": null,
+      "category13": null,
+      "category14": null,
+      "category15": null,
+      "category16": null,
+      "category17": null,
+      "category18": null,
+      "category19": null,
+      "category20": null,
+      "category21": null,
+      "category22": null,
+      "category23": null,
+      "category24": null,
+      "category25": null
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdDateTime: 2015-03-30T18:36:49.2407981Z
+  id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+  owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+  title          : My Planner Plan
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,title,createdDateTime,owner
+  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874" --shareWithUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com"
+
+  Date: 30/03/2015
+
+  ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
+
+  Property | Value
+  ---------|-------
+  createdDateTime | 2015-03-30T18:36:49.2407981Z
+  owner | ebf3b108-5234-4e22-b93d-656d7dae5874
+  title | My Planner Plan
+  id | xqQg5FS2LkCp935s-FIFm2QAFkHM
+  createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
+  container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
+  sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
+  categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/planner/plan/plan-get.mdx

@@ -0,0 +1,172 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner plan get
+
+Retrieve information about the specified plan
+
+## Usage
+
+```sh
+m365 planner plan get [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id [id]`
+: ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
+
+`-t, --title [title]`
+: Title of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
+
+`--rosterId [rosterId]`
+: ID of the Planner Roster. Specify either `id`, `title` or `rosterId` but not multiple.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+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.
+
+:::
+
+## Examples
+
+Returns the Microsoft Planner plan by id
+
+```sh
+m365 planner plan get --id "gndWOTSK60GfPQfiDDj43JgACDCb"
+```
+
+Returns the Microsoft Planner plan by title and owner group id 
+
+```sh
+m365 planner plan get --title "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
+```
+
+Returns the Microsoft Planner plan by title and owner group name
+
+```sh
+m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
+```
+
+Returns the Microsoft Planner plan by roster id
+
+```sh
+m365 planner plan get --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+    "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+    "title": "My Planner Plan",
+    "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+    "createdBy": {
+      "user": {
+        "displayName": null,
+        "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+      },
+      "application": {
+        "displayName": null,
+        "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+      }
+    },
+    "container": {
+      "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "type": "group",
+      "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+    },
+    "sharedWith": {
+      "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
+      "6463a5ce-2119-4198-9f2a-628761df4a62": true
+    },
+    "categoryDescriptions": {
+      "category1": null,
+      "category2": null,
+      "category3": null,
+      "category4": null,
+      "category5": null,
+      "category6": null,
+      "category7": null,
+      "category8": null,
+      "category9": null,
+      "category10": null,
+      "category11": null,
+      "category12": null,
+      "category13": null,
+      "category14": null,
+      "category15": null,
+      "category16": null,
+      "category17": null,
+      "category18": null,
+      "category19": null,
+      "category20": null,
+      "category21": null,
+      "category22": null,
+      "category23": null,
+      "category24": null,
+      "category25": null
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdDateTime: 2015-03-30T18:36:49.2407981Z
+  id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+  owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+  title          : My Planner Plan
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,title,createdDateTime,owner
+  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner plan get --id "xqQg5FS2LkCp935s-FIFm2QAFkHM"
+
+  Date: 27/12/2022
+
+  ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
+
+  Property | Value
+  ---------|-------
+  createdDateTime | 2015-03-30T18:36:49.2407981Z
+  owner | ebf3b108-5234-4e22-b93d-656d7dae5874
+  title | My Planner Plan
+  id | xqQg5FS2LkCp935s-FIFm2QAFkHM
+  createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
+  container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
+  sharedWith | {"aa089c1a-0ca8-4b36-ae2e-c5d60f054a2c":true,"ebf3b108-5234-4e22-b93d-656d7dae5874":true}
+  categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/planner/plan/plan-list.mdx

@@ -0,0 +1,128 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner plan list
+
+Returns a list of plans associated with a specified group
+
+## Usage
+
+```sh
+m365 planner plan list [options]
+```
+
+## Options
+
+```md defintion-list
+`--ownerGroupId [ownerGroupId]`
+: ID of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
+
+`--rosterId [rosterId]`
+: ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+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.
+
+:::
+
+## Examples
+
+Returns a list of Microsoft Planner plans for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
+
+```sh
+m365 planner plan list --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
+```
+
+Returns a list of Microsoft Planner plans for Group _My Planner Group_
+
+```sh
+m365 planner plan list --ownerGroupName "My Planner Group"
+```
+
+Returns a list of Microsoft Planner plans for Roster _FeMZFDoK8k2oWmuGE-XFHZcAEwtn_
+
+```sh
+m365 planner plan list --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                            title            createdDateTime               owner
+  ----------------------------  ---------------  ----------------------------  ------------------------------------
+  xqQg5FS2LkCp935s-FIFm2QAFkHM  My Planner Plan  2015-03-30T18:36:49.2407981Z  ebf3b108-5234-4e22-b93d-656d7dae5874
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,title,createdDateTime,owner
+  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner plan list --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
+
+  Date: 27/12/2022
+
+  ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
+
+  Property | Value
+  ---------|-------
+  createdDateTime | 2021-12-12T14:00:50.4522129Z
+  owner | ebf3b108-5234-4e22-b93d-656d7dae5874
+  title | My Planner Plan
+  id | xqQg5FS2LkCp935s-FIFm2QAFkHM
+  createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"}}
+  container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/planner/plan/plan-remove.mdx

@@ -0,0 +1,60 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# planner plan remove
+
+Removes the Microsoft Planner plan
+
+## Usage
+
+```sh
+m365 planner plan remove [options]
+```
+
+## Options
+
+```md defintion-list
+`i, --id [id]`
+: ID of the plan to remove. Specify either `id` or `title` but not both.
+
+`-t, --title [title]`
+: Title of the plan to remove. Specify either `id` or `title` but not both.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+If you wish to delete a Planner plan contained within a Planner Roster, you'll have to remove the roster using [planner roster remove](../roster/roster-remove.mdx).
+
+## Examples
+
+Removes the Microsoft Planner plan by ID
+
+```sh
+m365 planner plan remove --id gndWOTSK60GfPQfiDDj43JgACDCb
+```
+
+Removes the Microsoft Planner plan with title _My Plan_ in group with specific ID
+
+```sh
+m365 planner plan remove --title "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000
+```
+
+Removes the Microsoft Planner plan with title _My Plan_ in group with name _My Planner Group_ without confirmation prompt
+
+```sh
+m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
+```
+
+## Response
+
+The command won't return a response on success.