@pnp/cli-microsoft365 6.3.0-beta.c3dc921 → 6.3.0-beta.cefe20e

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

@@ -0,0 +1,103 @@
+# purview retentioneventtype get
+
+Get a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a retention event type by id
+
+```sh
+m365 purview retentioneventtype 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": "Test retention event type",
+      "description": "Description for the retention event type",
+      "createdDateTime": "2023-01-29T09:30:42Z",
+      "lastModifiedDateTime": "2023-01-29T09:30:42Z",
+      "id": "c37d695e-d581-4ae9-82a0-9364eba4291e",
+      "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-01-29T09:30:42Z
+    description         : Description for the retention event type
+    displayName         : Test retention event type
+    id                  : c37d695e-d581-4ae9-82a0-9364eba4291e
+    lastModifiedBy      : {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedDateTime: 2023-01-29T09:30:42Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+    Test retention event type,Description for the retention event type,2023-01-29T09:30:42Z,2023-01-29T09:30:42Z,c37d695e-d581-4ae9-82a0-9364eba4291e,"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentioneventtype get --id "c37d695e-d581-4ae9-82a0-9364eba4291e"
+
+    Date: 1/29/2023
+
+    ## Test retention event type (c37d695e-d581-4ae9-82a0-9364eba4291e)
+
+    Property | Value
+    ---------|-------
+    displayName | Test retention event type
+    description | Description for the retention event type
+    createdDateTime | 2023-01-29T09:30:42Z
+    lastModifiedDateTime | 2023-01-29T09:30:42Z
+    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/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 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 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/purview/retentionlabel/retentionlabel-add.md

@@ -58,6 +58,9 @@ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringReten
 !!! 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
 
 - Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)

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

@@ -28,6 +28,9 @@ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
 !!! 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.
+
 ## Response
 
 

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

@@ -25,6 +25,9 @@ m365 purview retentionlabel list
 !!! 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.
+
 ## Response
 
 

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

@@ -31,6 +31,9 @@ m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
 !!! 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.
+
 ## Response
 
 The command won't return a response on success.

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md

@@ -58,6 +58,9 @@ m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --beha
 !!! 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.
+
 ## Response
 
 The command won't return a response on success.

package/docs/docs/cmd/request.md

@@ -74,3 +74,77 @@ Call the Microsoft Graph to get a profile photo.
 ```sh
 m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
 ```
+
+## Response
+
+The responses below are an example based on the `url` option with the value 'https://graph.microsoft.com/v1.0/me'. The output may differ based on the `url` options
+
+=== "JSON"
+
+    ```json
+    {
+      "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
+      "businessPhones": [
+        "123456789"
+      ],
+      "displayName": "John Doe",
+      "givenName": "John",
+      "jobTitle": null,
+      "mail": "john.doe@contoso.onmicrosoft.com",
+      "mobilePhone": null,
+      "officeLocation": null,
+      "preferredLanguage": "en-US",
+      "surname": "Doe",
+      "userPrincipalName": "john.doe@contoso.onmicrosoft.com",
+      "id": "1df1fffa-62b8-44a9-9c7c-49853f5b4ac6"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    @odata.context   : https://graph.microsoft.com/v1.0/$metadata#users/$entity
+    businessPhones   : ["123456789"]
+    displayName      : John Doe
+    givenName        : John
+    id               : 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
+    jobTitle         : null
+    mail             : john.doe@contoso.onmicrosoft.com
+    mobilePhone      : null
+    officeLocation   : null
+    preferredLanguage: en-US
+    surname          : Doe
+    userPrincipalName: john.doe@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    @odata.context,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
+    https://graph.microsoft.com/v1.0/$metadata#users/$entity,"[""123456789""]",John Doe,John,,john.doe@contoso.onmicrosoft.com,,,en-US,Doe,john.doe@contoso.onmicrosoft.com,1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
+    ```
+
+=== "Markdown"
+
+    ```md
+    # request --url "https://graph.microsoft.com/v1.0/me" --method "get"
+
+    Date: 7/2/2023
+
+    ## John Doe (1df1fffa-62b8-44a9-9c7c-49853f5b4ac6)
+
+    Property | Value
+    ---------|-------
+    @odata.context | https://graph.microsoft.com/v1.0/$metadata#users/$entity
+    businessPhones | ["494594133"]
+    displayName | John Doe
+    givenName | John
+    jobTitle | null
+    mail | john.doe@contoso.onmicrosoft.com
+    mobilePhone | null
+    officeLocation | null
+    preferredLanguage | en-US
+    surname | Doe
+    userPrincipalName | john.doe@contoso.onmicrosoft.com
+    id | 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
+    ```

package/docs/docs/cmd/spfx/project/project-permissions-grant.md

@@ -0,0 +1,65 @@
+# spfx project permissions grant
+
+Grant API permissions defined in the current SPFx project
+
+## Usage
+
+```sh
+m365 spfx project permissions grant [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    Run this command in the folder where the project is located from where you want to grant the permissions.
+
+This command grant the permissions defined in: _package-solution.json_.
+
+## Examples
+
+Grant API permissions requested in the current SPFx project
+
+```sh
+m365 spfx project permissions grant
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
+      "ConsentType": "AllPrincipals",
+      "IsDomainIsolated": false,
+      "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
+      "PackageName": null,
+      "Resource": "Microsoft Graph",
+      "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
+      "Scope": "Mail.Read"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    ClientId        : 6004a642-185c-479a-992a-15d1c23e2229
+    ConsentType     : AllPrincipals
+    IsDomainIsolated: false
+    ObjectId        : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+    PackageName     : null
+    Resource        : Microsoft Graph
+    ResourceId      : a46b0017-21e2-4db1-bc69-ca63576a38d6
+    Scope           : Mail.Read
+    ```
+
+=== "CSV"
+
+    ```csv
+    ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
+    6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
+    ```

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

@@ -0,0 +1,56 @@
+# spo applicationcustomizer add
+
+Add an application customizer to a site.
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer add [options]
+```
+
+## Options
+
+`-t, --title <title>`
+: The title of the application customizer.
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`-i, --clientSideComponentId <clientSideComponentId>`
+: Client-side component ID of the application customizer (GUID).
+
+`--clientSideComponentProperties [clientSideComponentProperties]`
+: JSON string with application customizer properties
+
+--8<-- "docs/cmd/_global.md"
+
+## 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 an application customizer can be created from the Windows cmd.exe:
+
+```sh
+m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --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 to the sales site.
+
+```sh
+m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Adds an application customizer to the sales site with some properties.
+
+```sh
+m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-sharinglink-clear.md

@@ -0,0 +1,46 @@
+# spo file sharinglink clear
+
+Removes sharing links of a file
+
+## Usage
+
+```sh
+m365 spo file sharinglink clear [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+: The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-s, --scope [scope]`
+: Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes all sharing links from a file specified by id without prompting for confirmation
+
+```sh
+m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --confirm
+```
+
+Removes sharing links of type anonymous from a file specified by url with prompting for confirmation
+
+```sh
+m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --scope anonymous
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-sharinglink-list.md

@@ -19,7 +19,7 @@ m365 spo file sharinglink list [options]
 `--fileId [fileId]`
 : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
 
-`--scope [scope]`
+`-s, --scope [scope]`
 : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
 
 --8<-- "docs/cmd/_global.md"