@pnp/cli-microsoft365 6.7.0 → 6.8.0-beta.00c3a00

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

@@ -15,14 +15,6 @@ m365 purview retentionlabel get [options]
 
 --8<-- "docs/cmd/_global.md"
 
-## Examples
-
-Get a retention label
-
-```sh
-m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
-```
-
 ## Remarks
 
 !!! attention
@@ -31,8 +23,15 @@ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
 !!! attention
     This command currently only supports delegated permissions.
 
-## Response
+## Examples
+
+Get a retention label
+
+```sh
+m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
 
+## Response
 
 === "JSON"
 

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

@@ -12,14 +12,6 @@ m365 purview retentionlabel list [options]
 
 --8<-- "docs/cmd/_global.md"
 
-## Examples
-
-Get a list of retention labels
-
-```sh
-m365 purview retentionlabel list
-```
-
 ## Remarks
 
 !!! attention
@@ -28,8 +20,15 @@ m365 purview retentionlabel list
 !!! attention
     This command currently only supports delegated permissions.
 
-## Response
+## Examples
+
+Get a list of retention labels
+
+```sh
+m365 purview retentionlabel list
+```
 
+## Response
 
 === "JSON"
 

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

@@ -18,14 +18,6 @@ m365 purview retentionlabel remove [options]
 
 --8<-- "docs/cmd/_global.md"
 
-## Examples
-
-Delete a retention label
-
-```sh
-m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
-```
-
 ## Remarks
 
 !!! attention
@@ -34,6 +26,14 @@ m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
 !!! attention
     This command currently only supports delegated permissions.
 
+## Examples
+
+Delete a retention label
+
+```sh
+m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
+```
+
 ## Response
 
 The command won't return a response on success.

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

@@ -39,6 +39,14 @@ m365 purview retentionlabel set [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## 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.
+
 ## Examples
 
 Update a retention label so that it retains documents as records and deletes them after one year.
@@ -53,14 +61,6 @@ Update a retention label so that it retains documents as regulatory records and
 m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRegulatoryRecord --actionAfterRetentionPeriod startDispositionReview --retentionDuration 365 --retentionTrigger dateModified
 ```
 
-## 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.
-
 ## Response
 
 The command won't return a response on success.

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

@@ -0,0 +1,118 @@
+# purview sensitivitylabel get
+
+Retrieve the specified sensitivity label
+
+## Usage
+
+```sh
+m365 purview sensitivitylabel get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the sensitivity label.
+
+`--userId [userId]`
+: User's Azure AD ID. Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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
+    When operating in app-only mode, you have the option to use either the `userName` or `userId` parameters to retrieve the sensitivity policy settings for a specific user. Without specifying either of these parameters, the command will retrieve the sensitivity policy settings for the currently authenticated user when operating in delegated mode.
+
+
+## Examples
+
+Get a sensitivity label
+
+```sh
+m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e
+```
+
+Get a sensitivity label that a specific user has access to by its Id
+
+```sh
+m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userId 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+Get a sensitivity label that a specific user has access to by its UPN
+
+```sh
+m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userName john.doe@contoso.com
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "6f4fb2db-ecf4-4279-94ba-23d059bf157e",
+      "name": "Unrestricted",
+      "description": "",
+      "color": "",
+      "sensitivity": 0,
+      "tooltip": "Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",
+      "isActive": true,
+      "isAppliable": true,
+      "contentFormats": [
+        "file",
+        "email"
+      ],
+      "hasProtection": false
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    color         :
+    contentFormats: ["file","email"]
+    description   :
+    hasProtection : false
+    id            : 6f4fb2db-ecf4-4279-94ba-23d059bf157e
+    isActive      : true
+    isAppliable   : true
+    name          : Unrestricted
+    sensitivity   : 0
+    tooltip       : Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,description,color,sensitivity,tooltip,isActive,isAppliable,contentFormats,hasProtection
+    6f4fb2db-ecf4-4279-94ba-23d059bf157e,Unrestricted,,,0,"Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",1,1,"[""file"",""email""]",
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview sensitivitylabel get --id "6f4fb2db-ecf4-4279-94ba-23d059bf157e"
+
+    Date: 3/25/2023
+
+    ## Unrestricted (6f4fb2db-ecf4-4279-94ba-23d059bf157e)
+
+    Property | Value
+    ---------|-------
+    id | 6f4fb2db-ecf4-4279-94ba-23d059bf157e
+    name | Unrestricted
+    description |
+    color |
+    sensitivity | 0
+    tooltip | Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
+    isActive | true
+    isAppliable | true
+    contentFormats | ["file","email"]
+    hasProtection | false
+    ```

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

@@ -0,0 +1,111 @@
+# purview sensitivitylabel list
+
+Get a list of sensitivity labels
+
+## Usage
+
+```sh
+m365 purview sensitivitylabel list [options]
+```
+
+## Options
+
+`--userId [userId]`
+: User's Azure AD ID. Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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
+    When operating in app-only mode, you have the option to use either the `userName` or `userId` parameters to retrieve the sensitivity label for a specific user. Without specifying either of these parameters, the command will retrieve the sensitivity label for the currently authenticated user when operating in delegated mode.
+
+## Examples
+
+Get a list of sensitivity labels
+
+```sh
+m365 purview sensitivitylabel list
+```
+
+Get a list of sensitivity labels that a specific user has access to by its Id
+
+```sh
+m365 purview sensitivitylabel list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+Get a list of sensitivity labels that a specific user has access to by its UPN
+
+```sh
+m365 purview sensitivitylabel list --userName john.doe@contoso.com
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "6f4fb2db-ecf4-4279-94ba-23d059bf157e",
+        "name": "Unrestricted",
+        "description": "",
+        "color": "",
+        "sensitivity": 0,
+        "tooltip": "Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",
+        "isActive": true,
+        "isAppliable": true,
+        "contentFormats": [
+          "file",
+          "email"
+        ],
+        "hasProtection": false,
+        "parent": null
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    name                   isActive
+    ------------------------------------  ---------------------  --------
+    6f4fb2db-ecf4-4279-94ba-23d059bf157e  Unrestricted           true
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,isActive
+    6f4fb2db-ecf4-4279-94ba-23d059bf157e,Unrestricted,1
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview sensitivitylabel list
+
+    Date: 3/26/2023
+
+    ## Unrestricted (6f4fb2db-ecf4-4279-94ba-23d059bf157e)
+
+    Property | Value
+    ---------|-------
+    id | 6f4fb2db-ecf4-4279-94ba-23d059bf157e
+    name | Unrestricted
+    description |
+    color |
+    sensitivity | 0
+    tooltip | Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
+    isActive | true
+    isAppliable | true
+    contentFormats | ["file","email"]
+    hasProtection | false
+    parent | null
+    ```

package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.md

@@ -0,0 +1,97 @@
+# purview sensitivitylabel policysettings list
+
+Get a list of policy settings for a sensitivity label.
+
+## Usage
+
+```sh
+m365 purview sensitivitylabel policysettings list [options]
+```
+
+## Options
+
+`--userId [userId]`
+: User's Azure AD ID. Optionally specify this if you want to get a list of policy settings for a sensitivity label that the user has access to. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Optionally specify this if you want to get a list of policy settings for a sensitivity label that the user has access to. Specify either `userId` or `userName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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
+    When operating in app-only mode, you have the option to use either the `userName` or `userId` parameters to retrieve the sensitivity policy settings for a specific user. Without specifying either of these parameters, the command will retrieve the sensitivity policy settings for the currently authenticated user when operating in delegated mode.
+
+## Examples
+
+Get a list of policy settings for a sensitivity label.
+
+```sh
+m365 purview sensitivitylabel policysettings list
+```
+
+Get a list of policy settings for a sensitivity label that a specific user has access to by its Id.
+
+```sh
+m365 purview sensitivitylabel policysettings list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+Get a list of policy settings for a sensitivity label that a specific user has access to by its UPN.
+
+```sh
+m365 purview sensitivitylabel policysettings list --userName john.doe@contoso.com
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4",
+      "moreInfoUrl": "https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels",
+      "isMandatory": true,
+      "isDowngradeJustificationRequired": true,
+      "defaultLabelId": "022bb90d-0cda-491d-b861-d195b14532dc"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    defaultLabelId                  : 022bb90d-0cda-491d-b861-d195b14532dc
+    id                              : 71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397
+    DB021CADB4
+    isDowngradeJustificationRequired: true
+    isMandatory                     : true
+    moreInfoUrl                     : https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,moreInfoUrl,isMandatory,isDowngradeJustificationRequired,defaultLabelId
+    71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4,https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels,1,1,022bb90d-0cda-491d-b861-d195b14532dc
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview sensitivitylabel policysettings list
+
+    Date: 4/11/2023
+
+    ## 71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4
+
+    Property | Value
+    ---------|-------
+    id | 71F139249895C2F6DC861031DAC47E0C2C37C6595582D4248CC77FD7293681B5DE348BC71AEB44068CB397DB021CADB4
+    moreInfoUrl | https://docs.microsoft.com/en-us/microsoft-365/compliance/get-started-with-sensitivity-labels?view=o365-worldwide#end-user-documentation-for-sensitivity-labels
+    isMandatory | true
+    isDowngradeJustificationRequired | true
+    defaultLabelId | 022bb90d-0cda-491d-b861-d195b14532dc
+    ```

package/docs/docs/cmd/search/externalconnection/externalconnection-get.md

@@ -69,3 +69,20 @@ m365 search externalconnection get --name "Test"
     id,name,description,state,configuration
     CLITest,CLI-Test,CLI Test,draft,"{""authorizedApps"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""],""authorizedAppIds"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""]}"
     ```
+
+=== "Markdown"
+
+    ```md
+    # search externalconnection get --id "CLITest"
+
+    Date: 2022-11-05
+
+    ## CLI-Test (CLITest)
+
+    Property | Value
+    ---------|-------
+    id | CLITest
+    name | CLI-Test
+    description | CLI Test
+    state | draft
+    ```

package/docs/docs/cmd/search/externalconnection/externalconnection-list.md

@@ -57,3 +57,20 @@ m365 search externalconnection list
     id,name,state
     CLITest,CLI-Test,draft
     ```
+
+=== "Markdown"
+
+    ```md
+    # search externalconnection list
+
+    Date: 2022-09-05
+
+    ## CLI-Test (CLITest)
+
+    Property | Value
+    ---------|-------
+    id | CLITest
+    name | CLI-Test
+    description | CLI Test
+    state | draft
+    ```

package/docs/docs/cmd/setup.md

@@ -0,0 +1,86 @@
+# setup
+
+Sets up CLI for Microsoft 365 based on your preferences
+
+## Usage
+
+```sh
+m365 setup [options]
+```
+
+## Options
+
+`--interactive`
+: Configure CLI for Microsoft 365 for interactive use without prompting for additional information
+
+`--scripting`
+: Configure CLI for Microsoft 365 for use in scripts without prompting for additional information
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+The `m365 setup` command is a wizard that helps you configure the CLI for Microsoft 365 for your needs. It will ask you a series of questions and based on your answers, it will configure the CLI for Microsoft 365 for you.
+
+The command will ask you the following questions:
+
+- _How do you plan to use the CLI?_
+
+  You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors and show spinners. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
+
+- _Are you going to use the CLI in PowerShell?_ (asked only when you chose to configure CLI for scripting)
+
+  To simplify using CLI in PowerShell, you can configure the CLI to output errors to stdout, instead of the default stderr which is tedious to handle in PowerShell.
+
+- _How experienced are you in using the CLI?_
+
+  You can choose between **beginner** and **proficient**. If you're just starting working with the CLI, it will show you full help information. For more experienced users, it will only show information about commands' options. No matter how you configure this setting, you can always invoke full help by using `--help full`.
+
+After you answer these questions, the command will build a preset and ask you to confirm using it to configure the CLI.
+
+If you want to configure the CLI on a non-interactive system, or want to configure CLI without answering the questions, you can use the `--interactive` or `--scripting` options. When using these options, CLI will apply the correct presets. Additionally, it will detect if it's used in PowerShell and configure CLI accordingly.
+
+The `m365 setup` command uses the following presets:
+
+- interactive use:
+  - autoOpenLinksInBrowser: true,
+  - copyDeviceCodeToClipboard: true,
+  - output: 'text',
+  - printErrorsAsPlainText: true,
+  - prompt: true,
+  - showHelpOnFailure: true,
+  - showSpinner: true
+- scripting use:
+  - autoOpenLinksInBrowser: false,
+  - copyDeviceCodeToClipboard: false,
+  - output: 'json',
+  - printErrorsAsPlainText: false,
+  - prompt: false,
+  - showHelpOnFailure: false,
+  - showSpinner: false
+- use in PowerShell:
+  - errorOutput: 'stdout'
+- beginner:
+  - helpMode: 'full'
+- proficient:
+  - helpMode: 'options'
+
+## Examples
+
+Configure CLI for Microsoft based on your preferences interactively
+
+```sh
+m365 setup
+```
+
+Configure CLI for Microsoft for interactive use without prompting for additional information
+
+```sh
+m365 setup --interactive
+```
+
+Configure CLI for Microsoft for use in scripts without prompting for additional information
+
+```sh
+m365 setup --scripting
+```

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

@@ -29,7 +29,7 @@ m365 spo applicationcustomizer add [options]
 
 ## 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:
+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 treats 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\"}'

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

@@ -0,0 +1,77 @@
+# spo applicationcustomizer remove
+
+Removes an application customizer that is added to a site
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The url of the site.
+
+`-t, --title [title]`
+: The title of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-s, --scope [scope]`
+: Scope of the application customizer. Allowed values: `Site`, `Web`, and `All`. Defaults to `All`.
+
+`--confirm`
+: Don't prompt for confirming removal of the application customizer.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the command finds multiple application customizers with the specified title or clientSideComponentId, it will prompt you to disambiguate which customizer it should remove, listing the discovered IDs.
+
+## Examples
+
+Remove an application customizer by id
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove an application customizer by title
+
+```sh
+m365 spo applicationcustomizer remove --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove an application customizer by clientSideComponentId
+
+```sh
+m365 spo applicationcustomizer remove --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove an application customizer by its id without prompting for confirmation
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm
+```
+
+Remove an application customizer from a site collection by its id without prompting for confirmation
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm --scope Site
+```
+
+Remove an application customizer from a site by its id without prompting for confirmation
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm --scope Web
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/commandset/commandset-set.md

@@ -41,7 +41,7 @@ m365 spo commandset set [options]
 
 ## 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 a ListView Command Set can be created from the Windows cmd.exe:
+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 treats quotes differently. For example, this is how a ListView Command Set can be created from the Windows cmd.exe:
 
 ```sh
 m365 spo commandset set --webUrl https://contoso.sharepoint.com/sites/test --title "CLI Commandset" --location "Both" --listType "List" --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'