Merge branch 'pnp:main' into getContainerType

pnp · Oct 17, 2024 · e3ce715 · e3ce715
2 parents f309e65 + 67e608f
commit e3ce715
Show file tree

Hide file tree

Showing 905 changed files with 33,943 additions and 19,253 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -16,7 +16,11 @@
       // 'm365 spo site get --url /', you'd use:
       // "args": ["spo", "site", "get", "--url", "/"]
       // after debugging, revert changes so that they won't end up in your PR
-      "args": []
+      "args": [],
+      "console": "integratedTerminal",
+      "env": {
+        "NODE_OPTIONS": "--enable-source-maps"
+      }
     },
     {
       "type": "node",

diff --git a/docs/docs/_clisettings.mdx b/docs/docs/_clisettings.mdx
@@ -2,6 +2,11 @@ Setting name|Definition|Default value
 ------------|----------|-------------
 `authType`|Default login method to use when running `m365 login` without the `--authType` option.|`deviceCode`
 `autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode.|`false`
+`clientId`|ID of the default Entra ID app use by the CLI to authenticate|``
+`clientSecret`|Secret of the default Entra ID app use by the CLI to authenticate|``
+`clientCertificateFile`|Path to the file containing the client certificate to use for authentication|``
+`clientCertificateBase64Encoded`|Base64-encoded client certificate contents|``
+`clientCertificatePassword`|Password to the client certificate file|``
 `copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
 `csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
 `csvHeader`|Display the column names on the first line|`true`
@@ -17,4 +22,4 @@ Setting name|Definition|Default value
 `prompt`|Prompts for missing values in required options and enables interactive selection when multiple values are available for a command that requires a specific value to be retrieved.|`true`
 `promptListPageSize`|By default, lists of choices longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once.|7
 `showHelpOnFailure`|Automatically display help when executing a command failed|`true`
-`showSpinner`|Display spinner when executing commands|`true`
+`tenantId`|ID of the default tenant to use when authenticating with|``
diff --git a/docs/docs/about/release-notes.mdx b/docs/docs/about/release-notes.mdx
diff --git a/docs/docs/cmd/app/permission/permission-add.mdx b/docs/docs/cmd/app/permission/permission-add.mdx
@@ -16,10 +16,10 @@ m365 app permission add [options]
 `--appId [appId]`
 : Client ID of the Microsoft Entra app registered in the .m365rc.json file to retrieve API permissions for.
 
-`--applicationPermission [applicationPermission]`
+`--applicationPermissions [applicationPermissions]`
 : Space-separated list of application permissions to add.
 
-`--delegatedPermission [delegatedPermission]`
+`--delegatedPermissions [delegatedPermissions]`
 : Space-separated list of delegated permissions to add.
 
 `--grantAdminConsent`
@@ -37,19 +37,19 @@ If you have multiple apps registered in your .m365rc.json file, you can specify
 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
+m365 app permission add --applicationPermissions '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'
+m365 app permission add --delegatedPermissions '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
+m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermissions 'https://graph.microsoft.com/offline_access' --grantAdminConsent
 ```
 
 ## Response

diff --git a/docs/docs/cmd/cli/cli-consent.mdx b/docs/docs/cmd/cli/cli-consent.mdx
@@ -16,7 +16,7 @@ m365 cli consent [options]
 
 ```md definition-list
 `-s, --service <service>`
-: Service for which to consent permissions. Allowed values: `VivaEngage`, (deprecated)`yammer`.
+: Service for which to consent permissions. Allowed values: `VivaEngage`.
 ```
 
 <Global />

diff --git a/docs/docs/cmd/cli/cli-doctor.mdx b/docs/docs/cmd/cli/cli-doctor.mdx
@@ -22,7 +22,7 @@ This command gets all the necessary diagnostic information needed to triage and
 
 ## Examples
 
-Retrieve diagnostic information
+Retrieve diagnostic information.
 
 ```sh
 m365 cli doctor
@@ -42,43 +42,45 @@ m365 cli doctor
     },
     "cliVersion": "6.1.0",
     "nodeVersion": "v16.13.0",
-    "cliAadAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
-    "cliAadAppTenant": "common",
-    "authMode": "DeviceCode",
+    "cliEntraAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
+    "cliEntraAppTenant": "common",
+    "authMode": "deviceCode",
     "cliEnvironment": "",
     "cliConfig": {
       "output": "json",
       "showHelpOnFailure": false
     },
     "roles": [],
-    "scopes": [
-      "AllSites.FullControl"
-    ]
+    "scopes": {
+      "https://graph.microsoft.com": [
+        "AllSites.FullControl"
+      ]
+    }
   }
   ```
 
   </TabItem>
   <TabItem value="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"]
+  authMode         : deviceCode
+  cliConfig        : {"output":"json","showHelpOnFailure":false}
+  cliEntraAppId    : 31359c7f-bd7e-475c-86db-fdb8c937548e
+  cliEntraAppTenant: common
+  cliEnvironment   :
+  cliVersion       : 6.1.0
+  nodeVersion      : v16.13.0
+  os               : {"platform":"win32","version":"Windows 10 Pro","release":"10.0.19045"}
+  roles            : []
+  scopes           : {"https://graph.microsoft.com":["AllSites.FullControl"]}
   ```
 
   </TabItem>
   <TabItem value="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""]"
+  os,cliVersion,nodeVersion,cliEntraAppId,cliEntraAppTenant,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}",[],"{""https://graph.microsoft.com"":[""AllSites.FullControl""]}"
   ```
 
   </TabItem>
@@ -93,12 +95,11 @@ m365 cli doctor
   ---------|-------
   cliVersion | 6.1.0
   nodeVersion | v16.13.0
-  cliAadAppId | 31359c7f-bd7e-475c-86db-fdb8c937548e
-  cliAadAppTenant | common
-  authMode | DeviceCode
+  cliEntraAppId | 31359c7f-bd7e-475c-86db-fdb8c937548e
+  cliEntraAppTenant | common
+  authMode | deviceCode
   cliEnvironment |
   ```
 
   </TabItem>
 </Tabs>
-
diff --git a/docs/docs/cmd/cli/cli-reconsent.mdx b/docs/docs/cmd/cli/cli-reconsent.mdx
diff --git a/docs/docs/cmd/connection/connection-use.mdx b/docs/docs/cmd/connection/connection-use.mdx
@@ -15,15 +15,21 @@ m365 connection use [options]
 ## Options
 
 ```md definition-list
-`-n, --name <name>`
+`-n, --name [name]`
 : The name of the connection to switch to.
 ```
 
 <Global />
 
 ## Remarks
 
-The value for `--name` can be found by running [m365 connection list](connection-list.mdx). You can update the name of a connection by running [m365 connection set](connection-set.mdx). 
+:::tip
+
+If you haven't disabled the "prompt" setting, running this command without options will show a list of available connections. You can then select the connection to activate it.
+
+:::
+
+You can update the name of a connection by running [m365 connection set](connection-set.mdx).
 
 ## Examples
 

diff --git a/docs/docs/cmd/entra/administrativeunit/administrativeunit-add.mdx b/docs/docs/cmd/entra/administrativeunit/administrativeunit-add.mdx
@@ -12,12 +12,6 @@ Creates a new administrative unit
 m365 entra administrativeunit add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit add [options]
-```
-
 ## Options
 
 ```md definition-list

diff --git a/docs/docs/cmd/entra/administrativeunit/administrativeunit-get.mdx b/docs/docs/cmd/entra/administrativeunit/administrativeunit-get.mdx
@@ -12,12 +12,6 @@ Gets information about a specific administrative unit
 m365 entra administrativeunit get [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit get [options]
-```
-
 ## Options
 
 ```md definition-list

diff --git a/docs/docs/cmd/entra/administrativeunit/administrativeunit-list.mdx b/docs/docs/cmd/entra/administrativeunit/administrativeunit-list.mdx
@@ -12,12 +12,6 @@ Retrieves a list of administrative units
 m365 entra administrativeunit list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit list [options]
-```
-
 ## Options
 
 <Global />

diff --git a/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-add.mdx b/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-add.mdx
@@ -10,12 +10,6 @@ Add a member (user, group, or device) to an administrative unit
 m365 entra administrativeunit member add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member add [options]
-```
-
 ## Options
 
 ```md definition-list

diff --git a/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-get.mdx b/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-get.mdx
@@ -12,12 +12,6 @@ Retrieves info about a specific member of an administrative unit
 m365 entra administrativeunit member get [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member get [options]
-```
-
 ## Options
 
 ```md definition-list

diff --git a/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-list.mdx b/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-list.mdx
@@ -12,12 +12,6 @@ Retrieves members (users, groups, or devices) of an administrative unit
 m365 entra administrativeunit member list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member list [options]
-```
-
 ## Options
 
 ```md definition-list

diff --git a/docs/docs/cmd/entra/administrativeunit/administrativeunit-remove.mdx b/docs/docs/cmd/entra/administrativeunit/administrativeunit-remove.mdx
@@ -10,12 +10,6 @@ Removes an administrative unit
 m365 entra administrativeunit remove [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit remove [options]
-```
-
 ## options
 
 ```md definition-list

diff --git a/docs/docs/cmd/entra/app/app-add.mdx b/docs/docs/cmd/entra/app/app-add.mdx
@@ -15,7 +15,6 @@ m365 entra app add [options]
 ## Alias
 
 ```sh
-m365 aad app add [options]
 m365 entra appregistration add [options]
 ```
 

diff --git a/docs/docs/cmd/entra/app/app-get.mdx b/docs/docs/cmd/entra/app/app-get.mdx
@@ -15,7 +15,6 @@ m365 entra app get [options]
 ## Alias
 
 ```sh
-m365 aad app get [options]
 m365 entra appregistration get [options]
 ```
 

diff --git a/docs/docs/cmd/entra/app/app-list.mdx b/docs/docs/cmd/entra/app/app-list.mdx
@@ -15,7 +15,6 @@ m365 entra app list [options]
 ## Alias
 
 ```sh
-m365 aad app list [options]
 m365 entra appregistration list [options]
 ```
 

diff --git a/docs/docs/cmd/entra/app/app-permission-add.mdx b/docs/docs/cmd/entra/app/app-permission-add.mdx
@@ -15,7 +15,6 @@ m365 entra app permission add [options]
 ## Alias
 
 ```sh
-m365 aad app permission add [options]
 m365 entra appregistration permission add [options]
 ```
 

diff --git a/docs/docs/cmd/entra/app/app-permission-list.mdx b/docs/docs/cmd/entra/app/app-permission-list.mdx
@@ -12,12 +12,6 @@ Lists the application and delegated permissions for a specified Entra Applicatio
 m365 entra app permission list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad app permission list [options]
-```
-
 ## Options
 
 ```md definition-list

diff --git a/docs/docs/cmd/entra/app/app-remove.mdx b/docs/docs/cmd/entra/app/app-remove.mdx
@@ -13,7 +13,6 @@ m365 entra app remove [options]
 ## Alias
 
 ```sh
-m365 aad app remove [options]
 m365 entra appregistration remove [options]
 ```