@pnp/cli-microsoft365 8.0.0-beta.e6f9331 → 8.1.0-beta.3bc5759

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 (60) hide show
  1. package/.eslintrc.cjs +1 -0
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/Auth.js +9 -17
  5. package/dist/Command.js +49 -2
  6. package/dist/chili/chili.js +0 -23
  7. package/dist/cli/cli.js +61 -101
  8. package/dist/m365/commands/login.js +44 -96
  9. package/dist/m365/commands/setup.js +0 -4
  10. package/dist/m365/entra/commands/m365group/m365group-set.js +66 -29
  11. package/dist/m365/entra/commands/multitenant/MultitenantOrganization.js +2 -0
  12. package/dist/m365/entra/commands/multitenant/multitenant-get.js +32 -0
  13. package/dist/m365/entra/commands.js +1 -0
  14. package/dist/m365/external/commands/connection/connection-doctor.js +10 -24
  15. package/dist/m365/flow/commands/flow-list.js +2 -1
  16. package/dist/m365/graph/commands/subscription/subscription-add.js +4 -2
  17. package/dist/m365/spe/ContainerTypeProperties.js +2 -0
  18. package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
  19. package/dist/m365/spe/commands.js +2 -1
  20. package/dist/m365/spfx/commands/project/base-project-command.js +36 -126
  21. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
  22. package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
  23. package/dist/m365/spo/commands/contenttype/contenttype-field-list.js +124 -0
  24. package/dist/m365/spo/commands/field/field-list.js +1 -1
  25. package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +2 -3
  26. package/dist/m365/spo/commands/page/page-text-add.js +2 -3
  27. package/dist/m365/spo/commands/spo-search.js +3 -4
  28. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
  29. package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
  30. package/dist/m365/spo/commands.js +1 -0
  31. package/dist/m365/teams/commands/meeting/meeting-attendancereport-get.js +119 -0
  32. package/dist/m365/teams/commands/message/message-remove.js +112 -0
  33. package/dist/m365/teams/commands.js +2 -0
  34. package/dist/m365/viva/commands/engage/engage-community-add.js +166 -0
  35. package/dist/m365/viva/commands.js +1 -0
  36. package/dist/utils/formatting.js +30 -1
  37. package/dist/utils/teams.js +49 -0
  38. package/dist/utils/zod.js +124 -0
  39. package/docs/docs/cmd/entra/m365group/m365group-set.mdx +37 -7
  40. package/docs/docs/cmd/entra/multitenant/multitenant-get.mdx +94 -0
  41. package/docs/docs/cmd/external/connection/connection-doctor.mdx +9 -9
  42. package/docs/docs/cmd/graph/subscription/subscription-add.mdx +18 -0
  43. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +131 -0
  44. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +85 -36
  45. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +18 -24
  46. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
  47. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
  48. package/docs/docs/cmd/spo/contenttype/contenttype-field-list.mdx +172 -0
  49. package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +3 -3
  50. package/docs/docs/cmd/spo/field/field-list.mdx +3 -3
  51. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
  52. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
  53. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
  54. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
  55. package/docs/docs/cmd/teams/meeting/meeting-attendancereport-get.mdx +138 -0
  56. package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
  57. package/docs/docs/cmd/teams/message/message-remove.mdx +63 -0
  58. package/docs/docs/cmd/viva/engage/engage-community-add.mdx +168 -0
  59. package/npm-shrinkwrap.json +590 -1024
  60. package/package.json +7 -3
@@ -35,10 +35,22 @@ m365 aad m365group set [options]
35
35
  : Comma-separated list of Microsoft 365 Group members to add
36
36
 
37
37
  `--isPrivate [isPrivate]`
38
- : Set to true if the Microsoft 365 Group should be private and to false if it should be public (default)
38
+ : Set to `true` if the Microsoft 365 Group should be private and `false` if it should be public.
39
39
 
40
40
  `-l, --logoPath [logoPath]`
41
41
  : Local path to the image file to use as group logo
42
+
43
+ `--allowExternalSenders [allowExternalSenders]`
44
+ : Indicates if people external to the organization can send messages to the group. Valid values: `true`, `false`.
45
+
46
+ `--autoSubscribeNewMembers [autoSubscribeNewMembers]`
47
+ : Indicates if new members added to the group will be auto-subscribed to receive email notifications. Valid values: `true`, `false`.
48
+
49
+ `--hideFromAddressLists [hideFromAddressLists]`
50
+ : Indicates if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups. Valid values: `true`, `false`.
51
+
52
+ `--hideFromOutlookClients [hideFromOutlookClients]`
53
+ : Indicates if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Valid values: `true`, `false`.
42
54
  ```
43
55
 
44
56
  <Global />
@@ -49,38 +61,56 @@ When updating group's owners and members, the command will add newly specified u
49
61
 
50
62
  When specifying the path to the logo image you can use both relative and absolute paths. Note, that ~ in the path, will not be resolved and will most likely result in an error.
51
63
 
64
+ :::note
65
+
66
+ Options `allowExternalSenders` and `autoSubscribeNewMembers` can only be set using delegated permissions.
67
+
68
+ :::
69
+
52
70
  ## Examples
53
71
 
54
- Update Microsoft 365 Group display name
72
+ Update Microsoft 365 Group display name.
55
73
 
56
74
  ```sh
57
75
  m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --displayName Finance
58
76
  ```
59
77
 
60
- Change Microsoft 365 Group visibility to public
78
+ Change Microsoft 365 Group visibility to public.
61
79
 
62
80
  ```sh
63
- m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate false
81
+ m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate `false`
64
82
  ```
65
83
 
66
- Add new Microsoft 365 Group owners
84
+ Add new Microsoft 365 Group owners.
67
85
 
68
86
  ```sh
69
87
  m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --owners "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
70
88
  ```
71
89
 
72
- Add new Microsoft 365 Group members
90
+ Add new Microsoft 365 Group members.
73
91
 
74
92
  ```sh
75
93
  m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --members "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
76
94
  ```
77
95
 
78
- Update Microsoft 365 Group logo
96
+ Update Microsoft 365 Group logo.
79
97
 
80
98
  ```sh
81
99
  m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --logoPath images/logo.png
82
100
  ```
83
101
 
102
+ Hide the Microsoft 365 group from the address lists and the Outlook clients.
103
+
104
+ ```sh
105
+ m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --hideFromOutlookClients true --hideFromAddressLists true
106
+ ```
107
+
108
+ Auto-subscribe new members to receive email notifications and do not allow external senders to send messages to the group.
109
+
110
+ ```sh
111
+ m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --autoSubscribeNewMembers true --allowExternalSenders false
112
+ ```
113
+
84
114
  ## Response
85
115
 
86
116
  The command won't return a response on success.
@@ -0,0 +1,94 @@
1
+
2
+ import Global from '/docs/cmd/_global.mdx';
3
+ import Tabs from '@theme/Tabs';
4
+ import TabItem from '@theme/TabItem';
5
+
6
+ # entra multitenant get
7
+
8
+ Gets properties of the multitenant organization
9
+
10
+ ## Usage
11
+
12
+ ```sh
13
+ m365 entra multitenant get [options]
14
+ ```
15
+
16
+ ## Options
17
+
18
+ <Global />
19
+
20
+ ## Remarks
21
+
22
+ :::info
23
+
24
+ To use this command you must be at least **Security Administrator**.
25
+
26
+ :::
27
+
28
+ ## Examples
29
+
30
+ Gets properties of the multitenant organization
31
+
32
+ ```sh
33
+ m365 entra multitenant get
34
+ ```
35
+
36
+ ## Response
37
+
38
+ <Tabs>
39
+ <TabItem value="JSON">
40
+
41
+ ```json
42
+ {
43
+ "id": "c231d4a5-138f-4bdf-9fee-f26a90ea3ad0",
44
+ "createdDateTime": "2024-05-05T05:05:05Z",
45
+ "state": "active",
46
+ "displayName": "Contoso organization",
47
+ "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
48
+ }
49
+ ```
50
+
51
+ </TabItem>
52
+ <TabItem value="Text">
53
+
54
+ ```text
55
+ createdDateTime: 2024-05-05T05:05:05Z
56
+ description : Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
57
+ displayName : Contoso organization
58
+ id : c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
59
+ state : active
60
+ ```
61
+
62
+ </TabItem>
63
+ <TabItem value="CSV">
64
+
65
+ ```csv
66
+ id,createdDateTime,state,displayName,description
67
+ c231d4a5-138f-4bdf-9fee-f26a90ea3ad0,2024-05-05T05:05:05Z,active,Contoso organization,"Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
68
+ ```
69
+
70
+ </TabItem>
71
+ <TabItem value="Markdown">
72
+
73
+ ```md
74
+ # entra multitenant get
75
+
76
+ Date: 5/5/2024
77
+
78
+ ## Contoso organization (c231d4a5-138f-4bdf-9fee-f26a90ea3ad0)
79
+
80
+ Property | Value
81
+ ---------|-------
82
+ id | c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
83
+ createdDateTime | 2024-05-05T05:05:05Z
84
+ state | active
85
+ displayName | Contoso organization
86
+ description | Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
87
+ ```
88
+
89
+ </TabItem>
90
+ </Tabs>
91
+
92
+ ## More information
93
+
94
+ - Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
@@ -126,15 +126,15 @@ m365 external connection doctor --id contosoproducts --ux copilot
126
126
  <TabItem value="Text">
127
127
 
128
128
  ```text
129
- Load connection
130
- Load schema
131
- Required semantic labels: Missing label iconUrl
132
- Searchable properties
133
- Items have content ingested
134
- Connection configured for inline results (manual)
135
- Items have activities recorded (manual)
136
- Meaningful connection name and description (manual)
137
- urlToItemResolver configured
129
+ Load connection
130
+ Load schema
131
+ × Required semantic labels: Missing label iconUrl
132
+ Searchable properties
133
+ Items have content ingested
134
+ i Connection configured for inline results (manual)
135
+ i Items have activities recorded (manual)
136
+ i Meaningful connection name and description (manual)
137
+ urlToItemResolver configured
138
138
  ```
139
139
 
140
140
  </TabItem>
@@ -67,6 +67,24 @@ Create a subscription using the maximum allowed expiration for Group resources
67
67
  m365 graph subscription add --resource groups --changeTypes "updated" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient"
68
68
  ```
69
69
 
70
+ Create a subscription for Event Hub location if you are using Key Vault
71
+
72
+ ```sh
73
+ m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --notificationUrl "EventHub:https://azureKeyVaultName.vault.azure.net/secrets/secretName?tenantId=contoso.com"
74
+ ```
75
+
76
+ Create a subscription for Event Hub location if you are using role-based access control
77
+
78
+ ```sh
79
+ m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --notificationUrl "EventHub:https://eventHubNamespace.servicebus.windows.net/eventhubname/eventHubName?tenantId=contoso.com"
80
+ ```
81
+
82
+ Create a subscription for Event Grid Partner Topic.
83
+
84
+ ```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"
86
+ ```
87
+
70
88
  ## Response
71
89
 
72
90
  <Tabs>
@@ -0,0 +1,131 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # Container Types list
6
+
7
+ Retrieves a list of Container Types created for a SharePoint Embedded Application
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 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 containertype list
25
+ ```
26
+
27
+ ## Response
28
+
29
+ <Tabs>
30
+ <TabItem value="JSON">
31
+
32
+ ```json
33
+ [{
34
+ "_ObjectType_": "Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties",
35
+ "ApplicationRedirectUrl": null,
36
+ "AzureSubscriptionId": "/Guid(00000000-0000-0000-0000-000000000000)/",
37
+ "ContainerTypeId": "/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/",
38
+ "CreationDate": null,
39
+ "DisplayName": "test1",
40
+ "ExpiryDate": null,
41
+ "IsBillingProfileRequired": true,
42
+ "OwningAppId": "/Guid(df4085cc-9a38-4255-badc-5c5225610475)/",
43
+ "OwningTenantId": "/Guid(00000000-0000-0000-0000-000000000000)/",
44
+ "Region": null,
45
+ "ResourceGroup": null,
46
+ "SPContainerTypeBillingClassification": 0
47
+ },
48
+ {
49
+ "_ObjectType_": "Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties",
50
+ "ApplicationRedirectUrl": null,
51
+ "AzureSubscriptionId": "/Guid(00000000-0000-0000-0000-000000000000)/",
52
+ "ContainerTypeId": "/Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/",
53
+ "CreationDate": null,
54
+ "DisplayName": "SharePoint Embedded Free Trial Container Type",
55
+ "ExpiryDate": null,
56
+ "IsBillingProfileRequired": true,
57
+ "OwningAppId": "/Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/",
58
+ "OwningTenantId": "/Guid(00000000-0000-0000-0000-000000000000)/",
59
+ "Region": null,
60
+ "ResourceGroup": null,
61
+ "SPContainerTypeBillingClassification": 1
62
+ }]
63
+ ```
64
+
65
+ </TabItem>
66
+ <TabItem value="Text">
67
+
68
+ ```text
69
+ ContainerTypeId DisplayName OwningAppId
70
+ -------------------------------------------- --------------------------------------------- --------------------------------------------
71
+ /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/ test1 /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
72
+ /Guid(880ab3bd-5b68-01d4-3744-01a7656cf2ba)/ test1 /Guid(50785fde-3082-47ac-a36d-06282ac5c7da)/
73
+ /Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/ SharePoint Embedded Free Trial Container Type /Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/
74
+ ```
75
+
76
+ </TabItem>
77
+ <TabItem value="CSV">
78
+
79
+ ```csv
80
+ _ObjectType_,ApplicationRedirectUrl,AzureSubscriptionId,ContainerTypeId,CreationDate,DisplayName,ExpiryDate,IsBillingProfileRequired,OwningAppId,OwningTenantId,Region,ResourceGroup,SPContainerTypeBillingClassification
81
+ 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
82
+ Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties,,/Guid(00000000-0000-0000-0000-000000000000)/,/Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/,,SharePoint Embedded Free Trial Container Type,,1,/Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/,/Guid(00000000-0000-0000-0000-000000000000)/,,,1
83
+ ```
84
+
85
+ </TabItem>
86
+ <TabItem value="Markdown">
87
+
88
+ ```md
89
+ # spe containertype list
90
+
91
+ Date: 5/11/2024
92
+
93
+ ## test1
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ \_ObjectType\_ | Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties
98
+ AzureSubscriptionId | /Guid(00000000-0000-0000-0000-000000000000)/
99
+ ContainerTypeId | /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/
100
+ DisplayName | test1
101
+ IsBillingProfileRequired | true
102
+ OwningAppId | /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
103
+ OwningTenantId | /Guid(00000000-0000-0000-0000-000000000000)/
104
+ SPContainerTypeBillingClassification | 0
105
+
106
+ ## SharePoint Embedded Free Trial Container Type
107
+
108
+ Property | Value
109
+ ---------|-------
110
+ \_ObjectType\_ | Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties
111
+ AzureSubscriptionId | /Guid(00000000-0000-0000-0000-000000000000)/
112
+ ContainerTypeId | /Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/
113
+ DisplayName | SharePoint Embedded Free Trial Container Type
114
+ IsBillingProfileRequired | true
115
+ OwningAppId | /Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/
116
+ OwningTenantId | /Guid(00000000-0000-0000-0000-000000000000)/
117
+ SPContainerTypeBillingClassification | 1
118
+ ```
119
+
120
+ </TabItem>
121
+ </Tabs>
122
+
123
+ ## More information
124
+
125
+ In SharePoint Embedded, all files and documents are stored in Containers, and each Container is identified by a Container Type.
126
+
127
+ 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.
128
+
129
+ 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.
130
+
131
+ 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)
@@ -29,6 +29,9 @@ 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 />
@@ -59,36 +62,45 @@ Retrieves an application customizer by title available at the site scope.
59
62
  m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales --scope site
60
63
  ```
61
64
 
65
+ Retrieves the client-side component properties of a application customizer.
66
+
67
+ ```sh
68
+ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --clientSideComponentProperties
69
+ ```
70
+
62
71
  ## Remarks
63
72
 
64
73
  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.
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>
@@ -44,16 +44,16 @@ This command can be used for retrieving a list of application customizers from a
44
44
  ```json
45
45
  [
46
46
  {
47
- "ClientSideComponentId": "4358e70e-ec3c-4713-beb6-39c88f7621d1",
48
- "ClientSideComponentProperties": "{\"listTitle\":\"News\",\"listViewTitle\":\"Published News\"}",
47
+ "ClientSideComponentId": "9a8b100c-246b-4592-9454-67826523e159",
48
+ "ClientSideComponentProperties": "{\"testMessage\":\"Test message\"}",
49
49
  "CommandUIExtension": null,
50
50
  "Description": null,
51
51
  "Group": null,
52
52
  "HostProperties": "",
53
- "Id": "f405303c-6048-4636-9660-1b7b2cadaef9",
53
+ "Id": "4a428b32-08cf-45c7-9986-17585af38806",
54
54
  "ImageUrl": null,
55
55
  "Location": "ClientSideExtension.ApplicationCustomizer",
56
- "Name": "{f405303c-6048-4636-9660-1b7b2cadaef9}",
56
+ "Name": "{4a428b32-08cf-45c7-9986-17585af38806}",
57
57
  "RegistrationId": null,
58
58
  "RegistrationType": 0,
59
59
  "Rights": {
@@ -64,7 +64,7 @@ This command can be used for retrieving a list of application customizers from a
64
64
  "ScriptBlock": null,
65
65
  "ScriptSrc": null,
66
66
  "Sequence": 65536,
67
- "Title": "NewsTicker",
67
+ "Title": "HelloWorld",
68
68
  "Url": null,
69
69
  "VersionOfUserCustomAction": "1.0.1.0"
70
70
  }
@@ -75,47 +75,41 @@ This command can be used for retrieving a list of application customizers from a
75
75
  <TabItem value="Text">
76
76
 
77
77
  ```text
78
- Name Location Scope Id
79
- -------------------------------------- ----------------------------------------- ----- ------------------------------------
80
- {f405303c-6048-4636-9660-1b7b2cadaef9} ClientSideExtension.ApplicationCustomizer 3 f405303c-6048-4636-9660-1b7b2cadaef9
78
+ Id Location Name Scope
79
+ ------------------------------------ ----------------------------------------- -------------------------------------- -----
80
+ 4a428b32-08cf-45c7-9986-17585af38806 ClientSideExtension.ApplicationCustomizer {4a428b32-08cf-45c7-9986-17585af38806} 3
81
81
  ```
82
82
 
83
83
  </TabItem>
84
84
  <TabItem value="CSV">
85
85
 
86
86
  ```csv
87
- Name,Location,Scope,Id
88
- {f405303c-6048-4636-9660-1b7b2cadaef9},ClientSideExtension.ApplicationCustomizer,3,f405303c-6048-4636-9660-1b7b2cadaef9
87
+ ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
88
+ 9a8b100c-246b-4592-9454-67826523e159,"{""testMessage"":""Test message""}",,,,,4a428b32-08cf-45c7-9986-17585af38806,,ClientSideExtension.ApplicationCustomizer,{4a428b32-08cf-45c7-9986-17585af38806},,0,3,,,65536,HelloWorld,,1.0.1.0
89
89
  ```
90
90
 
91
91
  </TabItem>
92
92
  <TabItem value="Markdown">
93
93
 
94
94
  ```md
95
- # spo applicationcustomizer list --webUrl "https://contoso.sharepoint.com"
95
+ # spo applicationcustomizer list --webUrl "https://contoso.sharepoint.com/sites/Marketing"
96
96
 
97
- Date: 28/2/2023
97
+ Date: 16/05/2024
98
98
 
99
- ## NewsTicker (f405303c-6048-4636-9660-1b7b2cadaef9)
99
+ ## HelloWorld (4a428b32-08cf-45c7-9986-17585af38806)
100
100
 
101
101
  Property | Value
102
102
  ---------|-------
103
- ClientSideComponentId | 4358e70e-ec3c-4713-beb6-39c88f7621d1
104
- CommandUIExtension | null
105
- Description | null
106
- Group | null
103
+ ClientSideComponentId | 9a8b100c-246b-4592-9454-67826523e159
104
+ ClientSideComponentProperties | {"testMessage":"Test message"}
107
105
  HostProperties |
108
- Id | f405303c-6048-4636-9660-1b7b2cadaef9
109
- ImageUrl | null
106
+ Id | 4a428b32-08cf-45c7-9986-17585af38806
110
107
  Location | ClientSideExtension.ApplicationCustomizer
111
- RegistrationId | null
108
+ Name | {4a428b32-08cf-45c7-9986-17585af38806}
112
109
  RegistrationType | 0
113
110
  Scope | 3
114
- ScriptBlock | null
115
- ScriptSrc | null
116
111
  Sequence | 65536
117
- Title | NewsTicker
118
- Url | null
112
+ Title | HelloWorld
119
113
  VersionOfUserCustomAction | 1.0.1.0
120
114
  ```
121
115