@pnp/cli-microsoft365 6.0.0 → 6.1.0-beta.17b053d

package/dist/utils/md.js

@@ -65,6 +65,14 @@ function removeTooManyEmptyLines(md) {
     const regex = new RegExp('(' + os_1.EOL + '){4,}', 'g');
     return md.replace(regex, Array(4).join(os_1.EOL));
 }
+function escapeMd(mdString) {
+    if (!mdString) {
+        return mdString;
+    }
+    return mdString.toString()
+        .replace(/([_*~`|])/g, '\\$1')
+        .replace(/\n/g, '<br>');
+}
 const convertFunctions = [
     convertTitle,
     convertHeadings,
@@ -83,6 +91,7 @@ exports.md = {
             md = convert(md);
         });
         return md;
-    }
+    },
+    escapeMd
 };
 //# sourceMappingURL=md.js.map

package/docs/docs/_clisettings.md

@@ -11,6 +11,7 @@ Setting name|Definition|Default value
 `csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
 `csvQuoted`|Quote all the non-empty fields even if not required|`false`
 `csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
+`disableTelemetry`|Disables sending of telemetry data|`false`
 `errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
 `helpMode`|Defines what part of command's help to display. Allowed values are `options`, `examples`, `remarks`, `response`, `full`|`full`
 `output`|Defines the default output when issuing a command|`json`

package/docs/docs/cmd/_global.md

@@ -5,7 +5,7 @@
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text,csv`. Default `json`
+: Output type. `json,text,csv,md`. Default `json`
 
 `--verbose`
 : Runs command with verbose logging

package/docs/docs/cmd/cli/cli-consent.md

@@ -30,3 +30,23 @@ Consent permissions to the Yammer API
 ```sh
 m365 cli consent --service yammer
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "To consent permissions for executing yammer commands, navigate in your web browser to https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&scope=https%3A%2F%2Fapi.yammer.com%2Fuser_impersonation"
+    ```
+
+=== "Text"
+
+    ```text
+    To consent permissions for executing yammer commands, navigate in your web browser to https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&scope=https%3A%2F%2Fapi.yammer.com%2Fuser_impersonation
+    ```
+
+=== "CSV"
+
+    ```csv
+    To consent permissions for executing yammer commands, navigate in your web browser to https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&scope=https%3A%2F%2Fapi.yammer.com%2Fuser_impersonation
+    ```

package/docs/docs/cmd/cli/cli-doctor.md

@@ -23,3 +23,53 @@ Retrieve diagnostic information
 ```sh
 m365 cli doctor
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "os": {
+        "platform": "win32",
+        "version": "Windows 10 Pro",
+        "release": "10.0.19045"
+      },
+      "cliVersion": "6.1.0",
+      "nodeVersion": "v16.13.0",
+      "cliAadAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
+      "cliAadAppTenant": "common",
+      "authMode": "DeviceCode",
+      "cliEnvironment": "",
+      "cliConfig": {
+        "output": "json",
+        "showHelpOnFailure": false
+      },
+      "roles": [],
+      "scopes": [
+        "AllSites.FullControl"
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    authMode       : DeviceCode
+    cliAadAppId    : 31359c7f-bd7e-475c-86db-fdb8c937548e
+    cliAadAppTenant: common
+    cliConfig      : {"output":"json","showHelpOnFailure":false}
+    cliEnvironment :
+    cliVersion     : 6.1.0
+    nodeVersion    : v16.13.0
+    os             : {"platform":"win32","version":"Windows 10 Pro","release":"10.0.19045"}
+    roles          : []
+    scopes         : ["AllSites.FullControl"]
+    ```
+
+=== "CSV"
+
+    ```csv
+    os,cliVersion,nodeVersion,cliAadAppId,cliAadAppTenant,authMode,cliEnvironment,cliConfig,roles,scopes
+    "{""platform"":""win32"",""version"":""Windows 10 Pro"",""release"":""10.0.19045""}",6.1.0,v16.13.0,31359c7f-bd7e-475c-86db-fdb8c937548e,common,DeviceCode,,"{""output"":""json"",""showHelpOnFailure"":false}",[],"[""AllSites.FullControl""]"
+    ```

package/docs/docs/cmd/cli/cli-issue.md

@@ -32,3 +32,23 @@ Suggest a new command
 ```sh
 m365 cli issue --type command
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "https://aka.ms/cli-m365/new-command"
+    ```
+
+=== "Text"
+
+    ```text
+    https://aka.ms/cli-m365/new-command
+    ```
+
+=== "CSV"
+
+    ```csv
+    https://aka.ms/cli-m365/new-command
+    ```

package/docs/docs/cmd/cli/cli-reconsent.md

@@ -20,6 +20,26 @@ Get the URL to open in the browser to re-consent CLI for Microsoft 365 permissio
 m365 cli reconsent
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    "To re-consent the PnP Microsoft 365 Management Shell Azure AD application navigate in your web browser to https://login.microsoftonline.com/common/oauth2/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&prompt=admin_consent"
+    ```
+
+=== "Text"
+
+    ```text
+    To re-consent the PnP Microsoft 365 Management Shell Azure AD application navigate in your web browser to https://login.microsoftonline.com/common/oauth2/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&prompt=admin_consent
+    ```
+
+=== "CSV"
+
+    ```csv
+    To re-consent the PnP Microsoft 365 Management Shell Azure AD application navigate in your web browser to https://login.microsoftonline.com/common/oauth2/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&prompt=admin_consent
+    ```
+
 ## More information
 
 - Re-consent the PnP Microsoft 365 Management Shell Azure AD application: [https://pnp.github.io/cli-microsoft365/user-guide/connecting-office-365/#re-consent-the-pnp-office-365-management-shell-azure-ad-application](https://pnp.github.io/cli-microsoft365/user-guide/connecting-office-365/#re-consent-the-pnp-office-365-management-shell-azure-ad-application)

package/docs/docs/cmd/cli/completion/completion-clink-update.md

@@ -24,9 +24,13 @@ This commands updates the list of commands and their options used by command com
 Write the list of commands for Clink (cmder) command completion to a file named `m365.lua` in the current directory
 
 ```powershell
-cli completion clink update > m365.lua
+m365 cli completion clink update > m365.lua
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/completion/completion-pwsh-setup.md

@@ -26,9 +26,13 @@ If the specified profile path doesn't exist, the CLI will try to create it.
 Set up command completion for PowerShell using the profile from the profile variable
 
 ```powershell
-cli completion pwsh setup --profile $profile
+m365 cli completion pwsh setup --profile $profile
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/completion/completion-pwsh-update.md

@@ -21,9 +21,13 @@ This commands updates the list of commands and their options used by command com
 Update list of commands for PowerShell command completion
 
 ```powershell
-cli completion pwsh update
+m365 cli completion pwsh update
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/completion/completion-sh-setup.md

@@ -17,9 +17,29 @@ m365 cli completion sh setup [options]
 Set up command completion for Zsh, Bash or Fish
 
 ```powershell
-cli completion sh setup
+m365 cli completion sh setup
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    "Command completion successfully registered. Restart your shell to load the completion"
+    ```
+
+=== "Text"
+
+    ```text
+    Command completion successfully registered. Restart your shell to load the completion
+    ```
+
+=== "CSV"
+
+    ```csv
+    Command completion successfully registered. Restart your shell to load the completion
+    ```
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/completion/completion-sh-update.md

@@ -24,6 +24,10 @@ Update list of commands for Zsh, Bash and Fish command completion
 m365 cli completion sh update
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/config/config-get.md

@@ -29,6 +29,28 @@ Get the output configured for CLI for Microsoft 365
 m365 cli config get --key output
 ```
 
+## Response
+
+When retrieving the `output` key, responses will look like this:
+
+=== "JSON"
+
+    ```json
+    "json"
+    ```
+
+=== "Text"
+
+    ```text
+    json
+    ```
+
+=== "CSV"
+
+    ```csv
+    json
+    ```
+
 ## More information
 
 - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.md)

package/docs/docs/cmd/cli/config/config-reset.md

@@ -31,6 +31,10 @@ Reset all configuration settings to default
 m365 cli config reset
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.md)

package/docs/docs/cmd/cli/config/config-set.md

@@ -34,6 +34,10 @@ Configure the default CLI output to JSON
 m365 cli config set --key output --value json
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.md)

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

@@ -0,0 +1,144 @@
+# planner plan set
+
+Updates a Microsoft Planner plan
+
+## Usage
+
+```sh
+m365 planner plan set [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the plan. Specify either `id` or `title` but not both.
+
+`-t, --title [title]`
+: Title of the plan. Specify either `id` or `title` but not both.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+
+`--newTitle [newTitle]`
+: New title of the plan.
+
+`--shareWithUserIds [shareWithUserIds]`
+: The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+
+`--shareWithUserNames [shareWithUserNames]`
+: The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+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`.
+
+## Examples
+
+Updates a Microsoft Planner plan title to New Title
+
+```sh
+m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --newTitle 'New Title'
+```
+
+Share a Microsoft Planner plan owned by the group, with the users
+
+```sh
+m365 planner plan set --title 'Plan Title' --ownerGroupName 'My Group' --shareWithUserNames 'user1@contoso.com,user2@contoso.com'
+```
+
+Updates a Microsoft Planner plan category labels
+
+```sh
+m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --category25 'Urgent'
+```
+
+## More information
+
+- Update plannerPlan: [https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http)
+- plannerPlanDetails resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0)
+- plannerCategoryDescriptions resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0)
+
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      },
+      "sharedWith": {
+        "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
+        "6463a5ce-2119-4198-9f2a-628761df4a62": true
+      },
+      "categoryDescriptions": {
+        "category1": null,
+        "category2": null,
+        "category3": null,
+        "category4": null,
+        "category5": null,
+        "category6": null,
+        "category7": null,
+        "category8": null,
+        "category9": null,
+        "category10": null,
+        "category11": null,
+        "category12": null,
+        "category13": null,
+        "category14": null,
+        "category15": null,
+        "category16": null,
+        "category17": null,
+        "category18": null,
+        "category19": null,
+        "category20": null,
+        "category21": null,
+        "category22": null,
+        "category23": null,
+        "category24": null,
+        "category25": null
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+

package/docs/docs/cmd/pp/chatbot/chatbot-get.md

@@ -0,0 +1,123 @@
+# pp chatbot get
+
+Get information about the specified chatbot
+
+## Usage
+
+```sh
+pp chatbot get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the chatbot. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the chatbot. Specify either `id` or `name` but not both.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a specific chatbot in a specific environment based on name
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Chatbot"
+```
+
+Get a specific chatbot in a specific environment based on name as admin
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Chatbot" --asAdmin
+```
+
+Get a specific chatbot in a specific environment based on id
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893"
+```
+
+Get a specific chatbot in a specific environment based on id as admin
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "authenticationtrigger": 0,
+      "_owningbusinessunit_value": "6da087c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "statuscode": 1,
+      "createdon": "2022-11-19T10:42:22Z",
+      "statecode": 0,
+      "schemaname": "new_bot_23f5f58697fd43d595eb451c9797a53d",
+      "_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "overwritetime": "1900-01-01T00:00:00Z",
+      "name": "CLI 365 Chatbot",
+      "solutionid": "fd140aae-4df4-11dd-bd17-0019b9312238",
+      "ismanaged": false,
+      "versionnumber": 1421457,
+      "language": 1033,
+      "_modifiedby_value": "5f91d7a7-5f46-494a-80fa-5c18b0221351",
+      "_modifiedonbehalfby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "modifiedon": "2022-11-19T10:42:24Z",
+      "componentstate": 0,
+      "botid": "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893",
+      "_createdby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "componentidunique": "cdcd6496-e25d-4ad1-91cf-3f4d547fdd23",
+      "authenticationmode": 1,
+      "_owninguser_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "accesscontrolpolicy": 0,
+      "runtimeprovider": 0,
+      "_publishedby_value": "John Doe",
+      "authenticationconfiguration": null,
+      "authorizedsecuritygroupids": null,
+      "overriddencreatedon": null,
+      "applicationmanifestinformation": null,
+      "importsequencenumber": null,
+      "synchronizationstatus": null,
+      "template": null,
+      "_providerconnectionreferenceid_value": null,
+      "configuration": null,
+      "utcconversiontimezonecode": null,
+      "publishedon": "2022-11-19T10:43:24Z",
+      "_createdonbehalfby_value": null,
+      "iconbase64": null,
+      "supportedlanguages": null,
+      "_owningteam_value": null,
+      "timezoneruleversionnumber": null,
+      "iscustomizable": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "iscustomizableanddeletable"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    botid      : 3a081d91-5ea8-40a7-8ac9-abbaa3fcb893
+    createdon  : 2022-11-19T10:42:22Z
+    modifiedon : 2022-11-19T10:42:24Z
+    name       : CLI 365 Chatbot
+    publishedon: 2022-11-19T10:43:24Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    name,botid,publishedon,createdon,modifiedon
+    CLI 365 Chatbot,3a081d91-5ea8-40a7-8ac9-abbaa3fcb893,2022-11-19T10:43:24Z,2022-11-19T10:42:22Z,2022-11-19T10:42:24Z
+    ```

package/docs/docs/cmd/pp/chatbot/chatbot-remove.md

@@ -0,0 +1,52 @@
+# pp chatbot remove
+
+Removes the specified chatbot
+
+## Usage
+
+```sh
+m365 pp chatbot remove [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the chatbot. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the chatbot. Specify either `id` or `name` but not both.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the specified Microsoft Power Platform chatbot owned by the currently signed-in user based on name
+
+```sh
+m365 pp chatbot remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Chatbot Name"
+```
+
+Removes the specified Microsoft Power Platform chatbot owned by the currently signed-in user based on id without confirmation
+
+```sh
+m365 pp chatbot remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --confirm
+```
+
+Removes the specified Microsoft Power Platform chatbot owned by another user based on name
+
+```sh
+m365 pp chatbot remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Chatbot Name" --asAdmin
+```
+
+## Response
+
+The command won't return a response on success.