search

Azure / azure-sdk-for-java

This repository is for active development of the Azure SDK for Java. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/java/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-java.
MIT License
2.3k stars 1.96k forks source link

[BUG] Typo in doc for azure-cosmos-spark: ServicePrinciple not ServicePrincipal #41541

Closed stevenylai closed 4 weeks ago

stevenylai commented 4 weeks ago

Describe the bug As titled, the documentation azure-cosmos-spark has a typo. For example https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/configuration-reference.md

Exception or Stack Trace RuntimeException: Invalid configuration for spark.cosmos.auth.type:ServicePrincipal. Config description: There are two auth types are supported currently: 'MasterKey' (...), 'ServicePrinciple' (...)

To Reproduce Happened when we set spark.cosmos.auth.type=ServicePrincipal as in the doc

Code Snippet

spark.conf.set("spark.sql.catalog.cosmosCatlog.spark.cosmos.auth.type", "ServicePrincipal")

Expected behavior Documentation should be updated to reflect the correct value instead of letting user to set the wrong value and figuring out the correct one from a stack trace.

Screenshots If applicable, add screenshots to help explain your problem.

Setup (please complete the following information):

If you suspect a dependency version mismatch (e.g. you see NoClassDefFoundError, NoSuchMethodError or similar), please check out Troubleshoot dependency version conflict article first. If it doesn't provide solution for the problem, please provide:

Additional context N/A

Information Checklist Kindly make sure that you have added all the following information above and checkoff the required fields otherwise we will treat the issuer as an incomplete report

github-actions[bot] commented 4 weeks ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @kushagraThapar @pjohari-ms @TheovanKraay.

kushagraThapar commented 4 weeks ago

@xinlian12 can you please take a look at this, thanks!

xinlian12 commented 4 weeks ago

The doc has been updated.

stevenylai commented 2 weeks ago

Sorry, which doc has been updated? If I search 'CosmosDB spark connector configuration', the first one I get is https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/tutorial-spark-connector?pivots=programming-language-python and under Configuration parameter reference, it still takes me to the configuration-reference.md in the repo where it says ServicePrincipal all over the place.