@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.f0e1354

package/docs/docs/cmd/status.mdx

@@ -0,0 +1,83 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# status
+
+Shows Microsoft 365 login status
+
+## Usage
+
+```sh
+m365 status [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+If you are logged in to Microsoft 365, the `status` command will show you information about the user or application name used to sign in and the details about the stored refresh and access tokens and their expiration date and time when run in debug mode.
+
+## Examples
+
+Show the information about the current login to the Microsoft 365
+
+```sh
+m365 status
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "connectedAs": "john.doe@contoso.onmicrosoft.com",
+    "authType": "DeviceCode",
+    "appId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
+    "appTenant": "common"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  appId      : 31359c7f-bd7e-475c-86db-fdb8c937548e
+  appTenant  : common
+  authType   : DeviceCode
+  connectedAs: john.doe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  connectedAs,authType,appId,appTenant
+  john.doe@contoso.onmicrosoft.com,DeviceCode,31359c7f-bd7e-475c-86db-fdb8c937548e,common
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # status
+
+  Date: 7/2/2023
+
+
+
+  Property | Value
+  ---------|-------
+  connectedAs | john.doe@contoso.onmicrosoft.com
+  authType | DeviceCode
+  appId | 31359c7f-bd7e-475c-86db-fdb8c937548e
+  appTenant | common
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/teams/app/app-install.mdx

@@ -0,0 +1,57 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams app install
+
+Installs a Microsoft Teams team app from the catalog in the specified team or for the specified user
+
+## Usage
+
+```sh
+m365 teams app install [options]
+```
+
+## Options
+
+```md defintion-list
+`--id <id>`
+: The ID of the app to install
+
+`--teamId [teamId]`
+: The ID of the Microsoft Teams team to which to install the app
+
+`--userId [userId]`
+: The ID of the user for who to install the app. Specify either `userId` or `userName` to install a personal app for a user.
+
+`--userName [userName]`
+: The UPN of the user for who to install the app. Specify either `userId` or `userName` to install a personal app for a user.
+```
+
+<Global />
+
+## Remarks
+
+The `id` has to be the ID of the app from the Microsoft Teams App Catalog. Do not use the ID from the manifest of the zip app package. Use the [teams app list](./app-list.mdx) command to get this ID instead.
+
+## Examples
+
+Install an app from the catalog in a Microsoft Teams team
+
+```sh
+m365 teams app install --id 4440558e-8c73-4597-abc7-3644a64c4bce --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
+```
+
+Install a personal app for the user specified using their user name
+
+```sh
+m365 teams app install --id 4440558e-8c73-4597-abc7-3644a64c4bce --userName steve@contoso.com
+```
+
+Install a personal app for the user specified using their ID
+
+```sh
+m365 teams app install --id 4440558e-8c73-4597-abc7-3644a64c4bce --userId 2609af39-7775-4f94-a3dc-0dd67657e900
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/app/app-list.mdx

@@ -0,0 +1,91 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams app list
+
+Lists apps from the Microsoft Teams app catalog
+
+## Usage
+
+```sh
+m365 teams app list [options]
+```
+
+## Options
+
+```md defintion-list
+`--distributionMethod [distributionMethod]`
+: The distribution method. Allowed values `store`, `organization`, `sideloaded`.
+```
+
+<Global />
+
+## Examples
+
+List all apps from the Microsoft Teams app catalog
+
+```sh
+m365 teams app list
+```
+
+List all apps from the Microsoft Teams app catalog according to a given distribution method
+
+```sh
+m365 teams app list --distributionMethod 'store'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "ffdb7239-3b58-46ba-b108-7f90a6d8799b",
+      "externalId": null,
+      "displayName": "Contoso App",
+      "distributionMethod": "store"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                                        displayName                       distributionMethod
+  --------------------------------------------------------  --------------------------------  ------------------
+  ffdb7239-3b58-46ba-b108-7f90a6d8799b                      Contoso App                       store
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName,distributionMethod
+  ffdb7239-3b58-46ba-b108-7f90a6d8799b,Contoso App,store
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams app list
+
+  Date: 4/3/2023
+
+  ## Contoso App (ffdb7239-3b58-46ba-b108-7f90a6d8799b)
+
+  Property | Value
+  ---------|-------
+  id | ffdb7239-3b58-46ba-b108-7f90a6d8799b
+  externalId | null
+  displayName | Contoso App
+  distributionMethod | store
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/teams/app/app-publish.mdx

@@ -0,0 +1,92 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams app publish
+
+Publishes Teams app to the organization's app catalog
+
+## Usage
+
+```sh
+m365 teams app publish [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --filePath <filePath>`
+: Absolute or relative path to the Teams manifest zip file to add to the app catalog.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global administrator.
+
+:::
+
+## Examples
+
+Add the _teams-manifest.zip_ file to the organization's app catalog
+
+```sh
+m365 teams app publish --filePath ./teams-manifest.zip
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+      "id": "e3e29acb-8c79-412b-b746-e6c39ff4cd22",
+      "externalId": "b5561ec9-8cab-4aa3-8aa2-d8d7172e4311",
+      "displayName": "Test App",
+      "distributionMethod": "organization"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  displayName       : Test App
+  distributionMethod: organization
+  externalId        : b5561ec9-8cab-4aa3-8aa2-d8d7172e4311
+  id                : e3e29acb-8c79-412b-b746-e6c39ff4cd22
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,externalId,displayName,distributionMethod
+  e3e29acb-8c79-412b-b746-e6c39ff4cd22,b5561ec9-8cab-4aa3-8aa2-d8d7172e4311,Test App,organization
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams app publish
+
+  Date: 4/3/2023
+
+  ## Test App (e3e29acb-8c79-412b-b746-e6c39ff4cd22)
+
+  Property | Value
+  ---------|-------
+  id | e3e29acb-8c79-412b-b746-e6c39ff4cd22
+  externalId | b5561ec9-8cab-4aa3-8aa2-d8d7172e4311
+  displayName | Test App
+  distributionMethod | organization
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/teams/app/app-remove.mdx

@@ -0,0 +1,45 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams app remove
+
+Removes a Teams app from the organization's app catalog
+
+## Usage
+
+```sh
+m365 teams app remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: ID of the Teams app to remove. Needs to be available in your organization\'s app catalog.
+
+`--confirm`
+: Don't prompt for confirming removing the app
+```
+
+<Global />
+
+### Remarks
+
+You can only remove a Teams app as a global administrator.
+
+## Examples
+
+Remove the Teams app with ID _83cece1e-938d-44a1-8b86-918cf6151957_ from the organization's app catalog. Will prompt for confirmation before actually removing the app.
+
+```sh
+m365 teams app remove --id 83cece1e-938d-44a1-8b86-918cf6151957
+```
+
+Remove the Teams app with ID _83cece1e-938d-44a1-8b86-918cf6151957_ from the organization's app catalog. Don't prompt for confirmation.
+
+```sh
+m365 teams app remove --id 83cece1e-938d-44a1-8b86-918cf6151957 --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/app/app-uninstall.mdx

@@ -0,0 +1,43 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams app uninstall
+
+Uninstalls an app from a Microsoft Team team
+
+## Usage
+
+```sh
+m365 teams app uninstall [options]
+```
+
+## Options
+
+```md defintion-list
+`--id <id>`
+: The unique id of the app instance installed in the Microsoft Teams team
+
+`--teamId <teamId>`
+: The ID of the Microsoft Teams team from which to uninstall the app
+
+`--confirm`
+: Don't prompt for confirmation when uninstalling the app
+```
+
+<Global />
+
+## Remarks
+
+The `id` has to be the id the app instance installed in the Microsoft Teams team.
+Do not use the ID from the manifest of the zip app package or the id from the Microsoft Teams App Catalog.
+
+## Examples
+
+Uninstall an app from a Microsoft Teams team
+
+```sh
+m365 teams app uninstall --id YzUyN2E0NzAtYTg4Mi00ODFjLTk4MWMtZWU2ZWZhYmE4NWM3IyM0ZDFlYTA0Ny1mMTk2LTQ1MGQtYjJlOS0wZDI4NTViYTA1YTY= --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/app/app-update.mdx

@@ -0,0 +1,48 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams app update
+
+Updates Teams app in the organization's app catalog
+
+## Usage
+
+```sh
+m365 teams app update [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id [id]`
+: ID of the app to update. Specify either id or name, but not both
+
+`-n, --name [name]`
+: The display name of the app to update. Specify either id or name, but not both
+
+`-p, --filePath <filePath>`
+: Absolute or relative path to the Teams manifest zip file to update in the app catalog
+```
+
+<Global />
+
+## Remarks
+
+You can only update a Teams app as a global administrator.
+
+## Examples
+
+Update the Teams app with ID _83cece1e-938d-44a1-8b86-918cf6151957_ from file _teams-manifest.zip_
+
+```sh
+m365 teams app update --id 83cece1e-938d-44a1-8b86-918cf6151957 --filePath ./teams-manifest.zip
+```
+
+Update the Teams app with name _Test app_ from file _teams-manifest.zip_
+
+```sh
+m365 teams app update --name "Test app" --filePath ./teams-manifest.zip
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/cache/cache-remove.mdx

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams cache remove
+
+Removes the Microsoft Teams client cache
+
+## Usage
+
+```sh
+m365 teams cache remove [options]
+```
+
+## Options
+
+```md defintion-list
+`--confirm`
+: Don't prompt for confirmation
+```
+
+<Global />
+
+## Remarks
+
+This command will execute the following steps.
+
+- Stop the Microsoft Teams client. This will kill all the running `Teams.exe` tasks.
+
+- Clear the Microsoft Teams cached files. For Windows it will delete all files and folders in the %appdata%\Microsoft\Teams directory. For macOS it will delete all files and folders in the  ~/Library/Application Support/Microsoft/Teams directory.
+
+:::info
+
+- You won't lose any user data by clearing the cache.
+
+- Restarting Teams after you clear the cache might take longer than usual because the Teams cache files have to be rebuilt.
+
+:::
+
+If you run the command in the CLI Docker container, you will get the following error message:
+
+> Because you're running CLI for Microsoft 365 in a Docker container, we can't clear the cache on your host. Instead run this command on your host using 'npx ...'.
+
+The command works only on Windows and macOS. If you run it on a different operating system, you will get the `'abc' platform is unsupported for this command` error.
+
+## Examples
+
+Removes the Microsoft Teams client cache
+
+```sh
+m365 teams cache remove
+```
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+- [Clear the Teams client cache guidance](https://docs.microsoft.com/microsoftteams/troubleshoot/teams-administration/clear-teams-cache)

package/docs/docs/cmd/teams/channel/channel-add.mdx

@@ -0,0 +1,132 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams channel add
+
+Adds a channel to the specified Microsoft Teams team
+
+## Usage
+
+```sh
+m365 teams channel add [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --teamId [teamId]`
+: The ID of the team to add the channel to. Specify either `teamId` or `teamName` but not both
+
+`--teamName [teamName]`
+: The display name of the team to add the channel to. Specify either `teamId` or `teamName` but not both
+
+`-n, --name <name>`
+: The name of the channel to add
+
+`-d, --description [description]`
+: The description of the channel to add
+
+`--type [type]`
+: Type of channel to create: `standard`, `private`, `shared`. Default `standard`.
+
+`--owner [owner]`
+: User with this ID or UPN will be added as owner of the channel. This option is required when type is `private` or `shared`.
+```
+
+<Global />
+
+## Remarks
+
+You can only add a channel to the Microsoft Teams team you are a member of.
+
+## Examples
+
+Add channel to the specified Microsoft Teams team with id 6703ac8a-c49b-4fd4-8223-28f0ac3a6402
+
+```sh
+m365 teams channel add --teamId 6703ac8a-c49b-4fd4-8223-28f0ac3a6402 --name climicrosoft365 --description development
+```
+
+Add channel to the specified Microsoft Teams team with name _Team Name_
+
+```sh
+m365 teams channel add --teamName "Team Name" --name climicrosoft365 --description development
+```
+
+Add private channel to the specified Microsoft Teams team with owner UPN
+
+```sh
+m365 teams channel add --teamName "Team Name" --name climicrosoft365 --type private --owner john.doe@contoso.com
+```
+
+Add shared channel to the specified Microsoft Teams team with owner ID
+
+```sh
+m365 teams channel add --teamId 6703ac8a-c49b-4fd4-8223-28f0ac3a6402 --name climicrosoft365 --type shared --owner cc693a7d-4833-4911-a89a-f0fe6e49bf69
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "19:591922f67c4341eeb15e49c791822bfe@thread.tacv2",
+    "createdDateTime": "2022-11-05T10:02:44.3930065Z",
+    "displayName": "climicrosoft365",
+    "description": null,
+    "isFavoriteByDefault": false,
+    "email": "",
+    "webUrl": "https://teams.microsoft.com/l/channel/19%3a591922f67c4341eeb15e49c791822bfe%40thread.tacv2/climicrosoft365?groupId=6703ac8a-c49b-4fd4-8223-28f0ac3a6402&tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b",
+    "membershipType": "standard"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdDateTime    : 2022-11-05T10:05:31.3998293Z
+  description        : null
+  displayName        : climicrosoft365
+  email              :
+  id                 : 19:591922f67c4341eeb15e49c791822bfe@thread.tacv2
+  isFavoriteByDefault: false
+  membershipType     : standard
+  webUrl             : https://teams.microsoft.com/l/channel/19%3a591922f67c4341eeb15e49c791822bfe%40thread.tacv2/climicrosoft365?groupId=6703ac8a-c49b-4fd4-8223-28f0ac3a6402&tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,createdDateTime,displayName,description,isFavoriteByDefault,email,webUrl,membershipType
+  19:591922f67c4341eeb15e49c791822bfe@thread.tacv2,2022-11-05T12:34:59.6583728Z,climicrosoft365,,,,https://teams.microsoft.com/l/channel/19%3a591922f67c4341eeb15e49c791822bfe%40thread.tacv2/climicrosoft365?groupId=6703ac8a-c49b-4fd4-8223-28f0ac3a6402&tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b,standard
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams channel add --teamName "Team Name" --name "climicrosoft365" --description "development"
+
+  Date: 5/12/2023
+
+  ## climicrosoft365 (19:591922f67c4341eeb15e49c791822bfe@thread.tacv2)
+
+  Property | Value
+  ---------|-------
+  id | 19:591922f67c4341eeb15e49c791822bfe@thread.tacv2
+  createdDateTime | 2022-11-05T10:02:44.3930065Z
+  displayName | climicrosoft365
+  isFavoriteByDefault | false
+  email |
+  webUrl | https://teams.microsoft.com/l/channel/19%3a591922f67c4341eeb15e49c791822bfe%40thread.tacv2/climicrosoft365?groupId=6703ac8a-c49b-4fd4-8223-28f0ac3a6402&tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b
+  membershipType | standard
+  ```
+
+  </TabItem>
+</Tabs>
+