@pnp/cli-microsoft365 6.3.0-beta.e46ffee → 6.3.0-beta.f76dcaa

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/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"

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

@@ -0,0 +1,104 @@
+# spo file sharinglink set
+
+Updates a sharing link of a file
+
+## Usage
+
+```sh
+m365 spo file sharinglink set [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.
+
+`--id <id>`
+: The ID of the sharing link.
+
+`--expirationDateTime <expirationDateTime>`
+:	The date and time to set the expiration. This should be defined as a valid ISO 8601 string. This options only works for anonymous links.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Updates an anonymous sharing link from a file by a specified site-relative URL with the expirationDateTime parameter
+
+```sh
+m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Document.docx" --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
+```
+
+Updates an anonymous sharing link from a file by id with the expirationDateTime parameter
+
+```sh
+m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "7c9f97c9-1bda-433c-9364-bb83e81771ee",
+      "roles": [
+        "read"
+      ],
+      "expirationDateTime": "2023-02-09T16:57:00Z",
+      "hasPassword": false,
+      "grantedToIdentitiesV2": [],
+      "grantedToIdentities": [],
+      "link": {
+        "scope": "anonymous",
+        "type": "view",
+        "webUrl": "https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g",
+        "preventsDownload": false
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    expirationDateTime   : 2023-02-09T16:57:00Z
+    grantedToIdentities  : []
+    grantedToIdentitiesV2: []
+    hasPassword          : false
+    id                   : 7c9f97c9-1bda-433c-9364-bb83e81771ee
+    link                 : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g","preventsDownload":false}
+    roles                : ["read"]
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,roles,expirationDateTime,hasPassword,grantedToIdentitiesV2,grantedToIdentities,link
+    7c9f97c9-1bda-433c-9364-bb83e81771ee,"[""read""]",2023-02-09T16:57:00Z,,[],[],"{""scope"":""anonymous"",""type"":""view"",""webUrl"":""https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g"",""preventsDownload"":false}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # spo file sharinglink set --webUrl "https://contoso.sharepoint.com" --fileUrl "/sites/demo/Shared Documents/Document.docx" --expirationDateTime "2023-02-09T16:57:00.000Z" --id "7c9f97c9-1bda-433c-9364-bb83e81771ee"
+
+    Date: 5/2/2023
+
+    ## 7c9f97c9-1bda-433c-9364-bb83e81771ee
+
+    Property | Value
+    ---------|-------
+    id | 7c9f97c9-1bda-433c-9364-bb83e81771ee
+    roles | ["read"]
+    expirationDateTime | 2023-02-09T16:57:00Z
+    hasPassword | false
+    grantedToIdentitiesV2 | []
+    grantedToIdentities | []
+    link | {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-\_527\_fI9g","preventsDownload":false}
+    ```

package/docs/docs/cmd/spo/list/list-contenttype-add.md

@@ -13,7 +13,7 @@ m365 spo list contenttype add [options]
 `-u, --webUrl <webUrl>`
 : URL of the site where the list is located.
 
-`-i, --listId [listId]`
+`-l, --listId [listId]`
 : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
 
 `-t, --listTitle [listTitle]`

package/docs/docs/cmd/spo/list/list-contenttype-default-set.md

@@ -13,7 +13,7 @@ m365 spo list contenttype default set [options]
 `-u, --webUrl <webUrl>`
 : URL of the site where the list is located.
 
-`-i, --listId [listId]`
+`-l, --listId [listId]`
 : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
 
 `-t, --listTitle [listTitle]`

package/docs/docs/cmd/spo/list/list-contenttype-list.md

@@ -13,7 +13,7 @@ m365 spo list contenttype list [options]
 `-u, --webUrl <webUrl>`
 : URL of the site where the list is located.
 
-`-i, --listId [listId]`
+`-l, --listId [listId]`
 : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
 
 `-t, --listTitle [listTitle]`

package/docs/docs/cmd/spo/list/list-contenttype-remove.md

@@ -13,7 +13,7 @@ m365 spo list contenttype remove [options]
 `-u, --webUrl <webUrl>`
 : URL of the site where the list is located.
 
-`-i, --listId [listId]`
+`-l, --listId [listId]`
 : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
 
 `-t, --listTitle [listTitle]`

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

@@ -35,7 +35,7 @@ m365 spo navigation node add [options]
 
 ## Remarks
 
-In order to use option `audienceIds`, make sure that audience targeted navigation is enabled using command [spo web set](../web/web-set.md).
+To enable/disable audience targeting for the navigation bar, use the [`spo web set`](../web/web-set.md) command.
 
 ## Examples
 

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/navigation/navigation-node-set.md

@@ -32,7 +32,7 @@ m365 spo navigation node set [options]
 
 ## Remarks
 
-To enable/disable audience targeting for the nsavigation bar, use command [`spo web set`](../web/web-set.md).
+To enable/disable audience targeting for the navigation bar, use the [`spo web set`](../web/web-set.md) command.
 
 ## Examples
 

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

@@ -28,6 +28,9 @@ m365 spo sitedesign add [options]
 `-a, --previewImageAltText [previewImageAltText]`
 : The alt text description of the image for accessibility
 
+`--thumbnailUrl [thumbnailUrl]`
+: The new URL of a thumbnail image. If none is specified SharePoint will use a generic image
+
 `--isDefault`
 : Set if the site design is applied as the default site design
 

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/docs/docs/cmd/status.md

@@ -23,3 +23,49 @@ Show the information about the current login to the Microsoft 365
 ```sh
 m365 status
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "connectedAs": "john.doe@contoso.onmicrosoft.com",
+      "authType": "DeviceCode",
+      "appId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
+      "appTenant": "common"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    appId      : 31359c7f-bd7e-475c-86db-fdb8c937548e
+    appTenant  : common
+    authType   : DeviceCode
+    connectedAs: john.doe@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    connectedAs,authType,appId,appTenant
+    john.doe@contoso.onmicrosoft.com,DeviceCode,31359c7f-bd7e-475c-86db-fdb8c937548e,common
+    ```
+
+=== "Markdown"
+
+    ```md
+    # status
+
+    Date: 7/2/2023
+
+
+
+    Property | Value
+    ---------|-------
+    connectedAs | john.doe@contoso.onmicrosoft.com
+    authType | DeviceCode
+    appId | 31359c7f-bd7e-475c-86db-fdb8c937548e
+    appTenant | common
+    ```

package/docs/docs/cmd/version.md

@@ -19,3 +19,29 @@ Show the version of CLI for Microsoft 365
 ```sh
 m365 version
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    v6.3.0
+    ```
+
+=== "Text"
+
+    ```text
+    v6.3.0
+    ```
+
+=== "CSV"
+
+    ```csv
+    v6.3.0
+    ```
+
+=== "Markdown"
+
+    ```md
+    v6.3.0
+    ```