search

MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.22k stars 21.37k forks source link

Missing reference to more useful secret function #81178

Closed dazfuller closed 4 months ago

dazfuller commented 3 years ago

Hi

I was just working my way through this article and trying to implement in Synapse and I feel that the getSecretWithLS function should be documented here.

At the moment the documentation calls out the getSecret function which requires the user to provide the key vault name, secret name, and optionally the linked service name. This is counter intuitive when previously in the docs it advises the user to create a linked service. To remedy this it would be useful for the documentation to draw attention to the getSecretWithLS method which takes the linked service name and the secret name. So something more like

import com.microsoft.azure.synapse.tokenlibrary.TokenLibrary

val secretValue: String = TokenLibrary.getSecretWithLS("<LINKED SERVICE NAME>", "<SECRET KEY>")
println(secretValue)

This allows for a more repeatable pattern to be implemented in notebooks allowing for a smoother delivery to production.

Document Details

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

himanshusinha-msft commented 3 years ago

Thanks for the feedback and bringing this to our notice . At this time we are reviewing the feedback and will update the document as appropriate .

himanshusinha-msft commented 3 years ago

We have assigned the issue to the content author . They will evaluate & update the document as appropriate

dazfuller commented 2 years ago

Apologies, as an update to this it's probably worth looking at how this is presented. Buried in one of the other pages is a link to the Microsoft Spark Utilities, which provides a wrapper over the top of the TokenLibrary and a lot of other useful features. This should probably be the preferred method of accessing secrets.

dazfuller commented 1 year ago

@himanshusinha-msft has there been any movement on this at all?

bandersmsft commented 4 months ago

Thanks for your dedication to our documentation. Unfortunately, at this time we have been unable to review your issue in a timely manner and we sincerely apologize for the delayed response. We are closing this issue for now, but if you feel that it's still a concern, please respond and let us know. If you determine another possible update to our documentation, please don't hesitate to reach out again. #please-close