@pnp/cli-microsoft365 8.1.0-beta.3dec9fa → 9.0.0-beta.1cfb646

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 (97) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +9 -9
  4. package/dist/Command.js +49 -2
  5. package/dist/cli/cli.js +60 -38
  6. package/dist/config.js +1 -1
  7. package/dist/m365/app/commands/permission/permission-add.js +9 -9
  8. package/dist/m365/commands/login.js +44 -96
  9. package/dist/m365/commands/status.js +2 -2
  10. package/dist/m365/connection/commands/connection-remove.js +6 -2
  11. package/dist/m365/connection/commands/connection-set.js +4 -1
  12. package/dist/m365/connection/commands/connection-use.js +25 -4
  13. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
  14. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
  15. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
  16. package/dist/m365/entra/commands/group/group-user-list.js +4 -4
  17. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  18. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  19. package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
  20. package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
  21. package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
  22. package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
  23. package/dist/m365/entra/commands.js +3 -0
  24. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  25. package/dist/m365/spe/ContainerTypeProperties.js +2 -0
  26. package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
  27. package/dist/m365/spe/commands.js +2 -1
  28. package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
  29. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
  30. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
  31. package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
  32. package/dist/m365/spo/commands/file/file-copy.js +55 -34
  33. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  34. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  35. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  36. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  37. package/dist/m365/spo/commands/folder/folder-set.js +0 -4
  38. package/dist/m365/spo/commands/list/list-list.js +1 -4
  39. package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
  40. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
  41. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +48 -24
  42. package/dist/m365/spo/commands/site/site-remove.js +1 -7
  43. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
  44. package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
  45. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
  46. package/dist/m365/spo/commands.js +0 -1
  47. package/dist/utils/formatting.js +16 -0
  48. package/dist/utils/spo.js +111 -6
  49. package/dist/utils/zod.js +124 -0
  50. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  51. package/docs/docs/cmd/connection/connection-use.mdx +8 -2
  52. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
  53. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
  54. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
  55. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  56. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  57. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  58. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  59. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
  60. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
  61. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
  62. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  63. package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
  64. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
  65. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
  66. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +87 -38
  67. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
  68. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
  69. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
  70. package/docs/docs/cmd/spo/file/file-copy.mdx +119 -12
  71. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  72. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
  73. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  74. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  75. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  76. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
  77. package/docs/docs/cmd/spo/folder/folder-set.mdx +0 -6
  78. package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
  79. package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
  80. package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
  81. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
  82. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
  83. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
  84. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
  85. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +11 -2
  86. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
  87. package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
  88. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
  89. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
  90. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
  91. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
  92. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
  93. package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
  94. package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
  95. package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
  96. package/npm-shrinkwrap.json +606 -845
  97. package/package.json +6 -2
@@ -21,7 +21,7 @@ m365 aad m365group recyclebinitem list [options]
21
21
  ## Options
22
22
 
23
23
  ```md definition-list
24
- `-d, --groupDisplayName [groupDisplayName]`
24
+ `-d, --groupName [groupName]`
25
25
  : Lists groups with DisplayName starting with the specified value
26
26
 
27
27
  `-m, --groupMailNickname [groupMailNickname]`
@@ -41,7 +41,7 @@ m365 entra m365group recyclebinitem list
41
41
  List deleted Microsoft 365 Groups with display name starting with _Project_
42
42
 
43
43
  ```sh
44
- m365 entra m365group recyclebinitem list --groupDisplayName Project
44
+ m365 entra m365group recyclebinitem list --groupName Project
45
45
  ```
46
46
 
47
47
  List deleted Microsoft 365 Groups mail nick name starting with _team_
@@ -53,7 +53,7 @@ m365 entra m365group recyclebinitem list --groupMailNickname team
53
53
  List deleted Microsoft 365 Groups mail nick name starting with _team_ and with display name starting with _Project_
54
54
 
55
55
  ```sh
56
- m365 entra m365group recyclebinitem list --groupMailNickname team --groupDisplayName Project
56
+ m365 entra m365group recyclebinitem list --groupMailNickname team --groupName Project
57
57
  ```
58
58
 
59
59
  ## Response
@@ -28,7 +28,7 @@ m365 aad m365group user list [options]
28
28
  : The display name of the Microsoft 365 group. Specify `groupId` or `groupDisplayName` but not both.
29
29
 
30
30
  `-r, --role [role]`
31
- : Filter the results to only users with the given role. Allowed values: `Owner`, `Member`, or (Deprecated) `Guest`.
31
+ : Filter the results to only users with the given role. Allowed values: `Owner`, `Member`.
32
32
 
33
33
  `-p, --properties [properties]`
34
34
  : Comma-separated list of properties to retrieve.
@@ -0,0 +1,107 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # entra multitenant add
6
+
7
+ Creates a new multitenant organization
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 entra multitenant add [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-n, --displayname <displayName>`
19
+ : Display name for the multitenant organization.
20
+
21
+ `-d, --description [description]`
22
+ : Description for the multitenant organiztion.
23
+ ```
24
+
25
+ <Global />
26
+
27
+ ## Remarks
28
+
29
+ :::info
30
+
31
+ To use this command you must be at least **Security Administrator**.
32
+
33
+ :::
34
+
35
+ ## Examples
36
+
37
+ Create a new multitenant organization with display name only.
38
+
39
+ ```sh
40
+ m365 entra multitenant add --displayName 'Contoso organization'
41
+ ```
42
+
43
+ Create a new multitenant organization with display name and description.
44
+
45
+ ```sh
46
+ m365 entra multitenant add --displayName 'Contoso organization' --description 'Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank'
47
+ ```
48
+
49
+ ## Response
50
+
51
+ <Tabs>
52
+ <TabItem value="JSON">
53
+
54
+ ```json
55
+ {
56
+ "id": "c231d4a5-138f-4bdf-9fee-f26a90ea3ad0",
57
+ "createdDateTime": "2024-05-05T05:05:05Z",
58
+ "state": "active",
59
+ "displayName": "Contoso organization",
60
+ "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
61
+ }
62
+ ```
63
+
64
+ </TabItem>
65
+ <TabItem value="Text">
66
+
67
+ ```text
68
+ createdDateTime: 2024-05-05T05:05:05Z
69
+ description : Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
70
+ displayName : Contoso organization
71
+ id : c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
72
+ state : active
73
+ ```
74
+
75
+ </TabItem>
76
+ <TabItem value="CSV">
77
+
78
+ ```csv
79
+ id,createdDateTime,state,displayName,description
80
+ c231d4a5-138f-4bdf-9fee-f26a90ea3ad0,2024-05-05T05:05:05Z,active,Contoso organization,"Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
81
+ ```
82
+
83
+ </TabItem>
84
+ <TabItem value="Markdown">
85
+
86
+ ```md
87
+ # entra multitenant add
88
+
89
+ Date: 5/5/2024
90
+
91
+ ## Contoso organization (c231d4a5-138f-4bdf-9fee-f26a90ea3ad0)
92
+
93
+ Property | Value
94
+ ---------|-------
95
+ id | c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
96
+ createdDateTime | 2024-05-05T05:05:05Z
97
+ state | active
98
+ displayName | Contoso organization
99
+ description | Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
100
+ ```
101
+
102
+ </TabItem>
103
+ </Tabs>
104
+
105
+ ## More information
106
+
107
+ - Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
@@ -0,0 +1,58 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # entra multitenant remove
4
+
5
+ Removes a multitenant organization
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 entra multitenant remove [options]
11
+ ```
12
+
13
+ ## options
14
+
15
+ ```md definition-list
16
+ `-f, --force`
17
+ : Don't prompt for confirmation.
18
+ ```
19
+
20
+ <Global />
21
+
22
+ ## Remarks
23
+
24
+ :::info
25
+
26
+ To use this command you must be at least **Security Administrator**.
27
+
28
+ :::
29
+
30
+ :::info
31
+
32
+ When removing a Multi-Tenant Organization, all associations with other tenants will be removed too.
33
+
34
+ The removing process can take up to 2 hours to complete.
35
+
36
+ :::
37
+
38
+ ## Examples
39
+
40
+ Remove the multitenant organization.
41
+
42
+ ```sh
43
+ m365 entra multitenant remove
44
+ ```
45
+
46
+ Remove the multitenant organization without prompting for confirmation.
47
+
48
+ ```sh
49
+ m365 entra multitenant remove --force
50
+ ```
51
+
52
+ ## Response
53
+
54
+ The command won't return a response on success
55
+
56
+ ## More information
57
+
58
+ - Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
@@ -0,0 +1,53 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # entra multitenant set
4
+
5
+ Updates the properties of a multitenant organization
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 entra multitenant set [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-n, --displayName [displayName]`
17
+ : New display name of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
18
+
19
+ `-d, --description [description]`
20
+ : New description of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
21
+ ```
22
+
23
+ <Global />
24
+
25
+ ## Remarks
26
+
27
+ :::info
28
+
29
+ To use this command you must be at least **Security Administrator**.
30
+
31
+ :::
32
+
33
+ ## Examples
34
+
35
+ Update display name of multitenant organization.
36
+
37
+ ```sh
38
+ m365 entra multitenant set --displayName 'Fabrikam organization'
39
+ ```
40
+
41
+ Update display name and description of multitenant organization.
42
+
43
+ ```sh
44
+ m365 entra multitenant set --displayName 'Fabrikam organization' --description 'Multitenant organization between Fabrikam and Contoso'
45
+ ```
46
+
47
+ ## Response
48
+
49
+ The command won't return a response on success
50
+
51
+ ## More information
52
+
53
+ - Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
@@ -19,10 +19,10 @@ m365 outlook message get [options]
19
19
  : ID of the message.
20
20
 
21
21
  `--userId [userId]`
22
- : ID of the user from which to retrieve the message. Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
22
+ : ID of the user from which to retrieve the message. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
23
23
 
24
- `--userPrincipalName [userPrincipalName]`
25
- : UPN of the user from which to retrieve the message Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
24
+ `--userName [userName]`
25
+ : UPN of the user from which to retrieve the message Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -38,7 +38,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
38
38
  Get a specific message using delegated permissions from a shared mailbox.
39
39
 
40
40
  ```sh
41
- m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName sharedmailbox@tenant.com
41
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName sharedmailbox@tenant.com
42
42
  ```
43
43
 
44
44
  Get a specific message from a specific user retrieved by user ID using application permissions.
@@ -50,7 +50,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
50
50
  Get a specific message from a specific user retrieved by user principal name using application permissions.
51
51
 
52
52
  ```sh
53
- m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName user@tenant.com
53
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName user@tenant.com
54
54
  ```
55
55
 
56
56
  ## 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]`
@@ -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)
@@ -14,28 +14,25 @@ m365 spfx project github workflow add [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-n, --name [name]`
17
- : Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'
17
+ : Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'.
18
18
 
19
19
  `-b, --branchName [branchName]`
20
- : Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'
20
+ : Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'.
21
21
 
22
22
  `-m, --manuallyTrigger`
23
- : When specified a manual trigger option will be added to the workflow: `workflow_dispatch`
23
+ : When specified a manual trigger option will be added to the workflow: `workflow_dispatch`.
24
24
 
25
25
  `-l, --loginMethod [loginMethod]`
26
- : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`'
26
+ : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`.
27
27
 
28
28
  `-s, --scope [scope]`
29
- : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`
29
+ : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`.
30
30
 
31
31
  `-u, --siteUrl [siteUrl]`
32
- : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`
32
+ : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`.
33
33
 
34
34
  `--skipFeatureDeployment`
35
- : When specified and the app supports tenant-wide deployment, deploy it to the whole tenant
36
-
37
- `--overwrite`
38
- : When specified the workflow will overwrite the existing .sppkg if it is already deployed in the app catalog.
35
+ : When specified and the app supports tenant-wide deployment, deploy it to the whole tenant.
39
36
  ```
40
37
 
41
38
  <Global />
@@ -59,6 +56,8 @@ For the `user` login method you will need to create the following secrets in Git
59
56
 
60
57
  This method is perfect to test your workflow, in a dev context, for personal usage. It will not work for accounts with MFA.
61
58
 
59
+ The workflow will overwrite the existing .sppkg if it is already deployed in the app catalog. Overwriting your sppkg file on every deployment is required to make continuous delivery of the latest version of your app which is the aim of the continuous delivery pipeline.
60
+
62
61
  :::info
63
62
 
64
63
  Run this command in the SPFx solution folder.
@@ -67,7 +66,7 @@ Run this command in the SPFx solution folder.
67
66
 
68
67
  ## Examples
69
68
 
70
- Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main
69
+ Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main.
71
70
 
72
71
  ```sh
73
72
  m365 spfx project github workflow add
@@ -79,7 +78,7 @@ Adds a GitHub workflow for a SharePoint Framework project with `user` login meth
79
78
  m365 spfx project github workflow add --manuallyTrigger --loginMethod "user"
80
79
  ```
81
80
 
82
- Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog
81
+ Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog.
83
82
 
84
83
  ```sh
85
84
  m365 spfx project github workflow add --scope "sitecollection" --siteUrl "https://some.sharepoint.com/sites/someSite"
@@ -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>