@pnp/cli-microsoft365 6.3.0-beta.37c6261 → 6.3.0-beta.456e93a

package/docs/docs/cmd/logout.md

@@ -29,3 +29,7 @@ Log out from Microsoft 365 in debug mode including detailed debug information in
 ```sh
 m365 logout --debug
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pa/environment/environment-get.md

@@ -10,8 +10,8 @@ m365 pa environment get [options]
 
 ## Options
 
-`-n, --name <name>`
-: The name of the environment to get information about
+`-n, --name [name]`
+: The name of the environment. When not specified, the default environment is retrieved.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -24,6 +24,12 @@ If the environment with the name you specified doesn't exist, you will get the `
 
 ## Examples
 
+Get information about the default Power Apps environment
+
+```sh
+m365 pa environment get
+```
+
 Get information about the Power Apps environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
 
 ```sh

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

@@ -11,19 +11,19 @@ m365 planner plan get [options]
 ## Options
 
 `-i, --id [id]`
-: ID of the plan. Specify either `id` or `title` but not both.
+: ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
 
 `-t, --title [title]`
-: Title of the plan. Specify either `id` or `title` but not both.
+: 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`, `ownerGroupName` or `rosterId` when using `title`.
+: 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`, `ownerGroupName` or `rosterId` when using `title`.
-
-`--rosterId [rosterId]`
-: ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId` when using `title`.
+: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -34,28 +34,28 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 ## Examples
 
-Returns the Microsoft Planner plan with id _gndWOTSK60GfPQfiDDj43JgACDCb_
+Returns the Microsoft Planner plan by id
 
 ```sh
 m365 planner plan get --id "gndWOTSK60GfPQfiDDj43JgACDCb"
 ```
 
-Returns the Microsoft Planner plan with title _MyPlan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
+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 with title _MyPlan_ for Group _My Planner Group_
+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 with title _MyPlan_ for Roster _FeMZFDoK8k2oWmuGE-XFHZcAEwtn_
+Returns the Microsoft Planner plan by roster id
 
 ```sh
-m365 planner plan get --title "MyPlan" --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
+m365 planner plan get --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
 ```
 
 ## Response

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

@@ -11,16 +11,19 @@ m365 planner plan set [options]
 ## Options
 
 `-i, --id [id]`
-: ID of the plan. Specify either `id` or `title` but not both.
+: ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
 
 `-t, --title [title]`
-: Title of the plan. Specify either `id` or `title` but not both.
+: 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`.
+: 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`.
+: 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.
@@ -40,6 +43,9 @@ This command allows using unknown options.
 `--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`.
 
+!!! attention
+    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

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

@@ -0,0 +1,73 @@
+# planner roster get
+
+Gets information about the specific Microsoft Planner Roster.
+
+## Usage
+
+```sh
+m365 planner roster get [options]
+```
+
+## Options
+
+`--id <id>`
+: ID of the Planner Roster.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    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
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "tYqYlNd6eECmsNhN_fcq85cAGAnd",
+      "assignedSensitivityLabel": null
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    assignedSensitivityLabel: null
+    id                      : tYqYlNd6eECmsNhN_fcq85cAGAnd
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,assignedSensitivityLabel
+    tYqYlNd6eECmsNhN_fcq85cAGAnd,
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner roster get --id "tYqYlNd6eECmsNhN_fcq85cAGAnd"
+
+    Date: 1/30/2023
+
+    ## undefined (tYqYlNd6eECmsNhN_fcq85cAGAnd)
+
+    Property | Value
+    ---------|-------
+    id | tYqYlNd6eECmsNhN_fcq85cAGAnd
+    assignedSensitivityLabel | null
+    ```
+
+## Additional 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-remove.md

@@ -0,0 +1,51 @@
+# planner roster member remove
+
+Removes a member from a Microsoft Planner Roster
+
+## Usage
+
+```sh
+m365 planner roster member remove [options]
+```
+
+## Options
+
+`--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.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+!!! attention
+    The Planner Roster will be deleted when it doesn't have any users remaining in the membership list because the last user removed themselves. Roster, its plan and all contained tasks will be deleted within 30 days of this operation. We will show an extra prompt when this happens. This prompt is also suppressed when specifying `--confirm`.
+
+## Examples
+
+Remove a Roster member by its Azure AD ID
+
+```sh
+m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId 126878e5-d8f9-4db2-951d-d25486488d38
+```
+
+Remove a Roster member by its UPN
+
+```sh
+m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md

@@ -0,0 +1,132 @@
+# purview retentionevent get
+
+Get a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a retention event by id
+
+```sh
+m365 purview retentionevent get --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
+
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+        "displayName": "Contract xyz expired",
+        "description": "The retention period for documents related to Contract xyz started because the contract expired.",
+        "eventTriggerDateTime": "2023-02-01T09:16:37Z",
+        "lastStatusUpdateDateTime": "2023-02-01T09:21:15Z",
+        "createdDateTime": "2023-02-01T09:17:40Z",
+        "lastModifiedDateTime": "2023-02-01T09:17:40Z",
+        "id": "c37d695e-d581-4ae9-82a0-9364eba4291e",
+        "eventQueries": [
+            {
+                "queryType": "files",
+                "query": "1234"
+            },
+            {
+                "queryType": "messages",
+                "query": "Terminate"
+            }
+        ],
+        "eventStatus": {
+            "error": null,
+            "status": "success"
+        },
+        "eventPropagationResults": [
+            {
+                "serviceName": "SharePoint",
+                "location": null,
+                "status": "none",
+                "statusInformation": null
+            }
+        ],
+        "createdBy": {
+            "user": {
+                "id": null,
+                "displayName": "John Doe"
+            }
+        },
+        "lastModifiedBy": {
+            "user": {
+                "id": null,
+                "displayName": "John Doe"
+            }
+        }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdBy               : {"user":{"id":null,"displayName":"John Doe"}}
+    createdDateTime         : 2023-02-01T09:17:40Z
+    description             : The retention period for documents related to Contract xyz started because the contract expired.
+    displayName             : Contract xyz expired    
+    eventTriggerDateTime    : 2023-02-01T09:16:37Z
+    id                      : c37d695e-d581-4ae9-82a0-9364eba4291e
+    lastModifiedBy          : {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedDateTime    : 2023-02-01T09:17:40Z
+    lastStatusUpdateDateTime: 2023-02-01T09:21:15Z    
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,description,eventTriggerDateTime,lastStatusUpdateDateTime,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+    Contract xyz expired,The retention period for documents related to Contract xyz started because the contract expired.,2023-02-01T09:16:37Z,2023-02-01T09:21:15Z,2023-02-01T09:17:40Z,2023-02-01T09:17:40Z,c37d695e-d581-4ae9-82a0-9364eba4291e,{"user":{"id":null,"displayName":"John Doe"}},{"user":{"id":null,"displayName":"John Doe"}}
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentionevent get --id "c37d695e-d581-4ae9-82a0-9364eba4291e"
+
+    Date: 2/1/2023
+
+    ## Contract xyz expired (c37d695e-d581-4ae9-82a0-9364eba4291e)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract xyz expired
+    description | The retention period for documents related to Contract xyz started because the contract expired.
+    eventTriggerDateTime | 2023-02-01T09:16:37Z
+    lastStatusUpdateDateTime: 2023-02-01T09:21:15Z
+    createdDateTime | 2023-02-01T09:17:40Z
+    lastModifiedDateTime | 2023-02-01T09:17:40Z
+    id | c37d695e-d581-4ae9-82a0-9364eba4291e
+    createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+    ```

package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md

@@ -0,0 +1,107 @@
+# purview retentionevent list
+
+Get a list of retention events
+
+## Usage
+
+```sh
+m365 purview retentionevent list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention events
+
+```sh
+m365 purview retentionevent list
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+## Response
+
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "displayName": "Contract xyz expired",
+        "description": null,
+        "eventTriggerDateTime": "2023-02-03T13:51:40Z",
+        "eventStatus": null,
+        "lastStatusUpdateDateTime": null,
+        "createdDateTime": "2023-02-03T13:51:40Z",
+        "lastModifiedDateTime": "2023-02-03T13:51:40Z",
+        "id": "7248cfa8-c03a-4ec1-49a4-08db05edc686",
+        "eventQueries": [],
+        "eventPropagationResults": [],
+        "createdBy": {
+          "user": {
+            "id": null,
+            "displayName": "John Doe"
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": null,
+            "displayName": "John Doe"
+          }
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName            eventTriggerDateTime
+    ------------------------------------  ---------------------  --------------------
+    7248cfa8-c03a-4ec1-49a4-08db05edc686  Contract xyz expired  2023-02-03T13:51:40Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,isInUse
+    7248cfa8-c03a-4ec1-49a4-08db05edc686,Contract xyz expired,2023-02-03T13:51:40Z
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentionevent list
+
+    Date: 3/2/2023
+
+    ## Contract xyz expired (7248cfa8-c03a-4ec1-49a4-08db05edc686)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract xyz expired
+    description | null
+    eventTriggerDateTime | 2023-02-03T13:51:40Z
+    eventStatus | null
+    lastStatusUpdateDateTime | null
+    createdDateTime | 2023-02-03T13:51:40Z
+    lastModifiedDateTime | 2023-02-03T13:51:40Z
+    id | 7248cfa8-c03a-4ec1-49a4-08db05edc686
+    eventQueries | []
+    eventPropagationResults | []
+    createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+    ```

package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md

@@ -0,0 +1,45 @@
+# purview retentionevent remove
+
+Delete a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event.
+
+`--confirm`
+: Don't prompt for confirmation to remove the retention event.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention event by id
+
+```sh
+m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+[Read more on event-based retention here](https://learn.microsoft.com/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md

@@ -0,0 +1,106 @@
+# purview retentioneventtype add
+
+Create a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype add [options]
+```
+
+## Options
+
+`-n, --displayName <displayName>`
+: The display name of the event type.
+
+`-d, --description [description]`
+: A description for the event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Create a retention event type *Contract Expiry*.
+
+```sh
+m365 purview retentioneventtype add --displayName 'Contract Expiry' --description 'A retention event type to start a retention period based on the date that a contract expired.'
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      {
+        "displayName": "Contract Expiry",
+        "description": "A retention event type to start a retention period based on the date that a contract expired.",
+        "createdDateTime": "2023-01-31T20:33:33Z",
+        "lastModifiedDateTime": "2023-01-31T20:33:33Z",
+        "id": "f15d2493-7ad2-4185-a3f6-9580542490a0",
+        "createdBy": {
+          "user": {
+            "id": null,
+            "displayName": "Mathijs Verbeeck"
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": null,
+            "displayName": "Mathijs Verbeeck"
+          }
+        }
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdBy           : {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    createdDateTime     : 2023-01-31T20:40:40Z
+    description         : A retention event type to start a retention period based on the date that a contract expired.
+    displayName         : Contract Expiry
+    id                  : 806cb481-4cc6-47c3-af26-26d64f6e7aab
+    lastModifiedBy      : {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    lastModifiedDateTime: 2023-01-31T20:40:40Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+    Contract Expiry,A retention event type to start a retention period based on the date that a contract expired.,2023-01-31T20:53:23Z,2023-01-31T20:53:23Z,b430ae4c-1e26-422f-9544-67df3abfb200,"{""user"":{""id"":null,""displayName"":""Mathijs Verbeeck""}}","{""user"":{""id"":null,""displayName"":""Mathijs Verbeeck""}}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentioneventtype add --displayName "Contract Expiry" --description "A retention event type to start a retention period based on the date that a contract expired."
+
+    Date: 31/01/2023
+
+    ## Contract Expiry (ca0e1f8d-4e42-4a81-be85-022502d70c4e)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract Expiry
+    description | A retention event type to start a retention period based on the date that a contract expired.
+    createdDateTime | 2023-01-31T20:55:35Z
+    lastModifiedDateTime | 2023-01-31T20:55:35Z
+    id | ca0e1f8d-4e42-4a81-be85-022502d70c4e
+    createdBy | {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    ```

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md

@@ -28,6 +28,9 @@ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
 !!! attention
     This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 
+!!! attention
+    This command currently only supports delegated permissions.
+
 ## More information
 
 This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.