@pnp/cli-microsoft365 8.1.0-beta.3dec9fa → 8.1.0-beta.96dc207

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 (105) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +20 -21
  4. package/dist/Command.js +50 -5
  5. package/dist/cli/cli.js +115 -39
  6. package/dist/config.js +60 -5
  7. package/dist/m365/base/SpoCommand.js +1 -1
  8. package/dist/m365/cli/commands/cli-consent.js +2 -2
  9. package/dist/m365/cli/commands/cli-doctor.js +2 -2
  10. package/dist/m365/cli/commands/cli-reconsent.js +2 -3
  11. package/dist/m365/cli/commands/config/config-set.js +12 -3
  12. package/dist/m365/commands/login.js +74 -102
  13. package/dist/m365/commands/setup.js +256 -33
  14. package/dist/m365/connection/commands/connection-list.js +4 -4
  15. package/dist/m365/connection/commands/connection-remove.js +6 -2
  16. package/dist/m365/connection/commands/connection-set.js +4 -1
  17. package/dist/m365/connection/commands/connection-use.js +25 -4
  18. package/dist/m365/entra/commands/app/app-add.js +52 -288
  19. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-remove.js +123 -0
  20. package/dist/m365/entra/commands/group/group-set.js +256 -0
  21. package/dist/m365/entra/commands/m365group/m365group-user-add.js +109 -32
  22. package/dist/m365/entra/commands/m365group/m365group-user-set.js +159 -84
  23. package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
  24. package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
  25. package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
  26. package/dist/m365/entra/commands.js +6 -0
  27. package/dist/m365/flow/commands/flow-get.js +1 -1
  28. package/dist/m365/onenote/commands/notebook/notebook-add.js +132 -0
  29. package/dist/m365/onenote/commands.js +1 -0
  30. package/dist/m365/pa/commands/app/app-export.js +13 -7
  31. package/dist/m365/spe/ContainerTypeProperties.js +2 -0
  32. package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
  33. package/dist/m365/spe/commands.js +2 -1
  34. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
  35. package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
  36. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  37. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  38. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  39. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  40. package/dist/m365/spo/commands/folder/folder-sharinglink-get.js +86 -0
  41. package/dist/m365/spo/commands/folder/folder-sharinglink-list.js +110 -0
  42. package/dist/m365/spo/commands/list/ListInstance.js +6 -1
  43. package/dist/m365/spo/commands/list/list-get.js +9 -3
  44. package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
  45. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
  46. package/dist/m365/spo/commands/site/site-get.js +12 -16
  47. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
  48. package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
  49. package/dist/m365/spo/commands.js +2 -0
  50. package/dist/m365/teams/commands/message/message-restore.js +106 -0
  51. package/dist/m365/teams/commands.js +1 -0
  52. package/dist/settingsNames.js +7 -1
  53. package/dist/utils/drive.js +61 -0
  54. package/dist/utils/entraApp.js +283 -0
  55. package/dist/utils/formatting.js +16 -0
  56. package/dist/utils/spo.js +69 -6
  57. package/dist/utils/zod.js +124 -0
  58. package/docs/docs/_clisettings.mdx +6 -0
  59. package/docs/docs/cmd/connection/connection-use.mdx +8 -2
  60. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-remove.mdx +65 -0
  61. package/docs/docs/cmd/entra/group/group-add.mdx +0 -4
  62. package/docs/docs/cmd/entra/group/group-set.mdx +89 -0
  63. package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +28 -10
  64. package/docs/docs/cmd/entra/m365group/m365group-user-set.mdx +35 -11
  65. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
  66. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
  67. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
  68. package/docs/docs/cmd/flow/flow-get.mdx +149 -283
  69. package/docs/docs/cmd/onenote/notebook/notebook-add.mdx +169 -0
  70. package/docs/docs/cmd/pa/app/app-export.mdx +15 -9
  71. package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
  72. package/docs/docs/cmd/setup.mdx +16 -3
  73. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
  74. package/docs/docs/cmd/spo/app/app-uninstall.mdx +1 -1
  75. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +87 -38
  76. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
  77. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
  78. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
  79. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  80. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
  81. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  82. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  83. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  84. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
  85. package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +110 -0
  86. package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +114 -0
  87. package/docs/docs/cmd/spo/list/list-get.mdx +6 -0
  88. package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
  89. package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
  90. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
  91. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
  92. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
  93. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
  94. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
  95. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
  96. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
  97. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
  98. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
  99. package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
  100. package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
  101. package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
  102. package/docs/docs/cmd/teams/message/message-remove.mdx +2 -1
  103. package/docs/docs/cmd/teams/message/message-restore.mdx +62 -0
  104. package/npm-shrinkwrap.json +1002 -1147
  105. package/package.json +26 -23
@@ -0,0 +1,169 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # onenote notebook add
6
+
7
+ Create a new OneNote notebook.
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 onenote notebook add [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-n, --name <name>`
19
+ : Name of the notebook. Notebook names must be unique. The name cannot contain more than 128 characters or contain the following characters: `?*/:<>`
20
+
21
+ `--userId [userId]`
22
+ : Id of the user. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
23
+
24
+ `--userName [userName]`
25
+ : Name of the user. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
26
+
27
+ `--groupId [groupId]`
28
+ : Id of the SharePoint group. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
29
+
30
+ `--groupName [groupName]`
31
+ : Name of the SharePoint group. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
32
+
33
+ `-u, --webUrl [webUrl]`
34
+ : URL of the SharePoint site. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
35
+ ```
36
+
37
+ <Global />
38
+
39
+ ## Examples
40
+
41
+ Create a Microsoft OneNote notebook for the currently logged in user
42
+
43
+ ```sh
44
+ m365 onenote notebook add --name "Private Notebook"
45
+ ```
46
+
47
+ Create a Microsoft OneNote notebook in a group specified by id.
48
+
49
+ ```sh
50
+ m365 onenote notebook add --name "Private Notebook" --groupId 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
51
+ ```
52
+
53
+ Create a Microsoft OneNote notebook in a group specified by displayName.
54
+
55
+ ```sh
56
+ m365 onenote notebook add --name "Private Notebook" --groupName "MyGroup"
57
+ ```
58
+
59
+ Create a Microsoft OneNote notebook for a user specified by name
60
+
61
+ ```sh
62
+ m365 onenote notebook add --name "Private Notebook" --userName user1@contoso.onmicrosoft.com
63
+ ```
64
+
65
+ Create a Microsoft OneNote notebook for a user specified by id
66
+
67
+ ```sh
68
+ m365 onenote notebook add --name "Private Notebook" --userId 2609af39-7775-4f94-a3dc-0dd67657e900
69
+ ```
70
+
71
+ Creates a Microsoft OneNote notebooks for a site
72
+
73
+ ```sh
74
+ m365 onenote notebook add --name "Private Notebook" --webUrl https://contoso.sharepoint.com/sites/testsite
75
+ ```
76
+
77
+ ## Response
78
+
79
+ <Tabs>
80
+ <TabItem value="JSON">
81
+
82
+ ```json
83
+ {
84
+ "id": "1-08554ffd-b769-4a4a-9563-faaa3191f253",
85
+ "self": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253",
86
+ "createdDateTime": "2024-04-05T17:58:27Z",
87
+ "displayName": "Private Notebook",
88
+ "lastModifiedDateTime": "2024-04-05T17:58:27Z",
89
+ "isDefault": false,
90
+ "userRole": "Owner",
91
+ "isShared": false,
92
+ "sectionsUrl": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253/sections",
93
+ "sectionGroupsUrl": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253/sectionGroups",
94
+ "createdBy": {
95
+ "user": {
96
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
97
+ "displayName": "John Doe"
98
+ }
99
+ },
100
+ "lastModifiedBy": {
101
+ "user": {
102
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
103
+ "displayName": "John Doe"
104
+ }
105
+ },
106
+ "links": {
107
+ "oneNoteClientUrl": {
108
+ "href": "onenote:https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"
109
+ },
110
+ "oneNoteWebUrl": {
111
+ "href": "https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"
112
+ }
113
+ }
114
+ }
115
+ ```
116
+
117
+ </TabItem>
118
+ <TabItem value="Text">
119
+
120
+ ```text
121
+ createdBy : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
122
+ createdDateTime : 2024-04-05T17:58:36Z
123
+ displayName : Private Notebook
124
+ id : 1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f
125
+ isDefault : false
126
+ isShared : false
127
+ lastModifiedBy : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
128
+ lastModifiedDateTime: 2024-04-05T17:58:36Z
129
+ links : {"oneNoteClientUrl":{"href":"onenote:https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"},"oneNoteWebUrl":{"href":"https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"}}
130
+ sectionGroupsUrl : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f/sectionGroups
131
+ sectionsUrl : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f/sections
132
+ self : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f
133
+ userRole : Owner
134
+ ```
135
+
136
+ </TabItem>
137
+ <TabItem value="CSV">
138
+
139
+ ```csv
140
+ id,self,createdDateTime,displayName,lastModifiedDateTime,isDefault,userRole,isShared,sectionsUrl,sectionGroupsUrl
141
+ 1-272a5791-2c95-45cf-b27d-7f68e07f6149,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149,2024-04-05T18:00:28Z,Private Notebook,2024-04-05T18:00:28Z,,Owner,,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149/sections,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149/sectionGroups
142
+ ```
143
+
144
+ </TabItem>
145
+ <TabItem value="Markdown">
146
+
147
+ ```md
148
+ # onenote notebook add --name "Private Notebook"
149
+
150
+ Date: 05/04/2024
151
+
152
+ ## Private Notebook (1-fa279d79-4701-43a2-9593-c2abfbe6999f)
153
+
154
+ Property | Value
155
+ ---------|-------
156
+ id | 1-fa279d79-4701-43a2-9593-c2abfbe6999f
157
+ self | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f
158
+ createdDateTime | 2024-04-05T18:00:58Z
159
+ displayName | Private Notebook
160
+ lastModifiedDateTime | 2024-04-05T18:00:58Z
161
+ isDefault | false
162
+ userRole | Owner
163
+ isShared | false
164
+ sectionsUrl | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f/sections
165
+ sectionGroupsUrl | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f/sectionGroups
166
+ ```
167
+
168
+ </TabItem>
169
+ </Tabs>
@@ -14,25 +14,25 @@ m365 pa app export [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-n, --name <name>`
17
- : The name (GUID) of the Power Apps app to export
17
+ : The name (GUID) of the Power Apps app to export.
18
18
 
19
19
  `-e, --environmentName <environmentName>`
20
- : The name of the environment for which to export the app
20
+ : The name of the environment for which to export the app.
21
21
 
22
22
  `--packageDisplayName [packageDisplayName]`
23
- : The display name to use in the exported package
23
+ : The display name to use in the exported package.
24
24
 
25
25
  `-d, --packageDescription [packageDescription]`
26
- : The description to use in the exported package
26
+ : The description to use in the exported package.
27
27
 
28
28
  `-c, --packageCreatedBy [packageCreatedBy]`
29
- : The name of the person to be used as the creator of the exported package
29
+ : The name of the person to be used as the creator of the exported package.
30
30
 
31
31
  `-s, --packageSourceEnvironment [packageSourceEnvironment]`
32
- : The name of the source environment from which the exported package was taken
32
+ : The name of the source environment from which the exported package was taken.
33
33
 
34
34
  `-p, --path [path]`
35
- : The path to save the exported package to. If not specified the app will be exported in the current working directory
35
+ : The path to save the exported package to. If not specified the app will be exported in the current working directory.
36
36
  ```
37
37
 
38
38
  <Global />
@@ -42,13 +42,19 @@ m365 pa app export [options]
42
42
  Export the specified Power App as a ZIP file
43
43
 
44
44
  ```sh
45
- m365 pa app export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "PowerApp"
45
+ m365 pa app export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
46
+ ```
47
+
48
+ Export the specified Power App as a ZIP file with a custom package name
49
+
50
+ ```sh
51
+ m365 pa app export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "Assets app"
46
52
  ```
47
53
 
48
54
  Export the specified Power App as a ZIP file with the package displayname, package description, the one who created it, the package source environment and the path
49
55
 
50
56
  ```sh
51
- m365 pa app export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "PowerApp" --packageDescription "Power App Description" --packageCreatedBy "John Doe" --packageSourceEnvironment "Contoso" --path "C:/Users/John/Documents"
57
+ m365 pa app export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "Assets app" --packageDescription "App to track assets of people" --packageCreatedBy "John Doe" --packageSourceEnvironment "Contoso" --path "C:/Users/John/Documents"
52
58
  ```
53
59
 
54
60
  ## Response
@@ -13,7 +13,7 @@ m365 planner plan remove [options]
13
13
  ## Options
14
14
 
15
15
  ```md definition-list
16
- `i, --id [id]`
16
+ `-i, --id [id]`
17
17
  : ID of the plan to remove. Specify either `id` or `title` but not both.
18
18
 
19
19
  `-t, --title [title]`
@@ -18,6 +18,9 @@ m365 setup [options]
18
18
 
19
19
  `--scripting`
20
20
  : Configure CLI for Microsoft 365 for use in scripts without prompting for additional information.
21
+
22
+ `--skipApp`
23
+ : Skip configuring an Entra app for use with CLI for Microsoft 365.
21
24
  ```
22
25
 
23
26
  <Global />
@@ -28,6 +31,10 @@ The `m365 setup` command is a wizard that helps you configure the CLI for Micros
28
31
 
29
32
  The command will ask you the following questions:
30
33
 
34
+ - _CLI for Microsoft 365 requires a Microsoft Entra app. Do you want to create a new app registration or use an existing one?_
35
+
36
+ You can choose between using an existing Entra app or creating a new one. If you choose to create a new app, the CLI will ask you to choose between a minimal and a full set of permissions. It then signs in as Azure CLI to your tenant, creates a new app registration, and stores its information in the CLI configuration.
37
+
31
38
  - _How do you plan to use the CLI?_
32
39
 
33
40
  You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors and show spinners. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
@@ -71,24 +78,30 @@ The `m365 setup` command uses the following presets:
71
78
 
72
79
  ## Examples
73
80
 
74
- Configure CLI for Microsoft based on your preferences interactively
81
+ Configure CLI for Microsoft 365 based on your preferences interactively
75
82
 
76
83
  ```sh
77
84
  m365 setup
78
85
  ```
79
86
 
80
- Configure CLI for Microsoft for interactive use without prompting for additional information
87
+ Configure CLI for Microsoft 365 for interactive use without prompting for additional information
81
88
 
82
89
  ```sh
83
90
  m365 setup --interactive
84
91
  ```
85
92
 
86
- Configure CLI for Microsoft for use in scripts without prompting for additional information
93
+ Configure CLI for Microsoft 365 for use in scripts without prompting for additional information
87
94
 
88
95
  ```sh
89
96
  m365 setup --scripting
90
97
  ```
91
98
 
99
+ Configure CLI for Microsoft 365 without setting up an Entra app
100
+
101
+ ```sh
102
+ m365 setup --skipApp
103
+ ```
104
+
92
105
  ## Response
93
106
 
94
107
  The command won't return a response on success.
@@ -0,0 +1,102 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # spe containertype list
6
+
7
+ Lists all Container Types
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 spe containertype list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ <Global />
18
+
19
+ ## Examples
20
+
21
+ Retrieves a list of Container Types created for a SharePoint Embedded Application from the tenant.
22
+
23
+ ```sh
24
+ m365 spe containertype list
25
+ ```
26
+
27
+ ## Response
28
+
29
+ <Tabs>
30
+ <TabItem value="JSON">
31
+
32
+ ```json
33
+ [
34
+ {
35
+ "_ObjectType_": "Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties",
36
+ "ApplicationRedirectUrl": null,
37
+ "AzureSubscriptionId": "/Guid(00000000-0000-0000-0000-000000000000)/",
38
+ "ContainerTypeId": "/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/",
39
+ "CreationDate": null,
40
+ "DisplayName": "test1",
41
+ "ExpiryDate": null,
42
+ "IsBillingProfileRequired": true,
43
+ "OwningAppId": "/Guid(df4085cc-9a38-4255-badc-5c5225610475)/",
44
+ "OwningTenantId": "/Guid(00000000-0000-0000-0000-000000000000)/",
45
+ "Region": null,
46
+ "ResourceGroup": null,
47
+ "SPContainerTypeBillingClassification": 0
48
+ }
49
+ ]
50
+ ```
51
+
52
+ </TabItem>
53
+ <TabItem value="Text">
54
+
55
+ ```text
56
+ ContainerTypeId DisplayName OwningAppId
57
+ -------------------------------------------- --------------------------------------------- --------------------------------------------
58
+ /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/ test1 /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
59
+ ```
60
+
61
+ </TabItem>
62
+ <TabItem value="CSV">
63
+
64
+ ```csv
65
+ _ObjectType_,ApplicationRedirectUrl,AzureSubscriptionId,ContainerTypeId,CreationDate,DisplayName,ExpiryDate,IsBillingProfileRequired,OwningAppId,OwningTenantId,Region,ResourceGroup,SPContainerTypeBillingClassification
66
+ Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties,,/Guid(00000000-0000-0000-0000-000000000000)/,/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/,,test1,,1,/Guid(df4085cc-9a38-4255-badc-5c5225610475)/,/Guid(00000000-0000-0000-0000-000000000000)/,,,0
67
+ ```
68
+
69
+ </TabItem>
70
+ <TabItem value="Markdown">
71
+
72
+ ```md
73
+ # spe containertype list
74
+
75
+ Date: 5/11/2024
76
+
77
+ ## test1
78
+
79
+ Property | Value
80
+ ---------|-------
81
+ \_ObjectType\_ | Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties
82
+ AzureSubscriptionId | /Guid(00000000-0000-0000-0000-000000000000)/
83
+ ContainerTypeId | /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/
84
+ DisplayName | test1
85
+ IsBillingProfileRequired | true
86
+ OwningAppId | /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
87
+ OwningTenantId | /Guid(00000000-0000-0000-0000-000000000000)/
88
+ SPContainerTypeBillingClassification | 0
89
+ ```
90
+
91
+ </TabItem>
92
+ </Tabs>
93
+
94
+ ## More information
95
+
96
+ In SharePoint Embedded, all files and documents are stored in Containers, and each Container is identified by a Container Type.
97
+
98
+ Container Type is a property stamped on every Container instance. Each Container Type is owned by one Application, and each Application can own only one Container Type.
99
+
100
+ The primary function of a Container Type is to manage the application workload that can access the Containers. Container Type defines the access permissions an Application has towards all Containers of that type, including create, read, write, delete containers; manage container permissions, etc.
101
+
102
+ More information about SharePoint Embedded and the limits can be found at the following location: [SharePoint Embedded](https://learn.microsoft.com/en-us/sharepoint/dev/embedded/concepts/app-concepts/containertypes#sharepoint-embedded-trial-container-types)
@@ -43,7 +43,7 @@ m365 spo app uninstall --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https
43
43
  Uninstall the app with the specified ID from the specified site without prompting for confirmation.
44
44
 
45
45
  ```sh
46
- m365 spo app uninstall --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com
46
+ m365 spo app uninstall --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com --force
47
47
  ```
48
48
 
49
49
  Uninstall the app with the specified ID from the specified site where the app is deployed to the site collection app catalog.
@@ -29,10 +29,17 @@ m365 spo applicationcustomizer get [options]
29
29
 
30
30
  `-s, --scope [scope]`
31
31
  : Scope of the application customizer. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
32
+
33
+ `-p, --clientSideComponentProperties`
34
+ : Only output the client-side component properties.
32
35
  ```
33
36
 
34
37
  <Global />
35
38
 
39
+ ## Remarks
40
+
41
+ This command can be used for retrieving an application customizer from a specific site. To retrieve an application customizer that's installed tenant-wide, view our dedicated [spo tenant applicationcustomizer get](../tenant/tenant-applicationcustomizer-get.mdx) command.
42
+
36
43
  ## Examples
37
44
 
38
45
  Retrieves an application customizer by title.
@@ -59,36 +66,41 @@ Retrieves an application customizer by title available at the site scope.
59
66
  m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales --scope site
60
67
  ```
61
68
 
62
- ## Remarks
69
+ Retrieves the client-side component properties of a application customizer.
63
70
 
64
- This command can be used for retrieving an application customizer from a specific site. To retrieve an application customizer that's installed tenant-wide, view our dedicated [spo tenant applicationcustomizer get](../tenant/tenant-applicationcustomizer-get.mdx) command.
71
+ ```sh
72
+ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --clientSideComponentProperties
73
+ ```
65
74
 
66
75
  ## Response
67
76
 
77
+ ### Standard response
78
+
68
79
  <Tabs>
69
80
  <TabItem value="JSON">
70
81
 
71
82
  ```json
72
83
  {
73
- "ClientSideComponentId": "7096cded-b83d-4eab-96f0-df477ed7c0bc",
74
- "ClientSideComponentProperties": "",
84
+ "ClientSideComponentId": "9a8b100c-246b-4592-9454-67826523e159",
85
+ "ClientSideComponentProperties": "{\"testMessage\":\"Test message\"}",
75
86
  "CommandUIExtension": null,
76
87
  "Description": null,
77
88
  "Group": null,
78
- "Id": "14125658-a9bc-4ddf-9c75-1b5767c9a337",
89
+ "HostProperties": "",
90
+ "Id": "4a428b32-08cf-45c7-9986-17585af38806",
79
91
  "ImageUrl": null,
80
92
  "Location": "ClientSideExtension.ApplicationCustomizer",
81
- "Name": "Some customizer",
93
+ "Name": "{4a428b32-08cf-45c7-9986-17585af38806}",
82
94
  "RegistrationId": null,
83
95
  "RegistrationType": 0,
84
- "Rights": "{\"High\":0,\"Low\":0}",
96
+ "Rights": "{\"High\":\"0\",\"Low\":\"0\"}",
85
97
  "Scope": "Web",
86
98
  "ScriptBlock": null,
87
99
  "ScriptSrc": null,
88
- "Sequence": 0,
89
- "Title": "Some customizer",
100
+ "Sequence": 65536,
101
+ "Title": "HelloWorld",
90
102
  "Url": null,
91
- "VersionOfUserCustomAction": "16.0.1.0"
103
+ "VersionOfUserCustomAction": "1.0.1.0"
92
104
  }
93
105
  ```
94
106
 
@@ -96,65 +108,102 @@ This command can be used for retrieving an application customizer from a specifi
96
108
  <TabItem value="Text">
97
109
 
98
110
  ```text
99
- ClientSideComponentId : 7096cded-b83d-4eab-96f0-df477ed7c0bc
100
- ClientSideComponentProperties:
111
+ ClientSideComponentId : 9a8b100c-246b-4592-9454-67826523e159
112
+ ClientSideComponentProperties: {"testMessage":"Test message"}
101
113
  CommandUIExtension : null
102
114
  Description : null
103
115
  Group : null
104
- Id : 14125658-a9bc-4ddf-9c75-1b5767c9a337
116
+ HostProperties :
117
+ Id : 4a428b32-08cf-45c7-9986-17585af38806
105
118
  ImageUrl : null
106
119
  Location : ClientSideExtension.ApplicationCustomizer
107
- Name : Some customizer
120
+ Name : {4a428b32-08cf-45c7-9986-17585af38806}
108
121
  RegistrationId : null
109
122
  RegistrationType : 0
110
- Rights : {"High":0,"Low":0}
123
+ Rights : {"High":"0","Low":"0"}
111
124
  Scope : Web
112
125
  ScriptBlock : null
113
126
  ScriptSrc : null
114
- Sequence : 0
115
- Title : Some customizer
127
+ Sequence : 65536
128
+ Title : HelloWorld
116
129
  Url : null
117
- VersionOfUserCustomAction : 16.0.1.0
130
+ VersionOfUserCustomAction : 1.0.1.0
118
131
  ```
119
132
 
120
133
  </TabItem>
121
134
  <TabItem value="CSV">
122
135
 
123
136
  ```csv
124
- ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
125
- 7096cded-b83d-4eab-96f0-df477ed7c0bc,,,,,14125658-a9bc-4ddf-9c75-1b5767c9a337,,ClientSideExtension.ApplicationCustomizer,Some customizer,,0,"{""High"":0,""Low"":0}",Web,,,0,Some customizer,,16.0.1.0
137
+ ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
138
+ 9a8b100c-246b-4592-9454-67826523e159,"{""testMessage"":""Test message""}",,,,,4a428b32-08cf-45c7-9986-17585af38806,,ClientSideExtension.ApplicationCustomizer,{4a428b32-08cf-45c7-9986-17585af38806},,0,"{""High"":""0"",""Low"":""0""}",Web,,,65536,HelloWorld,,1.0.1.0
126
139
  ```
127
140
 
128
141
  </TabItem>
129
142
  <TabItem value="Markdown">
130
143
 
131
144
  ```md
132
- # spo applicationcustomizer get --title "Some customizer" --webUrl "https://contoso.sharepoint.com/sites/sales" --scope "Web"
145
+ # spo applicationcustomizer get --webUrl "https://contoso.sharepoint.com/sites/Marketing" --id "4a428b32-08cf-45c7-9986-17585af38806"
133
146
 
134
- Date: 3/6/2023
147
+ Date: 16/05/2024
135
148
 
136
- ## Some customizer (14125658-a9bc-4ddf-9c75-1b5767c9a337)
149
+ ## HelloWorld (4a428b32-08cf-45c7-9986-17585af38806)
137
150
 
138
151
  Property | Value
139
152
  ---------|-------
140
- ClientSideComponentId | 7096cded-b83d-4eab-96f0-df477ed7c0bc
141
- ClientSideComponentProperties |
142
- CommandUIExtension | null
143
- Description | null
144
- Group | null
145
- Id | 14125658-a9bc-4ddf-9c75-1b5767c9a337
146
- ImageUrl | null
153
+ ClientSideComponentId | 9a8b100c-246b-4592-9454-67826523e159
154
+ ClientSideComponentProperties | {"testMessage":"Test message"}
155
+ HostProperties |
156
+ Id | 4a428b32-08cf-45c7-9986-17585af38806
147
157
  Location | ClientSideExtension.ApplicationCustomizer
148
- Name | Some customizer
149
- RegistrationId | null
158
+ Name | {4a428b32-08cf-45c7-9986-17585af38806}
150
159
  RegistrationType | 0
160
+ Rights | {"High":"0","Low":"0"}
151
161
  Scope | Web
152
- ScriptBlock | null
153
- ScriptSrc | null
154
- Sequence | 0
155
- Title | Some customizer
156
- Url | null
157
- VersionOfUserCustomAction | 16.0.1.0
162
+ Sequence | 65536
163
+ Title | HelloWorld
164
+ VersionOfUserCustomAction | 1.0.1.0
165
+ ```
166
+
167
+ </TabItem>
168
+ </Tabs>
169
+
170
+ ### `clientSideComponentProperties` response
171
+
172
+ <Tabs>
173
+ <TabItem value="JSON">
174
+
175
+ ```json
176
+ {
177
+ "testMessage": "Test message"
178
+ }
179
+ ```
180
+
181
+ </TabItem>
182
+ <TabItem value="Text">
183
+
184
+ ```txt
185
+ testMessage: Test message
186
+ ```
187
+
188
+ </TabItem>
189
+ <TabItem value="CSV">
190
+
191
+ ```csv
192
+ testMessage
193
+ Test message
194
+ ```
195
+
196
+ </TabItem>
197
+ <TabItem value="Markdown">
198
+
199
+ ```md
200
+ # spo applicationcustomizer get --title "Some customizer" --webUrl "https://contoso.sharepoint.com/sites/sales" --scope "Web" --clientSideComponentProperties "true"
201
+
202
+ Date: 15/05/2024
203
+
204
+ Property | Value
205
+ ---------|-------
206
+ testMessage | Test message
158
207
  ```
159
208
 
160
209
  </TabItem>