@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.1cd2525

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

@@ -0,0 +1,261 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner plan set
+
+Updates a Microsoft Planner plan
+
+## Usage
+
+```sh
+m365 planner plan set [options]
+```
+
+## Options
+
+```md definition-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 to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
+
+`--newTitle [newTitle]`
+: New title of the plan.
+
+`--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
+
+This command allows using unknown options. 
+
+```md definition-list
+`--category1 [category1]`
+: New label for a category. Define the category key within your option to update the related label. Category 1 to 25 are available. E.g., `--category4`, `--category12`.
+```
+
+:::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
+
+Updates a Microsoft Planner plan title to New Title
+
+```sh
+m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --newTitle 'New Title'
+```
+
+Share a Microsoft Planner plan owned by the group, with the users
+
+```sh
+m365 planner plan set --title 'Plan Title' --ownerGroupName 'My Group' --shareWithUserNames 'user1@contoso.com,user2@contoso.com'
+```
+
+Updates a Microsoft Planner plan category labels
+
+```sh
+m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --category25 'Urgent'
+```
+
+## 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>
+
+## More information
+
+- Update plannerPlan: [https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http)
+- plannerPlanDetails resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0)
+- plannerCategoryDescriptions resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0)

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

@@ -0,0 +1,96 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner roster add
+
+Creates a new Microsoft Planner Roster
+
+## Usage
+
+```sh
+m365 planner roster add [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::caution
+
+The Roster will be automatically deleted when it doesn't contain a plan 24 hours after its creation. Membership information will be completely erased within 30 days of this deletion.
+
+:::
+
+:::caution
+
+This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+:::info
+
+To be able to create a new Roster, the Planner Roster creation tenant setting should be enabled. Use the [planner tenant settings list](../tenant/tenant-settings-list.mdx) command to check if this setting is enabled for your tenant.
+
+:::
+
+## Examples
+
+Creates a new Microsoft Planner Roster
+
+```sh
+m365 planner roster add
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "e6fmvM_yi0OJgvmepE5uj5cAE6qX",
+    "assignedSensitivityLabel": null
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  assignedSensitivityLabel: null
+  id                      : e6fmvM_yi0OJgvmepE5uj5cAE6qX
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,assignedSensitivityLabel
+  e6fmvM_yi0OJgvmepE5uj5cAE6qX,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner roster add
+
+  Date: 7/2/2023
+
+  ## e6fmvM_yi0OJgvmepE5uj5cAE6qX
+
+  Property | Value
+  ---------|-------
+  id | e6fmvM_yi0OJgvmepE5uj5cAE6qX
+  assignedSensitivityLabel | null
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.

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

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner roster get
+
+Gets information about the specific Microsoft Planner Roster.
+
+## Usage
+
+```sh
+m365 planner roster get [options]
+```
+
+## Options
+
+```md definition-list
+`--id <id>`
+: ID of the Planner Roster.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+## Examples
+
+Gets information about a specific Planner Roster.
+
+```sh
+m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "tYqYlNd6eECmsNhN_fcq85cAGAnd",
+    "assignedSensitivityLabel": null
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  assignedSensitivityLabel: null
+  id                      : tYqYlNd6eECmsNhN_fcq85cAGAnd
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,assignedSensitivityLabel
+  tYqYlNd6eECmsNhN_fcq85cAGAnd,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner roster get --id "tYqYlNd6eECmsNhN_fcq85cAGAnd"
+
+  Date: 1/30/2023
+
+  ## undefined (tYqYlNd6eECmsNhN_fcq85cAGAnd)
+
+  Property | Value
+  ---------|-------
+  id | tYqYlNd6eECmsNhN_fcq85cAGAnd
+  assignedSensitivityLabel | null
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.

package/docs/docs/cmd/planner/roster/roster-member-add.mdx

@@ -0,0 +1,104 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner roster member add
+
+Adds a user to a Microsoft Planner Roster
+
+## Usage
+
+```sh
+m365 planner roster member add [options]
+```
+
+## Options
+
+```md definition-list
+`--rosterId <rosterId>`
+: ID of the Planner Roster.
+
+`--userId [userId]`
+: User's Azure AD ID. Specify either `userId`, `userName` but not both.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId`, `userName` but not both.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+## Examples
+
+Adds a specific user by user name as member of the Planner Roster
+
+```sh
+m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
+```
+
+Adds a specific user by ID as member of the Planner Roster
+
+```sh
+m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
+    "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
+    "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
+    "roles": []
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id      : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+  roles   : []
+  tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
+  userId  : 2056d2f6-3257-4253-8cfc-b73393e414e5
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,userId,tenantId,roles
+  b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner roster member add --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
+
+  Date: 6/2/2023
+
+  ## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+
+  Property | Value
+  ---------|-------
+  id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+  userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
+  tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
+  roles | []
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/planner/roster/roster-member-get.mdx

@@ -0,0 +1,104 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# planner roster member get
+
+Gets a member of the specified Microsoft Planner Roster
+
+## Usage
+
+```sh
+m365 planner roster member get [options]
+```
+
+## Options
+
+```md definition-list
+`--rosterId <rosterId>`
+: ID of the Planner Roster.
+
+`--userId [userId]`
+: User's Azure AD ID. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId` or `userName` but not both.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+## Examples
+
+Gets a specific user by user name as member of the Planner Roster
+
+```sh
+m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
+```
+
+Gets a specific user by ID as member of the Planner Roster
+
+```sh
+m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
+    "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
+    "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
+    "roles": []
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id      : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+  roles   : []
+  tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
+  userId  : 2056d2f6-3257-4253-8cfc-b73393e414e5
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,userId,tenantId,roles
+  b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # planner roster member get --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
+
+  Date: 18/2/2023
+
+  ## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+
+  Property | Value
+  ---------|-------
+  id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+  userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
+  tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
+  roles | []
+  ```
+
+  </TabItem>
+</Tabs>
+