Update guide_azure.rst

[ubruns]

+label: docsite_pr

SUMMARY

Added a note to the 'Storing in a file' section, that the secret value of the ini file should be UrlEncoded.
Otherwise the user might get login errors (depends on the characters used in the secret).

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

guide_azure.rst

ADDITIONAL INFORMATION

If the secret of the azure service principal contains unusual characters, the login will fail.
The secret must be urlencoded() to avoid this login error.

See also this discussion, wich got me to the solution:
https://stackoverflow.com/questions/42477266/aadsts50012-invalid-client-secret-is-provided-when-moving-from-a-test-app-to-pr

[ansibot]

cc @acozine
click here for bot help

[Akasurde]

cc @yuwzho @zikalino

[yuwzho]

+label azure

Hi @ubruns Thanks for your reporting. My thinking is that user no need to do the url encode for no matter username or secret, if so, it should be a code bug. @lmazuel Would you give some information about this from SDK side?

[acozine]

@yuwzho would it be correct to say If your secrets contain non-ASCII characters, you must URL Encode them to avoid login errors.?

[yuwzho]

@acozine Actually I am thinking about handling this in code level. It doesn't make sense from user's perspective to do the encoding in no matter .ini file or environment variable, right?

[acozine]

@yuwzho handling this in the code seems like a smart approach - then users don't need to worry about encoding. What's the timeframe on changing the code? It might make sense to merge this docs PR now if the code fix is going to take days or weeks.

[ansibot]

The test ansible-test sanity --test docs-build [explain] failed with 1 error:

docs/docsite/rst/scenario_guides/guide_azure.rst:112:0: warning: Unknown target name: "url encode<https://www.w3schools.com/tags/ref_urlencode.asp>".

The test ansible-test sanity --test rstcheck [explain] failed with 1 error:

docs/docsite/rst/scenario_guides/guide_azure.rst:112:0: Unknown target name: "url encode<https://www.w3schools.com/tags/ref_urlencode.asp>".

click here for bot help

[yuwzho]

I am a bit busy these time, would you like to propose a change? The code snippet should be at these lines around @acozine

ansible/lib/ansible/module_utils/azure_rm_common.py

Lines 1076 to 1080 in 08c7dd9

	self.azure_credentials = ServicePrincipalCredentials(client_id=self.credentials['client_id'],
	secret=self.credentials['secret'],
	tenant=self.credentials['tenant'],
	cloud_environment=self._cloud_environment,
	verify=self._cert_validation_mode == 'validate')

[acozine]

@yuwzho I'm a docs person, not a developer, so I'll leave the code changes for someone else to do. Once this PR passes Shippable, I'm going to merge it, then open an issue for the code change.

[acozine]

Thanks @ubruns for the docs fix.

I've created issue #54914 for the code changes @yuwzho.