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

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

@@ -0,0 +1,53 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams channel set
+
+Updates properties of the specified channel in the given Microsoft Teams team
+
+## Usage
+
+```sh
+m365 teams channel set [options]
+```
+
+## Options
+
+```md definition-list
+`--teamId [teamId]`
+: The ID of the team where the channel to update is located. Specify either `teamId` or `teamName` but not both.
+
+`--teamName [teamName]`
+: The display name of the team where the channel to update is located. Specify either `teamId` or `teamName` but not both.
+
+`-i, --id [id]`
+: The ID of the channel to update. Specify either `id` or `name` but not both.
+
+`--name [name]`
+: The name of the channel to update. Specify either `id` or `name` but not both.
+
+`--newName [newName]`
+: The new name of the channel.
+
+`--description [description]`
+: The description of the channel.
+```
+
+<Global />
+
+## Examples
+  
+Set new description and display name for the specified channel in the given Microsoft Teams team
+
+```sh
+m365 teams channel set --teamId "00000000-0000-0000-0000-000000000000" --name Reviews --newName Projects --description "Channel for new projects"
+```
+
+Set new display name for the specified channel in the given Microsoft Teams team
+
+```sh
+m365 teams channel set --teamId "00000000-0000-0000-0000-000000000000" --name Reviews --newName Projects
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/chat/chat-get.mdx

@@ -0,0 +1,131 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams chat get
+
+Get a Microsoft Teams chat conversation by id, participants or chat name.
+
+## Usage
+
+```sh
+m365 teams chat get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The ID of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.
+
+`-n, --name [name]`
+: The display name of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.
+
+`-p, --participants [participants]`
+: A comma-separated list of one or more e-mail addresses. Specify either `id`, `name` or `participants`, but not multiple.
+```
+
+<Global />
+
+## Remarks
+
+The output will not include the chat conversation members or messages. It will just retrieve the conversation details.
+When using the `participants` option, the signed-in user will automatically be included as a participant. There's no need to add it to the list manually.
+
+## Examples
+
+Get a Microsoft Teams chat conversation by id
+
+```sh
+m365 teams chat get --id 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```
+
+Get a Microsoft Teams one on one chat conversation, finding it by participant.
+
+```sh
+m365 teams chat get --participants alexw@contoso.com
+```
+
+Get a Microsoft Teams group chat conversation, finding it by participants.
+
+```sh
+m365 teams chat get --participants alexw@contoso.com,meganb@contoso.com
+```
+
+Get a Microsoft Teams chat conversation, finding it by display name
+
+```sh
+m365 teams chat get --name "Just a conversation"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "19:2da4c29f6d7041eca70b638b43d45437@thread.v2",
+    "topic": null,
+    "createdDateTime": "2022-11-05T13:06:25.218Z",
+    "lastUpdatedDateTime": "2022-11-05T13:06:25.218Z",
+    "chatType": "oneOnOne",
+    "webUrl": "https://teams.microsoft.com/l/chat/19%3A2da4c29f6d7041eca70b638b43d45437%40thread.v2/0?tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b",
+    "tenantId": "446355e4-e7e3-43d5-82f8-d7ad8272d55b",
+    "onlineMeetingInfo": null,
+    "viewpoint": {
+      "isHidden": false,
+      "lastMessageReadDateTime": "2022-11-05T13:06:30.582Z"
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  chatType           : oneOnOne
+  createdDateTime    : 2022-11-05T13:06:25.218Z
+  id                 : 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+  lastUpdatedDateTime: 2022-11-05T13:06:25.218Z
+  onlineMeetingInfo  : null
+  tenantId           : 446355e4-e7e3-43d5-82f8-d7ad8272d55b
+  topic              : null
+  viewpoint          : {"isHidden":false,"lastMessageReadDateTime":"2022-11-05T13:06:30.582Z"}
+  webUrl             : https://teams.microsoft.com/l/chat/19%3A2da4c29f6d7041eca70b638b43d45437%40thread.v2/0?tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,topic,createdDateTime,lastUpdatedDateTime,chatType,webUrl,tenantId,onlineMeetingInfo,viewpoint
+  19:2da4c29f6d7041eca70b638b43d45437@thread.v2,,2022-11-05T13:06:25.218Z,2022-11-05T13:06:25.218Z,oneOnOne,https://teams.microsoft.com/l/chat/19%3A2da4c29f6d7041eca70b638b43d45437%40thread.v2/0?tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b,446355e4-e7e3-43d5-82f8-d7ad8272d55b,,"{""isHidden"":false,""lastMessageReadDateTime"":""2022-11-05T13:06:30.582Z""}"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams chat get --name "Just a conversation"
+
+  Date: 5/7/2023
+
+  ## 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+
+  Property | Value
+  ---------|-------
+  id | 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+  topic | Just a conversation
+  createdDateTime | 2022-11-05T13:06:25.218Z
+  lastUpdatedDateTime | 2022-11-05T13:06:25.218Z
+  chatType | group
+  webUrl | https://teams.microsoft.com/l/chat/19%3A2da4c29f6d7041eca70b638b43d45437%40thread.v2/0?tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b
+  tenantId | 446355e4-e7e3-43d5-82f8-d7ad8272d55b
+  onlineMeetingInfo | null
+  viewpoint | {"isHidden":false,"lastMessageReadDateTime":"2022-11-05T13:06:30.582Z"}
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,116 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams chat list
+
+Lists all Microsoft Teams chat conversations for the current or a specific user.
+
+## Usage
+
+```sh
+m365 teams chat list [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --type [type]`
+: The chat type to optionally filter chat conversations by type. The value can be `oneOnOne`, `group` or `meeting`.
+
+`--userId [userId]`
+: ID of the user. Has to be specified when using application permissions. Specify either `userId` or `userName`, but not both.
+
+`--userName [userName]`
+: UPN of the user. Has to be specified when using application permissions. Specify either `userId` or `userName`, but not both.
+```
+
+<Global />
+
+## Examples
+
+List all the Microsoft Teams chat conversations of the current user.
+
+```sh
+m365 teams chat list
+```
+
+List only the one on one Microsoft Teams chat conversations of a specific user retrieved by id.
+
+```sh
+m365 teams chat list --userId e6296ed0-4b7d-4ace-aed4-f6b7371ce060 --type oneOnOne
+```
+
+List only the group Microsoft Teams chat conversations of a specific user retrieved by mail
+
+```sh
+m365 teams chat list --userName 'john@contoso.com' --type group 
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "19:2da4c29f6d7041eca70b638b43d45437@thread.v2",
+      "topic": null,
+      "createdDateTime": "2022-11-05T13:06:25.218Z",
+      "lastUpdatedDateTime": "2022-11-05T13:06:25.218Z",
+      "chatType": "oneOnOne",
+      "webUrl": "https://teams.microsoft.com/l/chat/19%3A2da4c29f6d7041eca70b638b43d45437%40thread.v2/0?tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b",
+      "tenantId": "446355e4-e7e3-43d5-82f8-d7ad8272d55b",
+      "onlineMeetingInfo": null,
+      "viewpoint": {
+        "isHidden": false,
+        "lastMessageReadDateTime": "2022-11-05T13:06:30.582Z"
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                             topic  chatType
+  ---------------------------------------------  -----  --------
+  19:2da4c29f6d7041eca70b638b43d45437@thread.v2  null   oneOnOne
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,topic,chatType
+  19:2da4c29f6d7041eca70b638b43d45437@thread.v2,,oneOnOne
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams chat list --type "group"
+
+  Date: 5/8/2023
+
+  ## 19:b4874b8c8472461d9ac7b033ca782b33@thread.v2
+
+  Property | Value
+  ---------|-------
+  id | 19:b4874b8c8472461d9ac7b033ca782b33@thread.v2
+  topic | Just a conversation
+  createdDateTime | 2021-03-04T18:18:50.303Z
+  lastUpdatedDateTime | 2023-05-07T18:15:20.291Z
+  chatType | group
+  webUrl | https://teams.microsoft.com/l/chat/19%3Ab4874b8c8472461d9ac7b033ca782b33%40thread.v2/0?tenantId=de348bc7-1aeb-4406-8cb3-97db021cadb4
+  tenantId | de348bc7-1aeb-4406-8cb3-97db021cadb4
+  onlineMeetingInfo | null
+  viewpoint | {"isHidden":false,"lastMessageReadDateTime":"2023-05-07T18:15:20.309Z"}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/teams/chat/chat-member-list.mdx

@@ -0,0 +1,93 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams chat member list
+
+Lists all members from a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat member list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --chatId <chatId>`
+: The ID of the chat conversation
+```
+
+<Global />
+
+## Examples
+
+List the members from a Microsoft Teams chat conversation
+
+```sh
+m365 teams chat member list --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "MCMjMCMjMGNhYzZjZGEtMmUwNC00YTNkLTljMTYtOWM5MTQ3MGQ3MDIyIyMxOToyNDFhZGJmNi0yYTU2LTRjNzItODFmMi02OWU3NWRlNmFjMzRfNzhjY2Y1MzAtYmJmMC00N2U0LWFhZTYtZGE1ZjhjNmZiMTQyQHVucS5nYmwuc3BhY2VzIyM3OGNjZjUzMC1iYmYwLTQ3ZTQtYWFlNi1kYTVmOGM2ZmIxNDI=",
+      "roles": [
+        "owner"
+      ],
+      "displayName": "John Doe",
+      "visibleHistoryStartDateTime": "0001-01-01T00:00:00Z",
+      "userId": "78ccf530-bbf0-47e4-aae6-da5f8c6fb142",
+      "email": "johndoe@contoso.onmicrosoft.com",
+      "tenantId": "446355e4-e7e3-43d5-82f8-d7ad8272d55b"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  userId                                displayName     email
+  ------------------------------------  --------------  ---------------------------------
+  78ccf530-bbf0-47e4-aae6-da5f8c6fb142  John Doe        johndoe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  userId,displayName,email
+  78ccf530-bbf0-47e4-aae6-da5f8c6fb142,John Doe,johndoe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams chat member list --chatId "19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces"
+
+  Date: 5/8/2023
+
+  ## John Doe (MCMjMCMjMGNhYzZjZGEtMmUwNC00YTNkLTljMTYtOWM5MTQ3MGQ3MDIyIyMxOToyNDFhZGJmNi0yYTU2LTRjNzItODFmMi02OWU3NWRlNmFjMzRfNzhjY2Y1MzAtYmJmMC00N2U0LWFhZTYtZGE1ZjhjNmZiMTQyQHVucS5nYmwuc3BhY2VzIyM3OGNjZjUzMC1iYmYwLTQ3ZTQtYWFlNi1kYTVmOGM2ZmIxNDI=)
+
+  Property | Value
+  ---------|-------
+  id | MCMjMCMjMGNhYzZjZGEtMmUwNC00YTNkLTljMTYtOWM5MTQ3MGQ3MDIyIyMxOToyNDFhZGJmNi0yYTU2LTRjNzItODFmMi02OWU3NWRlNmFjMzRfNzhjY2Y1MzAtYmJmMC00N2U0LWFhZTYtZGE1ZjhjNmZiMTQyQHVucS5nYmwuc3BhY2VzIyM3OGNjZjUzMC1iYmYwLTQ3ZTQtYWFlNi1kYTVmOGM2ZmIxNDI=
+  roles | ["owner"]
+  displayName | John Doe
+  visibleHistoryStartDateTime | 0001-01-01T00:00:00Z
+  userId | 78ccf530-bbf0-47e4-aae6-da5f8c6fb142
+  email | johndoe@contoso.onmicrosoft.com
+  tenantId | 446355e4-e7e3-43d5-82f8-d7ad8272d55b
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/teams/chat/chat-member-remove.mdx

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams chat member remove
+
+Removes a member from a Microsoft Teams chat conversation
+
+## Usage
+
+```sh
+m365 teams chat member remove [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --chatId <chatId>`
+: The ID of the chat conversation.
+
+`--id [id]`
+: The ID of the chat member. Specify either `id`, `userId`, or `userName` but not multiple.
+
+`--userId [userId]`
+: The Azure AD ID of the user. Specify either `id`, `userId`, or `userName` but not multiple.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Specify either `id`, `userId`, or `userName` but not multiple.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Remove a member from a Teams chat by its member ID without prompting for confirmation.
+
+```sh
+m365 teams chat member remove --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces --id MCMjMjQzMmI1N2ItMGFiZC00M2RiLWFhN2ItMTZlYWRkMTE1ZDM0IyMxOTpiZDlkYTQ2MzIzYWY0MjUzOTZkMGZhNjcyMDAyODk4NEB0aHJlYWQudjIjIzQ4YmY5ZDUyLWRjYTctNGE1Zi04Mzk4LTM3Yjk1Y2M3YmQ4Mw== --confirm
+```
+
+Remove a member from a Teams chat by its Azure AD ID.
+
+```sh
+m365 teams chat member remove --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces --userId bd94e214-7852-48b0-a326-5a34b2a02183
+```
+
+Remove a member from a Teams chat by its Azure AD UPN.
+
+```sh
+m365 teams chat member remove --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces --userName john.doe@contoso.com
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/chat/chat-message-list.mdx

@@ -0,0 +1,121 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams chat message list
+
+Lists all messages from a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat message list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --chatId <chatId>`
+: The ID of the chat conversation
+```
+
+<Global />
+
+## Examples
+
+List the messages from a Microsoft Teams chat conversation
+
+```sh
+m365 teams chat message list --chatId 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "1667653590582",
+      "replyToId": null,
+      "etag": "1667653590582",
+      "messageType": "message",
+      "createdDateTime": "2022-11-05T13:06:30.582Z",
+      "lastModifiedDateTime": "2022-11-05T13:06:30.582Z",
+      "lastEditedDateTime": null,
+      "deletedDateTime": null,
+      "subject": null,
+      "summary": null,
+      "chatId": "19:2da4c29f6d7041eca70b638b43d45437@thread.v2",
+      "importance": "normal",
+      "locale": "en-us",
+      "webUrl": null,
+      "channelIdentity": null,
+      "policyViolation": null,
+      "eventDetail": null,
+      "from": {
+        "application": null,
+        "device": null,
+        "user": {
+          "id": "78ccf530-bbf0-47e4-aae6-da5f8c6fb142",
+          "displayName": "John Doe",
+          "userIdentityType": "aadUser",
+          "tenantId": "446355e4-e7e3-43d5-82f8-d7ad8272d55b"
+        }
+      },
+      "body": {
+        "contentType": "html",
+        "content": "<p>Hello world</p>"
+      },
+      "attachments": [],
+      "mentions": [],
+      "reactions": []
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id             shortBody
+  -------------  -------------------------
+  1667653590582  <p>Hello world</p>
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,shortBody
+  1667653590582,<p>Hello world</p>
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams chat message list --chatId "19:04355ecd-2124-4097-bc2b-c2295a71d7a3_e1251b10-1ba4-49e3-b35a-933e3f21772b@unq.gbl.spaces"
+
+  Date: 5/8/2023
+
+  ## 1662642685689
+
+  Property | Value
+  ---------|-------
+  id | 1662642685689
+  etag | 1667653590582
+  messageType | message
+  createdDateTime | 2022-11-05T13:06:30.582Z
+  lastModifiedDateTime | 2022-11-05T13:06:30.582Z
+  chatId | 19:04355ecd-2124-4097-bc2b-c2295a71d7a3_e1251b10-1ba4-49e3-b35a-933e3f21772b@unq.gbl.spaces
+  importance | normal
+  locale | en-us
+  body | <p>Hello world</p>
+  shortBody | <p>Hello world</p>
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/teams/chat/chat-message-send.mdx

@@ -0,0 +1,63 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# teams chat message send
+
+Sends a chat message to a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat message send [options]
+```
+
+## Options
+
+```md definition-list
+`--chatId [chatId]`
+: The ID of the chat conversation. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`--chatName [chatName]`
+: The display name of the chat conversation. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`-e, --userEmails [userEmails]`
+: A comma-separated list of one or more e-mail addresses. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`-m, --message <message>`
+: The message to send
+```
+
+<Global />
+
+## Remarks
+
+A new chat conversation will be created if no existing conversation with the participants specified with emails is found.
+
+## Examples
+
+Send a message to a Microsoft Teams chat conversation by id
+
+```sh
+m365 teams chat message send --chatId 19:2da4c29f6d7041eca70b638b43d45437@thread.v2 --message "Welcome to Teams"
+```
+
+Send a message to a single person
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com --message "Welcome to Teams"
+```
+
+Send a message to a group of people
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com,meganb@contoso.com --message "Welcome to Teams"
+```
+
+Send a message to a chat conversation finding it by display name
+
+```sh
+m365 teams chat message send --chatName "Just a conversation" --message "Welcome to Teams"
+```
+
+## Response
+
+The command won't return a response on success.