spo customaction set with --clientSideComponentProperties param results in invalid JSON object

Running the command:

o365 spo customaction set -u https://<tenant>.sharepoint.com/sites/<site> -i<id> -s Web -p '{"testMessage":"Test message"}'

Results in the following when running the corresponding get command:

o365 spo customaction get -u https://<tenant>.sharepoint.com/sites/<site>-i <id> -s Web -o JSON
ClientSideComponentId        : <id>
ClientSideComponentProperties: '{testMessage:Test message}'
CommandUIExtension           : null
Description                  : null
Group                        : null
Id                           : <customActionId>
ImageUrl                     : null
Location                     : ClientSideExtension.ApplicationCustomizer
Name                         : {<customActionId>}
RegistrationId               : null
RegistrationType             : 0
Rights                       : {"High":"0","Low":"0"}
Scope                        : Web
ScriptBlock                  : null
ScriptSrc                    : null
Sequence                     : 65536
Title                        : <customActionTitle>
Url                          : null
VersionOfUserCustomAction    : 0.9.22.9201

Expected behaviour:

• The value of the ClientSideComponentProperties property should be a valid JSON object
• When the value is parsed by SPFx app customizer code that inherits from the BaseApplicationCustomizer object - the properties object should be hydrated with the “testMessage” value.

Observed behaviour:

• The value of the ClientSideComponentProperties property is not a valid JSON object
• The value parsed by the SPFx app customizer code inheriting BaseApplicationCustomizer - the properties object has no properties

I suspect the above behaviour might be due to the way a POST to the _api/<scope>/UserCustomActions end point processes the ClientSideComponentProperties payload, and not the way the parameter is parsed by spo customaction set - but wanted to raise it here first to see if there’s anything that can be done in office365-cli

[waldekmastykarz]

From what I’ve seen, the first part of processing quotes happens already in the shell so if incorrectly quoted JSON string is passed into the CLI, it might be tough to make something out of it.

[VelinGeorgiev]

Here are my findings for tonight: Windows 8.1

o365 spo customaction set --url https://xxx.sharepoint.com/sites/xx --id  815860e5-c83a-43aa-a69c-28a936e2d812 -p '{\"instrumentationKey\":\"58b2b73e-82b5-4808-a969-a18cbbd36999\",\"logLevel\":\"1\",\"testMessage\":\"\"}' 

Works for:

• cmder (ConEmu [64] (version 171025))
• Windows command prompt

Does not work for:

• Windows PowerShell.exe - Error: 500. The body in the request is {"ClientSideComponentProperties":"{"}

I managed to make it work with the Windows PowerShell using:

o365 spo customaction set --url https://xxx.sharepoint.com/sites/xxx --id  81
5860e5-c83a-43aa-a69c-28a936e2d812 -p "{'instrumentationKey':'58b2b73e-82b5-4808-a969-a18cbbd36999','logLevel':'1','test
Message':''}"

Body request is

{"ClientSideComponentProperties":"{'instrumentationKey':'58b2b73e-82b5-4808-a969-a18cbbd36999','logLevel':'1','
testMessage':''}"}

Seems the web service is able to convert single quote successfully, but this is pure luck.

Will keep you posted if I find the secret formula for PowerShell.exe

UPDATE: The node command prompt worked with both (Nodejs v8.9.1):

o365 spo customaction set --url https://xxx.sharepoint.com/sites/xxx --id  815860e5-c83a-43aa-a69c-28a936e2d812 -p '{\"instrumentationKey\":\"58b2b73e-82b5-4808-a969-a18cbbd36999\",\"logLevel\":\"1\",\"testMessage\":\"\"}'

o365 spo customaction set --url https://xxx.sharepoint.com/sites/xxx --id  815860e5-c83a-43aa-a69c-28a936e2d812 -p "{'instrumentationKey':'58b2b73e-82b5-4808-a969-a18cbbd36999','logLevel':'1','testMessage':''}"