@pnp/cli-microsoft365 10.1.0-beta.f17d225 → 10.2.0-beta.382f561

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/.eslintrc.cjs +2 -0
  2. package/README.md +2 -2
  3. package/allCommands.json +1 -1
  4. package/allCommandsFull.json +1 -1
  5. package/dist/AuthServer.js +1 -1
  6. package/dist/Command.js +2 -2
  7. package/dist/cli/cli.js +2 -2
  8. package/dist/m365/base/AppCommand.js +5 -2
  9. package/dist/m365/commands/login.js +3 -2
  10. package/dist/m365/entra/commands/administrativeunit/administrativeunit-get.js +18 -4
  11. package/dist/m365/entra/commands/administrativeunit/administrativeunit-list.js +34 -2
  12. package/dist/m365/entra/commands/app/app-get.js +17 -5
  13. package/dist/m365/entra/commands/app/app-list.js +34 -2
  14. package/dist/m365/entra/commands/app/app-permission-remove.js +8 -1
  15. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +3 -0
  16. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +3 -0
  17. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +3 -0
  18. package/dist/m365/entra/commands/group/group-get.js +6 -3
  19. package/dist/m365/entra/commands/group/group-list.js +16 -1
  20. package/dist/m365/entra/commands/m365group/m365group-add.js +1 -1
  21. package/dist/m365/entra/commands/m365group/m365group-conversation-list.js +21 -6
  22. package/dist/m365/entra/commands/m365group/m365group-get.js +29 -7
  23. package/dist/m365/entra/commands/m365group/m365group-list.js +1 -1
  24. package/dist/m365/entra/commands/m365group/m365group-remove.js +21 -9
  25. package/dist/m365/entra/commands/m365group/m365group-renew.js +19 -7
  26. package/dist/m365/entra/commands/m365group/m365group-set.js +1 -1
  27. package/dist/m365/entra/commands/m365group/m365group-teamify.js +12 -21
  28. package/dist/m365/entra/commands/roledefinition/roledefinition-get.js +58 -0
  29. package/dist/m365/entra/commands/roledefinition/roledefinition-list.js +50 -0
  30. package/dist/m365/entra/commands/roledefinition/roledefinition-remove.js +74 -0
  31. package/dist/m365/entra/commands.js +3 -0
  32. package/dist/m365/file/commands/convert/convert-pdf.js +3 -4
  33. package/dist/m365/file/commands/file-add.js +5 -6
  34. package/dist/m365/graph/commands/subscription/subscription-add.js +46 -5
  35. package/dist/m365/pp/commands/{chatbot/chatbot-get.js → copilot/copilot-get.js} +24 -20
  36. package/dist/m365/pp/commands/{chatbot/chatbot-list.js → copilot/copilot-list.js} +16 -12
  37. package/dist/m365/pp/commands/{chatbot/chatbot-remove.js → copilot/copilot-remove.js} +28 -24
  38. package/dist/m365/pp/commands.js +3 -0
  39. package/dist/m365/spe/ContainerProperties.js +2 -0
  40. package/dist/m365/spe/commands/container/container-list.js +87 -0
  41. package/dist/m365/spe/commands/containertype/containertype-get.js +103 -0
  42. package/dist/m365/spe/commands/containertype/containertype-list.js +2 -22
  43. package/dist/m365/spe/commands.js +2 -0
  44. package/dist/m365/spfx/commands/package/package-generate.js +1 -1
  45. package/dist/m365/spfx/commands/project/JsonRule.js +2 -2
  46. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN016004_TS_property_pane_property_import.js +2 -2
  47. package/dist/m365/spfx/commands/spfx-doctor.js +1 -1
  48. package/dist/m365/spo/commands/contenttype/contenttype-get.js +2 -2
  49. package/dist/m365/spo/commands/contenttype/contenttype-list.js +6 -3
  50. package/dist/m365/spo/commands/file/file-add.js +1 -1
  51. package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +1 -2
  52. package/dist/m365/spo/commands/file/file-retentionlabel-remove.js +1 -2
  53. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -2
  54. package/dist/m365/spo/commands/folder/folder-retentionlabel-remove.js +1 -2
  55. package/dist/m365/spo/commands/list/list-contenttype-list.js +5 -2
  56. package/dist/m365/spo/commands/listitem/listitem-batch-remove.js +10 -8
  57. package/dist/m365/spo/commands/listitem/listitem-batch-set.js +1 -1
  58. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +1 -2
  59. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +1 -2
  60. package/dist/m365/spo/commands/page/page-add.js +1 -1
  61. package/dist/m365/spo/commands/site/site-admin-add.js +4 -12
  62. package/dist/m365/spo/commands/site/site-admin-list.js +3 -11
  63. package/dist/m365/spo/commands/site/site-admin-remove.js +4 -12
  64. package/dist/m365/spo/commands/site/site-set.js +1 -1
  65. package/dist/m365/spp/commands/model/model-remove.js +105 -0
  66. package/dist/m365/spp/commands.js +2 -1
  67. package/dist/m365/teams/commands/user/user-app-list.js +1 -1
  68. package/dist/m365/tenant/commands/people/people-pronouns-get.js +32 -0
  69. package/dist/m365/tenant/commands/report/report-office365activationcounts.js +2 -8
  70. package/dist/m365/tenant/commands/report/report-office365activationsusercounts.js +2 -8
  71. package/dist/m365/tenant/commands/report/report-office365activationsuserdetail.js +2 -8
  72. package/dist/m365/tenant/commands.js +1 -0
  73. package/dist/m365/todo/commands/list/list-remove.js +2 -1
  74. package/dist/m365/todo/commands/list/list-set.js +2 -1
  75. package/dist/m365/todo/commands/task/task-add.js +2 -1
  76. package/dist/m365/todo/commands/task/task-get.js +2 -1
  77. package/dist/m365/todo/commands/task/task-list.js +2 -1
  78. package/dist/m365/todo/commands/task/task-remove.js +2 -1
  79. package/dist/m365/todo/commands/task/task-set.js +1 -1
  80. package/dist/m365/viva/commands/engage/engage-community-set.js +111 -0
  81. package/dist/m365/viva/commands.js +1 -0
  82. package/dist/utils/entraAdministrativeUnit.js +14 -2
  83. package/dist/utils/entraGroup.js +49 -6
  84. package/dist/utils/formatting.js +8 -20
  85. package/dist/utils/roleDefinition.js +30 -3
  86. package/dist/utils/spo.js +23 -4
  87. package/dist/utils/spp.js +3 -3
  88. package/dist/utils/urlUtil.js +11 -14
  89. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-get.mdx +10 -3
  90. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-list.mdx +16 -1
  91. package/docs/docs/cmd/entra/app/app-get.mdx +13 -8
  92. package/docs/docs/cmd/entra/app/app-list.mdx +16 -1
  93. package/docs/docs/cmd/entra/group/group-get.mdx +10 -3
  94. package/docs/docs/cmd/entra/group/group-list.mdx +9 -2
  95. package/docs/docs/cmd/entra/m365group/m365group-conversation-list.mdx +12 -3
  96. package/docs/docs/cmd/entra/m365group/m365group-get.mdx +29 -5
  97. package/docs/docs/cmd/entra/m365group/m365group-remove.mdx +7 -4
  98. package/docs/docs/cmd/entra/m365group/m365group-renew.mdx +11 -2
  99. package/docs/docs/cmd/entra/m365group/m365group-teamify.mdx +12 -3
  100. package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +2 -2
  101. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +6 -0
  102. package/docs/docs/cmd/entra/m365group/m365group-user-remove.mdx +1 -1
  103. package/docs/docs/cmd/entra/m365group/m365group-user-set.mdx +3 -3
  104. package/docs/docs/cmd/entra/roledefinition/roledefinition-get.mdx +150 -0
  105. package/docs/docs/cmd/entra/roledefinition/roledefinition-list.mdx +148 -0
  106. package/docs/docs/cmd/entra/roledefinition/roledefinition-remove.mdx +52 -0
  107. package/docs/docs/cmd/graph/subscription/subscription-add.mdx +30 -5
  108. package/docs/docs/cmd/login.mdx +45 -44
  109. package/docs/docs/cmd/pp/{chatbot/chatbot-get.mdx → copilot/copilot-get.mdx} +24 -18
  110. package/docs/docs/cmd/pp/{chatbot/chatbot-list.mdx → copilot/copilot-list.mdx} +20 -14
  111. package/docs/docs/cmd/pp/{chatbot/chatbot-remove.mdx → copilot/copilot-remove.mdx} +16 -10
  112. package/docs/docs/cmd/pp/managementapp/managementapp-add.mdx +1 -1
  113. package/docs/docs/cmd/spe/container/container-list.mdx +97 -0
  114. package/docs/docs/cmd/spe/containertype/containertype-get.mdx +114 -0
  115. package/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +7 -1
  116. package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +7 -1
  117. package/docs/docs/cmd/spo/list/list-contenttype-list.mdx +7 -1
  118. package/docs/docs/cmd/spp/model/model-remove.mdx +57 -0
  119. package/docs/docs/cmd/tenant/people/people-pronouns-get.mdx +71 -0
  120. package/docs/docs/cmd/viva/engage/engage-community-set.mdx +61 -0
  121. package/npm-shrinkwrap.json +8 -2
  122. package/package.json +4 -2
  123. package/dist/m365/spe/ContainerTypeProperties.js +0 -2
@@ -0,0 +1,148 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # entra roledefinition list
6
+
7
+ Lists all Microsoft Entra ID role definitions.
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 entra roledefinition list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-p, --properties [properties]`
19
+ : Comma-separated list of properties to retrieve.
20
+
21
+ `-f, --filter [filter]`
22
+ : OData filter to apply when retrieving the role definitions.
23
+ ```
24
+
25
+ <Global />
26
+
27
+ ## Examples
28
+
29
+ Retrieve all Microsoft Entra ID role definitions
30
+
31
+ ```sh
32
+ m365 entra roledefinition list
33
+ ```
34
+
35
+ Retrieve only the names of the role definitions
36
+
37
+ ```sh
38
+ m365 entra roledefinition list --properties 'displayName'
39
+ ```
40
+
41
+ Retrieve only custom role definitions
42
+
43
+ ```sh
44
+ m365 entra roledefinition list --filter 'isBuiltIn eq false'
45
+ ```
46
+
47
+ ## Response
48
+
49
+ ### Standard response
50
+
51
+ <Tabs>
52
+ <TabItem value="JSON">
53
+
54
+ ```json
55
+ [
56
+ {
57
+ "id": "f28a1f50-f6e7-4571-818b-6a12f2af6b6c",
58
+ "description": "Can manage all aspects of the SharePoint service.",
59
+ "displayName": "SharePoint Administrator",
60
+ "isBuiltIn": true,
61
+ "isEnabled": true,
62
+ "resourceScopes": [
63
+ "/"
64
+ ],
65
+ "templateId": "f28a1f50-f6e7-4571-818b-6a12f2af6b6c",
66
+ "version": "1",
67
+ "rolePermissions": [
68
+ {
69
+ "allowedResourceActions": [
70
+ "microsoft.azure.serviceHealth/allEntities/allTasks",
71
+ "microsoft.azure.supportTickets/allEntities/allTasks",
72
+ "microsoft.backup/oneDriveForBusinessProtectionPolicies/allProperties/allTasks",
73
+ "microsoft.backup/oneDriveForBusinessRestoreSessions/allProperties/allTasks",
74
+ "microsoft.backup/restorePoints/sites/allProperties/allTasks",
75
+ "microsoft.backup/restorePoints/userDrives/allProperties/allTasks",
76
+ "microsoft.backup/sharePointProtectionPolicies/allProperties/allTasks",
77
+ "microsoft.backup/sharePointRestoreSessions/allProperties/allTasks",
78
+ "microsoft.backup/siteProtectionUnits/allProperties/allTasks",
79
+ "microsoft.backup/siteRestoreArtifacts/allProperties/allTasks",
80
+ "microsoft.backup/userDriveProtectionUnits/allProperties/allTasks",
81
+ "microsoft.backup/userDriveRestoreArtifacts/allProperties/allTasks",
82
+ "microsoft.directory/groups/hiddenMembers/read",
83
+ "microsoft.directory/groups.unified/basic/update",
84
+ "microsoft.directory/groups.unified/create",
85
+ "microsoft.directory/groups.unified/delete",
86
+ "microsoft.directory/groups.unified/members/update",
87
+ "microsoft.directory/groups.unified/owners/update",
88
+ "microsoft.directory/groups.unified/restore",
89
+ "microsoft.office365.migrations/allEntities/allProperties/allTasks",
90
+ "microsoft.office365.network/performance/allProperties/read",
91
+ "microsoft.office365.serviceHealth/allEntities/allTasks",
92
+ "microsoft.office365.sharePoint/allEntities/allTasks",
93
+ "microsoft.office365.supportTickets/allEntities/allTasks",
94
+ "microsoft.office365.usageReports/allEntities/allProperties/read",
95
+ "microsoft.office365.webPortal/allEntities/standard/read"
96
+ ],
97
+ "condition": null
98
+ }
99
+ ],
100
+ "inheritsPermissionsFrom": [
101
+ {
102
+ "id": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
103
+ }
104
+ ]
105
+ }
106
+ ]
107
+ ```
108
+
109
+ </TabItem>
110
+ <TabItem value="Text">
111
+
112
+ ```text
113
+ id displayName isBuiltIn isEnabled
114
+ ------------------------------------ --------------------------------------------- --------- ---------
115
+ f28a1f50-f6e7-4571-818b-6a12f2af6b6c SharePoint Administrator true true
116
+ ```
117
+
118
+ </TabItem>
119
+ <TabItem value="CSV">
120
+
121
+ ```csv
122
+ id,description,displayName,isBuiltIn,isEnabled,templateId,version
123
+ f28a1f50-f6e7-4571-818b-6a12f2af6b6c,Can manage all aspects of the SharePoint service.,SharePoint Administrator,1,1,f28a1f50-f6e7-4571-818b-6a12f2af6b6c,1
124
+ ```
125
+
126
+ </TabItem>
127
+ <TabItem value="Markdown">
128
+
129
+ ```md
130
+ # entra roledefinition list
131
+
132
+ Date: 11/7/2024
133
+
134
+ ## SharePoint Administrator (f28a1f50-f6e7-4571-818b-6a12f2af6b6c)
135
+
136
+ Property | Value
137
+ ---------|-------
138
+ id | f28a1f50-f6e7-4571-818b-6a12f2af6b6c
139
+ description | Can manage all aspects of the SharePoint service.
140
+ displayName | SharePoint Administrator
141
+ isBuiltIn | true
142
+ isEnabled | true
143
+ templateId | f28a1f50-f6e7-4571-818b-6a12f2af6b6c
144
+ version | 1
145
+ ```
146
+
147
+ </TabItem>
148
+ </Tabs>
@@ -0,0 +1,52 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # entra roledefinition remove
4
+
5
+ Removes a custom Microsoft Entra role definition
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 entra roledefinition remove [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-i, --id [id]`
17
+ : The id of the role definition. Specify either `id` or `displayName`, but not both.
18
+
19
+ `-n, --displayName [displayName]`
20
+ : The name of the role definition. Specify either `id` or `displayName`, but not both.
21
+
22
+ `-f, --force`
23
+ : Don't prompt for confirmation.
24
+ ```
25
+
26
+ <Global />
27
+
28
+ ## Remarks
29
+
30
+ :::info
31
+
32
+ When the role definition is removed, all the associated role assignments are deleted.
33
+
34
+ :::
35
+
36
+ ## Examples
37
+
38
+ Remove a role definition specified by id without prompting
39
+
40
+ ```sh
41
+ m365 entra roledefinition remove --id 0bed8b86-5026-4a93-ac7d-56750cc099f1 --force
42
+ ```
43
+
44
+ Remove a role definition specified by name and prompt for confirmation
45
+
46
+ ```sh
47
+ m365 entra roledefinition remove --displayName 'Custom Role'
48
+ ```
49
+
50
+ ## Response
51
+
52
+ The command won't return a response on success
@@ -29,6 +29,24 @@ m365 graph subscription add [options]
29
29
 
30
30
  `-s, --clientState [clientState]`
31
31
  : The value of the clientState property sent by the service in each notification. The maximum length is 128 characters.
32
+
33
+ `--lifecycleNotificationUrl [lifecycleNotificationUrl]`
34
+ : The URL of the endpoint that will receive the lifecycle notifications. This URL must use the HTTPS protocol.
35
+
36
+ `--notificationUrlAppId [notificationUrlAppId]`
37
+ : The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.
38
+
39
+ `--latestTLSVersion [latestTLSVersion]`
40
+ : The latest version of TLS that the notification endpoint supports. Allowed values are `v1_0`, `v1_1`, `v1_2`, `v1_3`. Default is `v1_2`.
41
+
42
+ `--includeResourceData`
43
+ : When set, the change notifications will include the changed resource data.
44
+
45
+ `--encryptionCertificate [encryptionCertificate]`
46
+ : A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `includeResourceData`.
47
+
48
+ `--encryptionCertificateId [encryptionCertificateId]`
49
+ : A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `includeResourceData`.
32
50
  ```
33
51
 
34
52
  <Global />
@@ -47,6 +65,13 @@ To subscribe to change notifications of Outlook contacts, events, or messages in
47
65
  - Use the corresponding application permission to subscribe to changes of items in a folder or mailbox of any user in the tenant.
48
66
  - Do not use the Outlook sharing permissions (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared, and their read/write counterparts), as they do not support subscribing to change notifications on items in shared or delegated folders.
49
67
 
68
+ :::info
69
+
70
+ For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2.
71
+ For these subscribers, not setting this property per the timeline would result in subscription operations failing.
72
+
73
+ :::
74
+
50
75
  ## Examples
51
76
 
52
77
  Create a subscription
@@ -55,16 +80,16 @@ Create a subscription
55
80
  m365 graph subscription add --resource "me/mailFolders('Inbox')/messages" --changeTypes "updated" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
56
81
  ```
57
82
 
58
- Create a subscription on multiple change types
83
+ Create a subscription on multiple change types and include resource data
59
84
 
60
85
  ```sh
61
- m365 graph subscription add --resource groups --changeTypes "updated,deleted" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
86
+ m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --includeResourceData --encryptionCertificate 'Q0xJIGZvciBNaWNyb3NvZnQgMzY1' --encryptionCertificateId 'myCert' --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
62
87
  ```
63
88
 
64
89
  Create a subscription using the maximum allowed expiration for Group resources
65
90
 
66
91
  ```sh
67
- m365 graph subscription add --resource groups --changeTypes "updated" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient"
92
+ m365 graph subscription add --resource groups --changeTypes "updated" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --lifecycleNotificationUrl "https://webhook.azurewebsites.net/api/send/lifecycleNotifications"
68
93
  ```
69
94
 
70
95
  Create a subscription for Event Hub location if you are using Key Vault
@@ -79,10 +104,10 @@ Create a subscription for Event Hub location if you are using role-based access
79
104
  m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --notificationUrl "EventHub:https://eventHubNamespace.servicebus.windows.net/eventhubname/eventHubName?tenantId=contoso.com"
80
105
  ```
81
106
 
82
- Create a subscription for Event Grid Partner Topic.
107
+ Create a subscription for Event Grid Partner Topic and use TLS 1.3
83
108
 
84
109
  ```sh
85
- m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --notificationUrl "EventGrid:?azuresubscriptionid=8A8A8A8A-4B4B-4C4C-4D4D-12E12E12E12E&resourcegroup=resourceGroupName&partnertopic=partnerTopicName&location=partnerTopicAzureRegionName"
110
+ m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --latestTLSVersion 'v1_3' --notificationUrl "EventGrid:?azuresubscriptionid=8A8A8A8A-4B4B-4C4C-4D4D-12E12E12E12E&resourcegroup=resourceGroupName&partnertopic=partnerTopicName&location=partnerTopicAzureRegionName"
86
111
  ```
87
112
 
88
113
  ## Response
@@ -15,6 +15,12 @@ m365 login [options]
15
15
  ## Options
16
16
 
17
17
  ```md definition-list
18
+ `--appId [appId]`
19
+ : App ID of the Microsoft Entra application to use for authentication. This option is crucial and should be specified if it isn't defined elsewhere.
20
+
21
+ `--tenant [tenant]`
22
+ : ID of the tenant from which accounts should authenticate. Use `common` or `organization` for multitenant apps. Defaults to `common` if not specified and if the config value `tenantId` and the environment variable `CLIMICROSOFT365_TENANT` are also not set.
23
+
18
24
  `-t, --authType [authType]`
19
25
  : The type of authentication to use. Allowed values `certificate`, `deviceCode`, `password`, `identity`, `browser`, `secret`. Default `deviceCode`
20
26
 
@@ -36,12 +42,6 @@ m365 login [options]
36
42
  `-s, --secret [secret]`
37
43
  : Client Secret of the Microsoft Entra application to use for authentication. Required when `authType` is set to `secret`.
38
44
 
39
- `--appId [appId]`
40
- : App ID of the Microsoft Entra application to use for authentication. If not specified, use the app specified in the `CLIMICROSOFT365_ENTRAAPPID` environment variable. If the environment variable is not defined, use the multitenant PnP Management Shell app
41
-
42
- `--tenant [tenant]`
43
- : 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
44
-
45
45
  `--cloud [cloud]`
46
46
  : Cloud to connect to. Allowed values `Public`, `USGov`, `USGovHigh`, `USGovDoD` and `China`. Default `Public`
47
47
 
@@ -56,6 +56,20 @@ m365 login [options]
56
56
 
57
57
  ## Remarks
58
58
 
59
+ :::tip
60
+
61
+ The CLI determines the `appId` and `tenant` values in the following order of precedence:
62
+
63
+ 1. The `appId` or `tenant` option specified during login.
64
+ 2. The `clientId` or `tenantId` value set in the configuration.
65
+ 3. The `CLIMICROSOFT365_ENTRAAPPID` or `CLIMICROSOFT365_TENANT` environment variable.
66
+
67
+ For `appId`, it is **required** that at least one of the options is specified during login.
68
+
69
+ For `tenant`, if none are specified, the CLI will default to `common`.
70
+
71
+ :::
72
+
59
73
  Using the `login` command you can log in to Microsoft 365.
60
74
 
61
75
  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-microsoft-365.mdx). The default `authType` can be configured using `m365 cli config set`. This means you'll be able to run `m365 login` without specifying the `--authType` option.
@@ -78,116 +92,103 @@ When signing in with multiple identities, every signin will be saved as a connec
78
92
 
79
93
  ## Examples
80
94
 
81
- Log in to Microsoft 365 using the device code
95
+ Log in to Microsoft 365 using the device code.
96
+
97
+ ```sh
98
+ m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548e
99
+ ```
100
+
101
+ Log in to Microsoft 365 using the device code and set the connection name.
82
102
 
83
103
  ```sh
84
- m365 login
104
+ m365 login --connectionName 'myworkaccount' --appId 31359c7f-bd7e-475c-86db-fdb8c937548e
85
105
  ```
86
106
 
87
- Log in to Microsoft 365 using the device code and set the connection name
107
+ Log in to Microsoft 365 using your own Microsoft Entra application that's restricted only to allow accounts from the specific tenant.
88
108
 
89
109
  ```sh
90
- m365 login --connectionName 'myworkaccount'
110
+ m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a
91
111
  ```
92
112
 
93
- Log in to Microsoft 365 using the device code in debug mode including detailed debug information in the console output
113
+ Log in to Microsoft 365 using your own Microsoft Entra application and a personal information exchange (.pfx) file.
94
114
 
95
115
  ```sh
96
- m365 login --debug
116
+ m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
97
117
  ```
98
118
 
99
- Log in to Microsoft 365 using a user name and password
119
+ Log in to Microsoft 365 using a user name and password with `clientId` set in the configuration.
100
120
 
101
121
  ```sh
102
122
  m365 login --authType password --userName user@contoso.com --password pass@word1
103
123
  ```
104
124
 
105
- Log in to Microsoft 365 using a PEM certificate
125
+ Log in to Microsoft 365 using a PEM certificate with `clientId` set in the configuration.
106
126
 
107
127
  ```sh
108
128
  m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem
109
129
  ```
110
130
 
111
- Log in to Microsoft 365 using a PEM certificate. Use the specified thumbprint
131
+ Log in to Microsoft 365 using a PEM certificate with `clientId` set in the configuration. Use the specified thumbprint.
112
132
 
113
133
  ```sh
114
134
  m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1
115
135
  ```
116
136
 
117
- Log in to Microsoft 365 using a personal information exchange (.pfx) file
137
+ Log in to Microsoft 365 using a personal information exchange (.pfx) file with `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
118
138
 
119
139
  ```sh
120
140
  m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
121
141
  ```
122
142
 
123
- Log in to Microsoft 365 using a personal information exchange (.pfx) file protected with an empty password
143
+ Log in to Microsoft 365 using a personal information exchange (.pfx) file protected with an empty password and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
124
144
 
125
145
  ```sh
126
146
  m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password
127
147
  ```
128
148
 
129
- Log in to Microsoft 365 using a personal information exchange (.pfx) file not protected with a password
149
+ Log in to Microsoft 365 using a personal information exchange (.pfx) file not protected with a password and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
130
150
 
131
151
  ```sh
132
152
  m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx
133
153
  ```
134
154
 
135
- Log in to Microsoft 365 using a personal information exchange (.pfx) file. Use the specified thumbprint
155
+ Log in to Microsoft 365 using a personal information exchange (.pfx) file. Use the specified thumbprint and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
136
156
 
137
157
  ```sh
138
158
  m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1 --password 'pass@word1'
139
159
  ```
140
160
 
141
- Log in to Microsoft 365 using a certificate from a base64-encoded string
161
+ Log in to Microsoft 365 using a certificate from a base64-encoded string with `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
142
162
 
143
163
  ```sh
144
164
  m365 login --authType certificate --certificateBase64Encoded MIII2QIBAzCCCJ8GCSqGSIb3DQEHAaCCCJAEg...eX1N5AgIIAA== --thumbprint D0C9B442DE249F55D10CDA1A2418952DC7D407A3
145
165
  ```
146
166
 
147
- Log in to Microsoft 365 using a system assigned managed identity. Applies to Azure resources with managed identity enabled,
148
- such as Azure Virtual Machines, Azure App Service or Azure Functions
167
+ Log in to Microsoft 365 using a system assigned managed identity with `clientId` set in the configuration. Applies to Azure resources with managed identity enabled, such as Azure Virtual Machines, Azure App Service or Azure Functions.
149
168
 
150
169
  ```sh
151
170
  m365 login --authType identity
152
171
  ```
153
172
 
154
- Log in to Microsoft 365 using managed identity in Azure Cloud Shell. Uses the identity of the current user.
173
+ Log in to Microsoft 365 using managed identity in Azure Cloud Shell with `clientId` set in the configuration. Uses the identity of the current user.
155
174
 
156
175
  ```sh
157
176
  m365 login --authType identity
158
177
  ```
159
178
 
160
- 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
179
+ Log in to Microsoft 365 using a user-assigned managed identity with `clientId` set in the configuration. 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.
161
180
 
162
181
  ```sh
163
182
  m365 login --authType identity --userName ac9fbed5-804c-4362-a369-21a4ec51109e
164
183
  ```
165
184
 
166
- Log in to Microsoft 365 using your own multitenant Microsoft Entra application
167
-
168
- ```sh
169
- m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c
170
- ```
171
-
172
- Log in to Microsoft 365 using your own Microsoft Entra application that's restricted only to allow accounts from the specific tenant
173
-
174
- ```sh
175
- m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a
176
- ```
177
-
178
- Log in to Microsoft 365 using your own Microsoft Entra application and a personal information exchange (.pfx) file
179
-
180
- ```sh
181
- m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
182
- ```
183
-
184
- Log in to Microsoft 365 using the interactive browser authentication. Uses the identity of the current user.
185
+ Log in to Microsoft 365 using the interactive browser authentication with `clientId` set in the configuration. Uses the identity of the current user.
185
186
 
186
187
  ```sh
187
188
  m365 login --authType browser
188
189
  ```
189
190
 
190
- Log in to Microsoft 365 using a client secret.
191
+ Log in to Microsoft 365 using a client secret with `clientId` set in the configuration.
191
192
 
192
193
  ```sh
193
194
  m365 login --authType secret --secret topSeCr3t@007
@@ -2,12 +2,18 @@ import Global from '/docs/cmd/_global.mdx';
2
2
  import Tabs from '@theme/Tabs';
3
3
  import TabItem from '@theme/TabItem';
4
4
 
5
- # pp chatbot get
5
+ # pp copilot get
6
6
 
7
- Get information about the specified chatbot
7
+ Get information about the specified copilot
8
8
 
9
9
  ## Usage
10
10
 
11
+ ```sh
12
+ m365 pp copilot get [options]
13
+ ```
14
+
15
+ ## Alias
16
+
11
17
  ```sh
12
18
  m365 pp chatbot get [options]
13
19
  ```
@@ -19,10 +25,10 @@ m365 pp chatbot get [options]
19
25
  : The name of the environment.
20
26
 
21
27
  `-i, --id [id]`
22
- : The id of the chatbot. Specify either `id` or `name` but not both.
28
+ : The id of the copilot. Specify either `id` or `name` but not both.
23
29
 
24
30
  `-n, --name [name]`
25
- : The name of the chatbot. Specify either `id` or `name` but not both.
31
+ : The name of the copilot. Specify either `id` or `name` but not both.
26
32
 
27
33
  `--asAdmin`
28
34
  : Run the command as admin for environments you do not have explicitly assigned permissions to.
@@ -32,28 +38,28 @@ m365 pp chatbot get [options]
32
38
 
33
39
  ## Examples
34
40
 
35
- Get a specific chatbot in a specific environment based on name.
41
+ Get a specific copilot in a specific environment based on name.
36
42
 
37
43
  ```sh
38
- m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Chatbot"
44
+ m365 pp copilot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Copilot"
39
45
  ```
40
46
 
41
- Get a specific chatbot in a specific environment based on name as admin.
47
+ Get a specific copilot in a specific environment based on name as admin.
42
48
 
43
49
  ```sh
44
- m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Chatbot" --asAdmin
50
+ m365 pp copilot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Copilot" --asAdmin
45
51
  ```
46
52
 
47
- Get a specific chatbot in a specific environment based on id.
53
+ Get a specific copilot in a specific environment based on id.
48
54
 
49
55
  ```sh
50
- m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893"
56
+ m365 pp copilot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893"
51
57
  ```
52
58
 
53
- Get a specific chatbot in a specific environment based on id as admin.
59
+ Get a specific copilot in a specific environment based on id as admin.
54
60
 
55
61
  ```sh
56
- m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893" --asAdmin
62
+ m365 pp copilot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893" --asAdmin
57
63
  ```
58
64
 
59
65
  ## Response
@@ -71,7 +77,7 @@ m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd5
71
77
  "schemaname": "new_bot_23f5f58697fd43d595eb451c9797a53d",
72
78
  "_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
73
79
  "overwritetime": "1900-01-01T00:00:00Z",
74
- "name": "CLI 365 Chatbot",
80
+ "name": "CLI 365 Copilot",
75
81
  "solutionid": "fd140aae-4df4-11dd-bd17-0019b9312238",
76
82
  "ismanaged": false,
77
83
  "versionnumber": 1421457,
@@ -119,7 +125,7 @@ m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd5
119
125
  botid : 3a081d91-5ea8-40a7-8ac9-abbaa3fcb893
120
126
  createdon : 2022-11-19T10:42:22Z
121
127
  modifiedon : 2022-11-19T10:42:24Z
122
- name : CLI 365 Chatbot
128
+ name : CLI 365 Copilot
123
129
  publishedon: 2022-11-19T10:43:24Z
124
130
  ```
125
131
 
@@ -128,18 +134,18 @@ m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd5
128
134
 
129
135
  ```csv
130
136
  name,botid,publishedon,createdon,modifiedon
131
- CLI 365 Chatbot,3a081d91-5ea8-40a7-8ac9-abbaa3fcb893,2022-11-19T10:43:24Z,2022-11-19T10:42:22Z,2022-11-19T10:42:24Z
137
+ CLI 365 Copilot,3a081d91-5ea8-40a7-8ac9-abbaa3fcb893,2022-11-19T10:43:24Z,2022-11-19T10:42:22Z,2022-11-19T10:42:24Z
132
138
  ```
133
139
 
134
140
  </TabItem>
135
141
  <TabItem value="Markdown">
136
142
 
137
143
  ```md
138
- # pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893"
144
+ # pp copilot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893"
139
145
 
140
146
  Date: 9/1/2023
141
147
 
142
- ## CLI 365 Chatbot
148
+ ## CLI 365 Copilot
143
149
 
144
150
  Property | Value
145
151
  ---------|-------
@@ -151,7 +157,7 @@ m365 pp chatbot get --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd5
151
157
  schemaname | new\_bot\_23f5f58697fd43d595eb451c9797a53d
152
158
  \_ownerid\_value | 5fa787c1-1c4d-ed11-bba1-000d3a2caf7f
153
159
  overwritetime | 1900-01-01T00:00:00Z
154
- name | CLI 365 Chatbot
160
+ name | CLI 365 Copilot
155
161
  solutionid | fd140aae-4df4-11dd-bd17-0019b9312238
156
162
  ismanaged | false
157
163
  versionnumber | 1445843
@@ -2,12 +2,18 @@ import Global from '/docs/cmd/_global.mdx';
2
2
  import Tabs from '@theme/Tabs';
3
3
  import TabItem from '@theme/TabItem';
4
4
 
5
- # pp chatbot list
5
+ # pp copilot list
6
6
 
7
- Lists Microsoft Power Platform chatbot in the specified Power Platform environment
7
+ Lists Microsoft Power Platform copilots in the specified Power Platform environment
8
8
 
9
9
  ## Usage
10
10
 
11
+ ```sh
12
+ m365 pp copilot list [options]
13
+ ```
14
+
15
+ ## Alias
16
+
11
17
  ```sh
12
18
  m365 pp chatbot list [options]
13
19
  ```
@@ -26,16 +32,16 @@ m365 pp chatbot list [options]
26
32
 
27
33
  ## Examples
28
34
 
29
- List chatbots in a specific environment.
35
+ List copilots in a specific environment.
30
36
 
31
37
  ```sh
32
- m365 pp chatbot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
38
+ m365 pp copilot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
33
39
  ```
34
40
 
35
- List chatbots in a specific environment as admin.
41
+ List copilots in a specific environment as admin.
36
42
 
37
43
  ```sh
38
- m365 pp chatbot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --asAdmin
44
+ m365 pp copilot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --asAdmin
39
45
  ```
40
46
 
41
47
  ## Response
@@ -59,7 +65,7 @@ m365 pp chatbot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd
59
65
  "isManaged": false,
60
66
  "versionNumber": 1429641,
61
67
  "timezoneRuleVersionNumber": 0,
62
- "name": "CLI Chatbot",
68
+ "name": "CLI Copilot",
63
69
  "statusCode": 1,
64
70
  "owner": "Doe, John",
65
71
  "overwriteTime": "1900-01-01T00:00:00Z",
@@ -77,9 +83,9 @@ m365 pp chatbot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd
77
83
  <TabItem value="Text">
78
84
 
79
85
  ```text
80
- name botid publishedOn createdOn botModifiedOn
81
- ------------ ------------------------------------ -------------------- -------------------- --------------------
82
- CLI Chatbot 23f5f586-97fd-43d5-95eb-451c9797a53d 2022-11-19T19:19:53Z 2022-11-19T10:42:22Z 2022-11-19T20:19:57Z
86
+ name botid publishedOn createdOn botModifiedOn
87
+ ----------- ------------------------------------ -------------------- -------------------- --------------------
88
+ CLI Copilot 23f5f586-97fd-43d5-95eb-451c9797a53d 2022-11-19T19:19:53Z 2022-11-19T10:42:22Z 2022-11-19T20:19:57Z
83
89
  ```
84
90
 
85
91
  </TabItem>
@@ -87,18 +93,18 @@ m365 pp chatbot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd
87
93
 
88
94
  ```csv
89
95
  name,botid,publishedOn,createdOn,botModifiedOn
90
- CLI Chatbot,23f5f586-97fd-43d5-95eb-451c9797a53d,2022-11-19T19:19:53Z,2022-11-19T10:42:22Z,2022-11-19T20:19:57Z
96
+ CLI Copilot,23f5f586-97fd-43d5-95eb-451c9797a53d,2022-11-19T19:19:53Z,2022-11-19T10:42:22Z,2022-11-19T20:19:57Z
91
97
  ```
92
98
 
93
99
  </TabItem>
94
100
  <TabItem value="Markdown">
95
101
 
96
102
  ```md
97
- # pp chatbot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
103
+ # pp copilot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
98
104
 
99
105
  Date: 9/1/2023
100
106
 
101
- ## CLI Chatbot
107
+ ## CLI Copilot
102
108
 
103
109
  Property | Value
104
110
  ---------|-------
@@ -115,7 +121,7 @@ m365 pp chatbot list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd
115
121
  isManaged | false
116
122
  versionNumber | 1429641
117
123
  timezoneRuleVersionNumber | 0
118
- name | CLI Chatbot
124
+ name | CLI Copilot
119
125
  statusCode | 1
120
126
  owner | Doe, John
121
127
  overwriteTime | 1900-01-01T00:00:00Z