Azure-docs: Install the agent using the command line failing: OPINSIGHTS_WORKSPACE_KEY contains unsafe characters

[Jnchi]

The OPINSIGHTS_WORKSPACE_KEY contains characters that don't play nicely, e.g., '/', '+', '='; resulting in the installer failing.

I'm using the following command in a script,

MMASetup-AMD64.exe /C:"setup.exe /qn NOAPM=1 ADD_OPINSIGHTS_WORKSPACE=1 OPINSIGHTS_WORKSPACE_AZURE_CLOUD_TYPE=0 OPINSIGHTS_WORKSPACE_ID=[ . . . REDACTED . . . ] OPINSIGHTS_WORKSPACE_KEY=[ . . . REDACTED . . . ] AcceptEndUserLicenseAgreement=1"

Which results in a popup stating, "Command line option syntax error. Type Command /? for Help."

I can paste the key in during interactive installations, but that defeats the whole purpose.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 00a00a3e-a0df-7ee5-4733-7231bd7a024f
• Version Independent ID: 94361683-e1e7-7e55-6993-86d3c2486a14
• Content: Connect Windows computers to Azure Log Analytics
• Content Source: articles/azure-monitor/platform/agent-windows.md
• Service: log-analytics
• GitHub Login: @MGoedtel
• Microsoft Alias: magoedte

[femsulu]

Hi @Jnchi thanks for your comment. Would like to better understand your issue/request. are you asking for an update to the documentation or is this a request for technical support?

[Jnchi]

An issue is just what it sounds like; a problem discovered while following the documentation. In either case it doesn't work as expected.

[femsulu]

My question is, are you asking that we update documentation to highlight there are certain characters that are unsupported. Or you are looking for help in debugging the issue you encountered after following the steps. If there are documentaiton issues with the steps or a bug in the steps then this is the right channel.
if you are looking for technical assitance with your issue then your issue is best served in our Log Analytics Forum or support channels.
Hope that helps.

[Jnchi]

Clearly you don't seem to understand the purpose of Github Issues. Here are a few resources for you so that you are better equipped for the next time:

Please use the Feedback tool at the bottom of any article to submit bugs and suggestions.
--https://github.com/MicrosoftDocs/azure-docs/blob/master/CONTRIBUTING.md#reporting-bugs-and-suggesting-enhancements

Note: In case you missed it, this is the proper way for Reporting Bugs.

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
--https://guides.github.com/features/issues

Note: Again, GitHub Issues are designed for reporting bugs in a project.

--

Also, as it turns out, the issue is that the command in question is too long and therefore appears to be getting truncated, resulting in a syntax error, due to a missing ending quotation mark.

The following is an excerpt from an email with support, which I filed before creating this issue.
One of the developers reached out personally and gave me these tips, which I am sharing for posterity:

After reproducing the problem myself, as a first mitigation, it looks like there are two factors (probably bugs) that are causing the command to fail:
1. Command length – after a certain length of the command, it fails to parse the syntax regardless of its content. If you remove the part OPINSIGHTS_WORKSPACE_AZURE_CLOUD_TYPE=0 (which is 0 by default), then you are in the safe length of the command.
2. use “ instead of ‘:
-If you are using command prompt (.bat,.cmd) please use “ as follows:
MMASetup-AMD64.exe /C:"setup.exe /qn NOAPM=1 ADD_OPINSIGHTS_WORKSPACE=1 OPINSIGHTS_WORKSPACE_ID='BBB' OPINSIGHTS_WORKSPACE_KEY='AAA' AcceptEndUserLicenseAgreement=1"
-If you are using Powershell, you can continue using ‘.

Please update the documentation accordingly to reflect the issue presented.

[femsulu]

The way you framed your initial question was confusing which is why I asked you to clarify. I am very familiar with the process. All i asked was for you to clarify your question. Feel free to reach out directly via [email protected] if you would like to discuss this further.

[jordanmills]

There is no documentation on configuring the agent to send events from a remote computer or to send events from forwarded logs instead of the local security log. This is critical for high value servers like domain controllers and certification authorities, and "appliance" computers, where random binaries can't be installed locally.