@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.1cd2525

package/docs/docs/cmd/login.md

@@ -1,190 +0,0 @@
-# login
-
-Log in to Microsoft 365
-
-## Usage
-
-```sh
-m365 login [options]
-```
-
-## Options
-
-`-t, --authType [authType]`
-: The type of authentication to use. Allowed values `certificate,deviceCode,password,identity,browser,secret`. Default `deviceCode`
-
-`-u, --userName [userName]`
-: Name of the user to authenticate. Required when `authType` is set to `password`
-
-`-p, --password [password]`
-: Password for the user or the certificate. Required when `authType` is set to `password`, or when `authType` is set to `certificate` and the provided certificate requires a password to open
-
-`-c, --certificateFile [certificateFile]`
-: Path to the file with certificate private key. When `authType` is set to `certificate`, specify either `certificateFile` or `certificateBase64Encoded`
-
-`--certificateBase64Encoded [certificateBase64Encoded]`
-: Base64-encoded string with certificate private key. When `authType` is set to `certificate`, specify either `certificateFile` or `certificateBase64Encoded`
-
-`--thumbprint [thumbprint]`
-: Certificate thumbprint. If not specified, and `authType` is set to `certificate`, it will be automatically calculated based on the specified certificate
-
-`-s, --secret [secret]`
-: Client Secret of the Azure AD application to use for authentication. Required when `authType` is set to `secret`.
-
-`--appId [appId]`
-: App ID of the Azure AD application to use for authentication. If not specified, use the app specified in the `CLIMICROSOFT365_AADAPPID` environment variable. If the environment variable is not defined, use the multitenant PnP Management Shell app
-
-`--tenant [tenant]`
-: ID of the tenant from which accounts should be able to authenticate. Use `common` or `organization` if the app is multitenant. If not specified, use the tenant specified in the `CLIMICROSOFT365_TENANT` environment variable. If the environment variable is not defined, use `common` as the tenant identifier
-
-`--cloud [cloud]`
-: Cloud to connect to. Allowed values `Public`, `USGov`, `USGovHigh`, `USGovDoD` and `China`. Default `Public`
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Using the `login` command you can log in to Microsoft 365.
-
-By default, the `login` command uses device code OAuth flow to log in to Microsoft 365. Alternatively, you can authenticate using a user name and password or certificate, which are convenient for CI/CD scenarios, but which come with their own [limitations](../user-guide/connecting-office-365.md).
-
-When logging in to Microsoft 365 using the user name and password, next to the access and refresh token, the CLI for Microsoft 365 will store the user credentials so that it can automatically re-authenticate if necessary. Similarly to the tokens, the credentials are removed by re-authenticating using the device code or by calling the [logout](logout.md) command.
-
-When logging in to Microsoft 365 using a certificate, the CLI for Microsoft 365 will store the contents of the certificate so that it can automatically re-authenticate if necessary. The contents of the certificate are removed by re-authenticating using the device code or by calling the [logout](logout.md) command.  
-
-To log in to Microsoft 365 using a certificate or secret, you will typically [create a custom Azure AD application](../user-guide/using-own-identity.md). To use this application with the CLI for Microsoft 365, you will set the `CLIMICROSOFT365_AADAPPID` environment variable to the application's ID and the `CLIMICROSOFT365_TENANT` environment variable to the ID of the Azure AD tenant, where you created the Azure AD application. Also, please make sure to read about [the caveats when using the certificate login option](../user-guide/cli-certificate-caveats.md).
-
-Managed identity in Azure Cloud Shell is the identity of the user. It is neither system- nor user-assigned and it can't be configured. To log in to Microsoft 365 using managed identity in Azure Cloud Shell, set `authType` to `identity` and don't specify the `userName` option.
-
-When connecting to clouds other than `Public`, you'll need to use an Azure AD application registered in a directory provisioned in that cloud. If you try to login using the default Azure AD application, login will fail.
-
-## Examples
-
-Log in to Microsoft 365 using the device code
-
-```sh
-m365 login
-```
-
-Log in to Microsoft 365 using the device code in debug mode including detailed debug information in the console output
-
-```sh
-m365 login --debug
-```
-
-Log in to Microsoft 365 using a user name and password
-
-```sh
-m365 login --authType password --userName user@contoso.com --password pass@word1
-```
-
-Log in to Microsoft 365 using a PEM certificate
-
-```sh
-m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem
-```
-
-Log in to Microsoft 365 using a PEM certificate. Use the specified thumbprint
-
-```sh
-m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem  --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1
-```
-
-Log in to Microsoft 365 using a personal information exchange (.pfx) file
-
-```sh
-m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
-```
-
-Log in to Microsoft 365 using a personal information exchange (.pfx) file protected with an empty password
-
-```sh
-m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password
-```
-
-Log in to Microsoft 365 using a personal information exchange (.pfx) file not protected with a password
-
-```sh
-m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx
-```
-
-Log in to Microsoft 365 using a personal information exchange (.pfx) file. Use the specified thumbprint
-
-```sh
-m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1 --password 'pass@word1'
-```
-
-Log in to Microsoft 365 using a certificate from a base64-encoded string
-
-```sh
-m365 login --authType certificate --certificateBase64Encoded MIII2QIBAzCCCJ8GCSqGSIb3DQEHAaCCCJAEg...eX1N5AgIIAA== --thumbprint D0C9B442DE249F55D10CDA1A2418952DC7D407A3
-```
-
-Log in to Microsoft 365 using a system assigned managed identity. Applies to Azure resources with managed identity enabled,
-such as Azure Virtual Machines, Azure App Service or Azure Functions
-
-```sh
-m365 login --authType identity
-```
-
-Log in to Microsoft 365 using managed identity in Azure Cloud Shell. Uses the identity of the current user.
-
-```sh
-m365 login --authType identity
-```
-
-Log in to Microsoft 365 using a user-assigned managed identity. Client id or principal id also known as object id value can be specified in the `userName` option. Applies to Azure resources with managed identity enabled, such as Azure Virtual Machines, Azure App Service or Azure Functions
-
-```sh
-m365 login --authType identity --userName ac9fbed5-804c-4362-a369-21a4ec51109e
-```
-
-Log in to Microsoft 365 using your own multitenant Azure AD application
-
-```sh
-m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c
-```
-
-Log in to Microsoft 365 using your own Azure AD application that's restricted only to allow accounts from the specific tenant
-
-```sh
-m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a
-```
-
-Log in to Microsoft 365 using the interactive browser authentication. Uses the identity of the current user.
-
-```sh
-m365 login --authType browser
-```
-
-Log in to Microsoft 365 using a client secret.
-
-```sh
-m365 login --authType secret --secret topSeCr3t@007
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
-    ```
-
-=== "Text"
-
-    ```text
-    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
-    ```
-
-=== "CSV"
-
-    ```csv
-    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
-    ```
-
-=== "Markdown"
-
-    ```md
-    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
-    ```

package/docs/docs/cmd/logout.md

@@ -1,35 +0,0 @@
-# logout
-
-Log out from Microsoft 365
-
-## Usage
-
-```sh
-m365 logout [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-The `logout` command logs out from Microsoft 365 and removes any access and refresh tokens from memory
-
-## Examples
-
-Log out from Microsoft 365
-
-```sh
-m365 logout
-```
-
-Log out from Microsoft 365 in debug mode including detailed debug information in the console output
-
-```sh
-m365 logout --debug
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,21 +0,0 @@
-# onedrive list
-
-Retrieves a list of OneDrive sites
-
-## Usage
-
-```sh
-m365 onedrive list [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Retrieves a list of OneDrive sites from the tenant.
-
-```sh
-m365 onedrive list
-```

package/docs/docs/cmd/onedrive/report/report-activityfilecounts.md

@@ -1,39 +0,0 @@
-# onedrive report activityfilecounts
-
-Gets the number of unique, licensed users that performed file interactions against any OneDrive account
-
-## Usage
-
-```sh
-m365 onedrive report activityfilecounts [options]
-```
-
-## Options
-
-`-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
-
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Gets the number of unique, licensed users that performed file interactions against any OneDrive account for the last week
-
-```sh
-m365 onedrive report activityfilecounts --period D7
-```
-
-Gets the number of unique, licensed users that performed file interactions against any OneDrive account for the last week and exports the report data in the specified path in text format
-
-```sh
-m365 onedrive report activityfilecounts --period D7 --output text > "activityfilecounts.txt"
-```
-
-Gets the number of unique, licensed users that performed file interactions against any OneDrive account for the last week and exports the report data in the specified path in json format
-
-```sh
-m365 onedrive report activityfilecounts --period D7 --output json > "activityfilecounts.json"
-```

package/docs/docs/cmd/onedrive/report/report-activityusercounts.md

@@ -1,39 +0,0 @@
-# onedrive report activityusercounts
-
-Gets the trend in the number of active OneDrive users
-
-## Usage
-
-```sh
-m365 onedrive report activityusercounts [options]
-```
-
-## Options
-
-`-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
-
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Gets the trend in the number of active OneDrive users for the last week
-
-```sh
-m365 onedrive report activityusercounts --period D7
-```
-
-Gets the trend in the number of active OneDrive users for the last week and exports the report data in the specified path in text format
-
-```sh
-m365 onedrive report activityusercounts --period D7 --output text > "activityusercounts.txt"
-```
-
-Gets the trend in the number of active OneDrive users for the last week and exports the report data in the specified path in json format
-
-```sh
-m365 onedrive report activityusercounts --period D7 --output json > "activityusercounts.json"
-```

package/docs/docs/cmd/onedrive/report/report-activityuserdetail.md

@@ -1,48 +0,0 @@
-# onedrive report activityuserdetail
-
-Gets details about OneDrive activity by user
-
-## Usage
-
-```sh
-m365 onedrive report activityuserdetail [options]
-```
-
-## Options
-
-`-p, --period [period]`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
-
-`-d, --date [date]`
-: The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both`
-
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Gets details about OneDrive activity by user for the last week
-
-```sh
-m365 onedrive report activityuserdetail --period D7
-```
-
-Gets details about OneDrive activity by user for May 1, 2019
-
-```sh
-m365 onedrive report activityuserdetail --date 2019-05-01
-```
-
-Gets details about OneDrive activity by user for the last week and exports the report data in the specified path in text format
-
-```sh
-m365 onedrive report activityuserdetail --period D7 --output text > "onedriveactivityuserdetail.txt"
-```
-
-Gets details about OneDrive activity by user for the last week and exports the report data in the specified path in json format
-
-```sh
-m365 onedrive report activityuserdetail --period D7 --output json > "onedriveactivityuserdetail.json"
-```

package/docs/docs/cmd/onedrive/report/report-usageaccountcounts.md

@@ -1,43 +0,0 @@
-# onedrive report usageaccountcounts
-
-Gets the trend in the number of active OneDrive for Business sites
-
-## Usage
-
-```sh
-m365 onedrive report usageaccountcounts [options]
-```
-
-## Options
-
-`-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
-
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Any site on which users viewed, modified, uploaded, downloaded, shared, or synced files is considered an active site
-
-## Examples
-
-Gets the trend in the number of active OneDrive for Business sites for the last week
-
-```sh
-m365 onedrive report usageaccountcounts --period D7
-```
-
-Gets the trend in the number of active OneDrive for Business sites for the last week and exports the report data in the specified path in text format
-
-```sh
-m365 onedrive report usageaccountcounts --period D7 --output text > "usageaccountcounts.txt"
-```
-
-Gets the trend in the number of active OneDrive for Business sites for the last week and exports the report data in the specified path in json format
-
-```sh
-m365 onedrive report usageaccountcounts --period D7 --output json > "usageaccountcounts.json"
-```

package/docs/docs/cmd/onedrive/report/report-usageaccountdetail.md

@@ -1,48 +0,0 @@
-# onedrive report usageaccountdetail
-
-Gets details about OneDrive usage by account
-
-## Usage
-
-```sh
-m365 onedrive report usageaccountdetail [options]
-```
-
-## Options
-
-`-p, --period [period]`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
-
-`-d, --date [date]`
-: The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both`
-
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Gets details about OneDrive usage by account for the last week
-
-```sh
-m365 onedrive report usageaccountdetail --period D7
-```
-
-Gets details about OneDrive usage by account for May 1, 2019
-
-```sh
-m365 onedrive report usageaccountdetail --date 2019-05-01
-```
-
-Gets details about OneDrive usage by account for the last week and exports the report data in the specified path in text format
-
-```sh
-m365 onedrive report usageaccountdetail --period D7 --output text > "onedriveusageaccountdetail.txt"
-```
-
-Gets details about OneDrive usage by account for the last week and exports the report data in the specified path in json format
-
-```sh
-m365 onedrive report usageaccountdetail --period D7 --output json > "onedriveusageaccountdetail.json"
-```

package/docs/docs/cmd/onedrive/report/report-usagefilecounts.md

@@ -1,43 +0,0 @@
-# onedrive report usagefilecounts
-
-Gets the total number of files across all sites and how many are active files
-
-## Usage
-
-```sh
-m365 onedrive report usagefilecounts [options]
-```
-
-## Options
-
-`-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
-
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-A file is considered active if it has been saved, synced, modified, or shared within the specified time period.
-
-## Examples
-
-Gets the total number of files across all sites and how many are active files for the last week
-
-```sh
-m365 onedrive report usagefilecounts --period D7
-```
-
-Gets the total number of files across all sites and how many are active files for the last week and exports the report data in the specified path in text format
-
-```sh
-m365 onedrive report usagefilecounts --period D7 --output text > "usagefilecounts.txt"
-```
-
-Gets the total number of files across all sites and how many are active files for the last week and exports the report data in the specified path in json format
-
-```sh
-m365 onedrive report usagefilecounts --period D7 --output json > "usagefilecounts.json"
-```

package/docs/docs/cmd/onedrive/report/report-usagestorage.md

@@ -1,39 +0,0 @@
-# onedrive report usagestorage
-
-Gets the trend on the amount of storage you are using in OneDrive for Business
-
-## Usage
-
-```sh
-m365 onedrive report usagestorage [options]
-```
-
-## Options
-
-`-p, --period <period>`
-: The length of time over which the report is aggregated. Supported values `D7,D30,D90,D180`
-
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Gets the trend on the amount of storage you are using in OneDrive for Business for the last week
-
-```sh
-m365 onedrive report usagestorage --period D7
-```
-
-Gets the trend on the amount of storage you are using in OneDrive for Business for the last week and exports the report data in the specified path in text format
-
-```sh
-m365 onedrive report usagestorage --period D7 --output text > "usagestorage.txt"
-```
-
-Gets the trend on the amount of storage you are using in OneDrive for Business for the last week and exports the report data in the specified path in json format
-
-```sh
-m365 onedrive report usagestorage --period D7 --output json > "usagestorage.json"
-```

package/docs/docs/cmd/onenote/notebook/notebook-list.md

@@ -1,70 +0,0 @@
-# onenote notebook list
-
-Retrieve a list of notebooks.
-
-## Usage
-
-```sh
-m365 onenote notebook list [options]
-```
-
-## Options
-
-`--userId [userId]`
-: Id of the user. Use either userId or userName, but not both.
-
-`--userName [userName]`
-: Name of the user. Use either userId or userName, but not both.
-
-`--groupId [groupId]`
-: Id of the SharePoint group. Use either groupName or groupId, but not both
-
-`--groupName [groupName]`
-: Name of the SharePoint group. Use either groupName or groupId, but not both.
-
-`-u, --webUrl [webUrl]`
-: URL of the SharePoint site.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-List Microsoft OneNote notebooks for the currently logged in user
-
-```sh
-m365 onenote notebook list
-```
-
-List Microsoft OneNote notebooks in group 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
-
-```sh
-m365 onenote notebook list --groupId 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
-```
-
-List Microsoft OneNote notebooks in group My Group
-
-```sh
-m365 onenote notebook list --groupName "MyGroup"
-```
-
-List Microsoft OneNote notebooks for user user1@contoso.onmicrosoft.com
-
-```sh
-m365 onenote notebook list --userName user1@contoso.onmicrosoft.com
-```
-
-List Microsoft OneNote notebooks for user 2609af39-7775-4f94-a3dc-0dd67657e900
-
-```sh
-m365 onenote notebook list --userId 2609af39-7775-4f94-a3dc-0dd67657e900
-```
-
-List Microsoft OneNote notebooks for site https://contoso.sharepoint.com/sites/testsite
-
-```sh
-m365 onenote notebook list --webUrl https://contoso.sharepoint.com/sites/testsite
-```
-
-## More information
-
-- List notebooks (MS Graph docs): [https://docs.microsoft.com/en-us/graph/api/onenote-list-notebooks?view=graph-rest-1.0&tabs=http](https://docs.microsoft.com/en-us/graph/api/onenote-list-notebooks?view=graph-rest-1.0&tabs=http)