@pnp/cli-microsoft365 6.3.0-beta.4c3b2c9 → 6.3.0-beta.655c566

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 does not support app only 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/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-list.md

@@ -0,0 +1,97 @@
+# purview retentioneventtype list
+
+Get a list of retention event types
+
+## Usage
+
+```sh
+m365 purview retentioneventtype list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention event types
+
+```sh
+m365 purview retentioneventtype 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 does not support app only 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 Expiry",
+        "description": "",
+        "createdDateTime": "2023-02-02T15:47:54Z",
+        "lastModifiedDateTime": "2023-02-02T15:47:54Z",
+        "id": "81fa91bd-66cd-4c6c-b0cb-71f37210dc74",
+        "createdBy": {
+          "user": {
+            "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
+            "displayName": null
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
+            "displayName": null
+          }
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName            createdDateTime
+    ------------------------------------  ---------------------  --------------------
+    81fa91bd-66cd-4c6c-b0cb-71f37210dc74  Contract Expiry  2023-02-02T15:47:54Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,createdDateTime
+    81fa91bd-66cd-4c6c-b0cb-71f37210dc74,Contract Expiry,2023-02-02T15:47:54Z
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentioneventtype list
+
+    Date: 8/2/2023
+
+    ## Contract Expiry (81fa91bd-66cd-4c6c-b0cb-71f37210dc74)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract Expiry
+    description | null
+    createdDateTime | 2023-02-02T15:47:54Z
+    lastModifiedDateTime | 2023-02-02T15:47:54Z
+    id | 81fa91bd-66cd-4c6c-b0cb-71f37210dc74
+    createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
+    lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
+    ```

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

@@ -0,0 +1,43 @@
+# purview retentioneventtype remove
+
+Delete a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event type.
+
+`--confirm`
+: Don't prompt for confirmation to remove the retention event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention event type by id
+
+```sh
+m365 purview retentioneventtype 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 about event-based retention here](https://learn.microsoft.com/en-us/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-set.md

@@ -0,0 +1,43 @@
+# purview retentioneventtype set
+
+Update a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype set [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The id of the retention event type.
+
+`-d, --description [description]`
+: The new description of the event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Update the description of a retention event type
+
+```sh
+m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
+```
+
+## 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
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/navigation/navigation-node-get.md

@@ -0,0 +1,91 @@
+# spo navigation node get
+
+Gets information about a specific navigation node.
+
+## Usage
+
+```sh
+m365 spo navigation node get [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site.
+
+`--id <id>`
+: Id of the navigation node.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve information for a specific navigation node.
+
+```sh
+m365 spo navigation node get --webUrl https://contoso.sharepoint.com/sites/team-a --id 2209
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "AudienceIds": [
+        "0d718612-8407-4d6b-833c-6891a553354f",
+        "f864446f-b4d7-475a-a2ba-1080c6474020"
+      ],
+      "CurrentLCID": 1033,
+      "Id": 2209,
+      "IsDocLib": true,
+      "IsExternal": false,
+      "IsVisible": true,
+      "ListTemplateType": 100,
+      "Title": "Work Status",
+      "Url": "/sites/team-a/Lists/Work Status/AllItems.aspx"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    AudienceIds     : ["0d718612-8407-4d6b-833c-6891a553354f", "f864446f-b4d7-475a-a2ba-1080c6474020"]
+    CurrentLCID     : 1033
+    Id              : 2209
+    IsDocLib        : true
+    IsExternal      : false
+    IsVisible       : true
+    ListTemplateType: 100
+    Title           : Work Status
+    Url             : /sites/team-a/Lists/Work Status/AllItems.aspx
+    ```
+
+=== "CSV"
+
+    ```csv
+    AudienceIds,CurrentLCID,Id,IsDocLib,IsExternal,IsVisible,ListTemplateType,Title,Url
+    [""0d718612-8407-4d6b-833c-6891a553354f"", ""f864446f-b4d7-475a-a2ba-1080c6474020""],1033,2209,1,,1,100,Work Status,/sites/team-a/Lists/Work Status/AllItems.aspx
+    ```
+
+=== "Markdown"
+
+    ```md
+    # spo navigation node get --webUrl "https://contoso.sharepoint.com/sites/team-a" --id "2209"
+
+    Date: 1/29/2023
+
+    ## Work Status (2209)
+
+    Property | Value
+    ---------|-------
+    AudienceIds | ["0d718612-8407-4d6b-833c-6891a553354f", "f864446f-b4d7-475a-a2ba-1080c6474020"]
+    CurrentLCID | 1033
+    Id | 2209
+    IsDocLib | true
+    IsExternal | false
+    IsVisible | true
+    ListTemplateType | 100
+    Title | Work Status
+    Url | /sites/team-a/Lists/Work Status/AllItems.aspx
+    ```

package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md

@@ -0,0 +1,59 @@
+# spo tenant applicationcustomizer add
+
+Add an application customizer as a tenant wide extension.
+
+## Usage
+
+```sh
+m365 spo tenant applicationcustomizer add [options]
+```
+
+## Options
+
+`-t, --title <title>`
+: The title of the Application Customizer.
+
+`-i, --clientSideComponentId <clientSideComponentId>`
+: The Client Side Component Id (GUID) of the application customizer.
+
+`-p, --clientSideComponentProperties [clientSideComponentProperties]`
+: The Client Side Component properties of the application customizer.
+
+`-w, --webTemplate [webTemplate]`
+: Optionally add a web template (e.g. STS#3, SITEPAGEPUBLISHING#0, etc) as a filter for what kind of sites the application customizer is registered on.
+
+--8<-- "docs/cmd/_global.md"
+
+!!! important
+    To use this command, you need to be a SharePoint Admin.
+
+## Remarks
+
+Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
+
+```sh
+m365 spo tenant applicationcustomizer add --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+!!! warning "Escaping JSON in PowerShell"
+    When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
+## Examples
+
+Adds an application customizer that's deployed tenant wide
+
+```sh
+m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId  799883f5-7962-4384-a10a-105adaec6ffc 
+```
+
+Adds an application customizer that is configured for all communication sites.
+
+```sh
+m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId  799883f5-7962-4384-a10a-105adaec6ffc --webTemplate "SITEPAGEPUBLISHING#0"
+```
+
+## Response
+
+The command won't return a response on success.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.3.0-beta.4c3b2c9",
+  "version": "6.3.0-beta.655c566",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",