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

package/dist/utils/pid.js

@@ -68,6 +68,11 @@ exports.pid = {
             return processName;
         }
         return undefined;
+    },
+    isPowerShell() {
+        const processName = exports.pid.getProcessName(process.ppid) || '';
+        return processName.indexOf('powershell') > -1 ||
+            processName.indexOf('pwsh') > -1;
     }
 };
 //# sourceMappingURL=pid.js.map

package/dist/utils/spo.js

@@ -453,7 +453,7 @@ exports.spo = {
      * Retrieves the SiteId, VroomItemId and VroomDriveId from a specific file.
      * @param webUrl Web url
      * @param fileId GUID ID of the file
-     * @param fileUrl Decoded URL of the file
+     * @param fileUrl Decoded site-relative or server-relative URL of the file
      */
     getVroomFileDetails(webUrl, fileId, fileUrl) {
         return __awaiter(this, void 0, void 0, function* () {

package/docs/docs/cmd/aad/o365group/o365group-get.md

@@ -8,12 +8,6 @@ Gets information about the specified Microsoft 365 Group or Microsoft Teams team
 m365 aad o365group get [options]
 ```
 
-## Alias
-
-```sh
-m365 teams team get
-```
-
 ## Options
 
 `-i, --id <id>`
@@ -37,9 +31,3 @@ Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-9
 ```sh
 m365 aad o365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --includeSiteUrl
 ```
-
-Get information about the Microsoft Teams team with id _2eaf7dcd-7e83-4c3a-94f7-932a1299c844_
-
-```sh
-m365 teams team get --id 2eaf7dcd-7e83-4c3a-94f7-932a1299c844
-```

package/docs/docs/cmd/aad/user/user-add.md

@@ -71,6 +71,10 @@ m365 aad user add [options]
 !!! note
     After running this command, it may take a minute before the user is effectively created in the tenant.
 
+This command allows using unknown options. For a comprehensive list of user properties, please refer to the [Graph documentation page](https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties).
+
+If the specified option is not found, you will receive a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
+
 ## Examples
 
 Create a user and let him/her update the password at first login

package/docs/docs/cmd/aad/user/user-set.md

@@ -74,9 +74,9 @@ m365 aad user set [options]
 
 ## Remarks
 
-This command allows using unknown options.
+This command allows using unknown options. For a comprehensive list of user properties, please refer to the [Graph documentation page](https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties).
 
-If the user with the specified id or user name doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
+If the user with the specified ID or username doesn't exist, or if the specified option is not found, you will receive a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
 
 ## Examples
 

package/docs/docs/cmd/app/permission/permission-add.md

@@ -0,0 +1,53 @@
+# app permission add
+
+Adds the specified application and/or delegated permissions to the current AAD app API permissions
+
+## Usage
+
+```sh
+m365 app permission add [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Client ID of the Azure AD app registered in the .m365rc.json file to retrieve API permissions for
+
+`--applicationPermission [applicationPermission]`
+: Space-separated list of application permissions to add
+
+`--delegatedPermission [delegatedPermission]`
+: Space-separated list of delegated permissions to add
+
+`--grantAdminConsent`
+: If specified, admin consent to the newly added permissions will be granted.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If you have multiple apps registered in your .m365rc.json file, you can specify the app for which you'd like to retrieve permissions using the `--appId` option. If you don't specify the app using the `--appId` option, you'll be prompted to select one of the applications from your .m365rc.json file.
+
+## Examples
+
+Adds the specified application permissions to the default app registered in the .m365rc.json file while granting admin consent.
+
+```sh
+m365 app permission add --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
+```
+
+Adds the specified delegated permissions to the default app registered in the .m365rc.json file without granting admin consent.
+
+```sh
+m365 app permission add --delegatedPermission 'https://graph.microsoft.com/offline_access'
+```
+
+Adds the specified application and delegated permissions to a specific app registered in the .m365rc.json file while granting admin consent.
+
+```sh
+m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermission 'https://graph.microsoft.com/offline_access' --grantAdminConsent
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -50,3 +50,9 @@ m365 cli consent --service yammer
     ```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
     ```
+
+=== "Markdown"
+
+    ```md
+    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

@@ -73,3 +73,20 @@ m365 cli doctor
     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""]"
     ```
+
+=== "Markdown"
+
+    ```md
+    # cli doctor
+
+    Date: 2022-09-05
+
+    Property | Value
+    ---------|-------
+    cliVersion | 6.1.0
+    nodeVersion | v16.13.0
+    cliAadAppId | 31359c7f-bd7e-475c-86db-fdb8c937548e
+    cliAadAppTenant | common
+    authMode | DeviceCode
+    cliEnvironment |
+    ```

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

@@ -52,3 +52,9 @@ m365 cli issue --type command
     ```csv
     https://aka.ms/cli-m365/new-command
     ```
+
+=== "Markdown"
+
+    ```md
+    https://aka.ms/cli-m365/new-command
+    ```

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

@@ -40,6 +40,12 @@ m365 cli reconsent
     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
     ```
 
+=== "Markdown"
+
+    ```md
+    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-sh-setup.md

@@ -40,6 +40,12 @@ m365 cli completion sh setup
     Command completion successfully registered. Restart your shell to load the completion
     ```
 
+=== "Markdown"
+
+    ```md
+    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/config/config-get.md

@@ -51,6 +51,12 @@ When retrieving the `output` key, responses will look like this:
     json
     ```
 
+=== "Markdown"
+
+    ```md
+    json
+    ```
+
 ## More information
 
 - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.md)

package/docs/docs/cmd/docs.md

@@ -0,0 +1,51 @@
+# docs
+
+Returns the CLI for Microsoft 365 docs webpage URL
+
+## Usage
+
+```sh
+m365 docs [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+Configure `autoOpenLinksInBrowser` using [cli config set](../cmd/cli/config/config-set.md) to automatically open the webpage in the default browser.
+
+## Examples
+
+Returns the CLI for Microsoft 365 docs webpage URL
+
+```sh
+m365 docs
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "https://pnp.github.io/cli-microsoft365/"
+    ```
+
+=== "Text"
+
+    ```text
+    https://pnp.github.io/cli-microsoft365/
+    ```
+
+=== "CSV"
+
+    ```csv
+    https://pnp.github.io/cli-microsoft365/
+    ```
+
+=== "Markdown"
+
+    ```md
+    https://pnp.github.io/cli-microsoft365/
+    ```

package/docs/docs/cmd/flow/environment/environment-list.md

@@ -121,3 +121,21 @@ m365 flow environment list
     name,displayName
     d87a7535-dd31-4437-bfe1-95340acd55c5,Contoso Environment
     ```
+
+=== "Markdown"
+
+    ```md
+    # flow environment list
+
+    Date: 2023-05-18
+
+    ## Contoso Environment (/providers/Microsoft.ProcessSimple/environments/Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4)
+
+    Property | Value
+    ---------|-------
+    name | Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+    location | europe
+    type | Microsoft.ProcessSimple/environments
+    id | /providers/Microsoft.ProcessSimple/environments/Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4
+    displayName | Contoso Environment
+    ```

package/docs/docs/cmd/flow/flow-get.md

@@ -417,3 +417,23 @@ m365 flow get --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --n
     name,displayName,description,triggers,actions
     ca76d7b8-3b76-4050-8c03-9fb310ad172f,My Flow,,OpenApiConnection,"OpenApiConnection-AnalyzeImageV2, Compose, InitializeVariable, OpenApiConnection-HttpRequest, ParseJson, OpenApiConnection-PatchFileItem"
     ```
+
+=== "Markdown"
+
+    ```md
+    # flow get --environmentName "Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4" --name "ca76d7b8-3b76-4050-8c03-9fb310ad172f"
+
+    Date: 2023-05-18
+
+    ## My Flow (/providers/Microsoft.ProcessSimple/environments/Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4/flows/ca76d7b8-3b76-4050-8c03-9fb310ad172f)
+
+    Property | Value
+    ---------|-------
+    name | ca76d7b8-3b76-4050-8c03-9fb310ad172f
+    id | /providers/Microsoft.ProcessSimple/environments/Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4/flows/ca76d7b8-3b76-4050-8c03-9fb310ad172f
+    type | Microsoft.ProcessSimple/environments/flows
+    displayName | My Flow
+    description | My Flow
+    triggers | OpenApiConnection
+    actions | OpenApiConnection-AnalyzeImageV2, Compose, InitializeVariable, OpenApiConnection-HttpRequest, ParseJson, OpenApiConnection-PatchFileItem
+    ```

package/docs/docs/cmd/flow/flow-list.md

@@ -147,3 +147,20 @@ m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --
     name,displayName
     00afcb83-df7b-4fe0-ab9c-1542a1dc66a9,Contoso Invoicing Flow
     ```
+
+=== "Markdown"
+
+    ```md
+    # flow list --environmentName "Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4"
+
+    Date: 2023-05-18
+
+    ## Contoso Invoicing Flow (/providers/Microsoft.ProcessSimple/environments/Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4/flows/00afcb83-df7b-4fe0-ab9c-1542a1dc66a9)
+
+    Property | Value
+    ---------|-------
+    name | 00afcb83-df7b-4fe0-ab9c-1542a1dc66a9
+    id | /providers/Microsoft.ProcessSimple/environments/Default-1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4/flows/00afcb83-df7b-4fe0-ab9c-1542a1dc66a9
+    type | Microsoft.ProcessSimple/environments/flows
+    displayName | Contoso Invoicing Flow
+    ```

package/docs/docs/cmd/graph/changelog/changelog-list.md

@@ -51,3 +51,55 @@ Get all changes within Microsoft Graph that happend between _2021-01-01_ and _20
 ```sh
 m365 graph changelog list --startDate '2021-01-01' --endDate '2021-05-01'
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "guid": "2693683c-f49a-4715-a649-edadd3f54aadv1.0",
+        "category": "v1.0",
+        "title": "Teamwork and communications",
+        "description": "Added the **chatMessageActions** enumeration type.\r\\\nAdded the [chatMessageHistoryItem](https://learn.microsoft.com/en-us/graph/api/resources/chatMessageHistoryItem?view=graph-rest-1.0) resource type.\r\\\nAdded the **messageHistory** property to the [chatMessage](https://learn.microsoft.com/en-us/graph/api/resources/chatMessage?view=graph-rest-1.0) resource.\r\\\n",
+        "pubDate": "2023-05-18T23:04:05.000Z"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    category  title                        description
+    --------  ---------------------------  ----------------------------------------------
+    v1.0      Teamwork and communications  Added the chatMessageActions enumeration type.
+    ```
+
+=== "CSV"
+
+    ```csv
+    guid,category,title,description
+    2693683c-f49a-4715-a649-edadd3f54aadv1.0,v1.0,Teamwork and communications,"Added the **chatMessageActions** enumeration type.
+    Added the [chatMessageHistoryItem](https://learn.microsoft.com/en-us/graph/api/resources/chatMessageHistoryItem?view=graph-rest-1.0) resource type.
+    Added the **messageHistory** property to the [chatMessage](https://learn.microsoft.com/en-us/graph/api/resources/chatMessage?view=graph-rest-1.0) resource.
+    ```
+
+=== "Markdown"
+
+    ```md
+    # graph changelog list 
+
+    Date: 2023-05-22
+
+    ## Teamwork and communications
+
+    Property | Value
+    ---------|-------
+    guid | 2693683c-f49a-4715-a649-edadd3f54aadv1.0
+    category | v1.0
+    title | Teamwork and communications
+    description | Added the \*\*chatMessageActions\*\* enumeration type.
+    <br>Added the [chatMessageHistoryItem](https://learn.microsoft.com/en-us/graph/api/resources/chatMessageHistoryItem?view=graph-rest-1.0) resource type.
+    <br>Added the \*\*messageHistory\*\* property to the [chatMessage](https://learn.microsoft.com/en-us/graph/api/resources/chatMessage?view=graph-rest-1.0) resource.
+    ```

package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md

@@ -59,3 +59,64 @@ Create a schema extension with a verified domain
 ```sh
 m365 graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "extb4lob7o4_MySchemaExtension",
+      "description": "My Schema Extension",
+      "targetTypes": [
+        "Group"
+      ],
+      "status": "InDevelopment",
+      "owner": "19b5bd1f-3d5e-404a-80f5-ca840b40a082",
+      "properties": [
+        {
+          "name": "myProp1",
+          "type": "Integer"
+        },
+        {
+          "name": "myProp2",
+          "type": "String"
+        }
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    description: My Schema Extension
+    id         : extuf4mntoy_MySchemaExtension
+    owner      : 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+    properties : [{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]
+    status     : InDevelopment
+    targetTypes: ["Group"]
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,description,status,owner
+    extlywhx1h4_MySchemaExtension,My Schema Extension,InDevelopment,19b5bd1f-3d5e-404a-80f5-ca840b40a082
+    ```
+
+=== "Markdown"
+
+    ```md
+    # graph schemaextension add --id "MySchemaExtension" --description "My Schema Extension" --targetTypes "Group" --owner "19b5bd1f-3d5e-404a-80f5-ca840b40a082" --properties "[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]"
+
+    Date: 2023-05-22
+
+    ## extnevl1fo8_MySchemaExtension
+
+    Property | Value
+    ---------|-------
+    id | extnevl1fo8\_MySchemaExtension
+    description | My Schema Extension
+    status | InDevelopment
+    owner | 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+    ```

package/docs/docs/cmd/graph/schemaextension/schemaextension-get.md

@@ -27,3 +27,64 @@ Gets properties of a schema extension definition with ID domain_myExtension
 ```sh
 m365 graph schemaextension get --id domain_myExtension 
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "extuf4mntoy_MySchemaExtension",
+      "description": "My Schema Extension",
+      "targetTypes": [
+        "Group"
+      ],
+      "status": "InDevelopment",
+      "owner": "19b5bd1f-3d5e-404a-80f5-ca840b40a082",
+      "properties": [
+        {
+          "name": "myProp1",
+          "type": "Integer"
+        },
+        {
+          "name": "myProp2",
+          "type": "String"
+        }
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    description: My Schema Extension
+    id         : extuf4mntoy_MySchemaExtension
+    owner      : 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+    properties : [{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]
+    status     : InDevelopment
+    targetTypes: ["Group"]
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,description,status,owner
+    extuf4mntoy_MySchemaExtension,My Schema Extension,InDevelopment,19b5bd1f-3d5e-404a-80f5-ca840b40a082
+    ```
+
+=== "Markdown"
+
+    ```md
+    # graph schemaextension get --id "extuf4mntoy_MySchemaExtension"
+
+    Date: 2023-05-22
+
+    ## extuf4mntoy_MySchemaExtension
+
+    Property | Value
+    ---------|-------
+    id | extuf4mntoy\_MySchemaExtension
+    description | My Schema Extension
+    status | InDevelopment
+    owner | 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+    ```

package/docs/docs/cmd/graph/schemaextension/schemaextension-list.md

@@ -48,6 +48,67 @@ Get a list of schemaExtension objects created in the current tenant, with owner
 m365 graph schemaextension list --owner 617720dc-85fc-45d7-a187-cee75eaf239e --pageNumber 2 --pageSize 10
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "adatumisv_exo2",
+        "description": "sample description",
+        "targetTypes": [
+          "Message"
+        ],
+        "status": "Available",
+        "owner": "617720dc-85fc-45d7-a187-cee75eaf239e",
+        "properties": [
+          {
+            "name": "p1",
+            "type": "String"
+          },
+          {
+            "name": "p2",
+            "type": "String"
+          }
+        ]
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id              description         targetTypes  status     owner                                 properties                                                                                                                  
+    --------------  ------------------  -----------  ---------  ------------------------------------  --------------------------------------------------------------
+    adatumisv_exo2  sample description  Message      Available  617720dc-85fc-45d7-a187-cee75eaf239e  [{"name":"p1","type":"String"},{"name":"p2","type":"String"}]
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,description,status,owner,properties
+    adatumisv_exo2,sample description,Available,617720dc-85fc-45d7-a187-cee75eaf239e,"[{""name"":""p1"",""type"":""String""},{""name"":""p2"",""type"":""String""}]"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # graph schemaextension list
+
+    Date: 2023-05-22
+
+    ## adatumisv_exo2
+
+    Property | Value
+    ---------|-------
+    id | adatumisv\_exo2
+    description | sample description
+    status | Available
+    owner | 617720dc-85fc-45d7-a187-cee75eaf239e
+    properties | [{"name":"p1","type":"String"},{"name":"p2","type":"String"}]
+    ```
+
 ## More information
 
 [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/schemaextension_list](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/schemaextension_list)

package/docs/docs/cmd/graph/schemaextension/schemaextension-remove.md

@@ -36,3 +36,7 @@ Removes specified Microsoft Graph schema extension with ID domain_myExtension wi
 ```sh
 m365 graph schemaextension remove --id domain_myExtension --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md

@@ -58,3 +58,7 @@ Change the status of a schema extension to 'Available'
 ```sh
 m365 graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --status Available
 ```
+
+## Response
+
+The command won't return a response on success.