Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

{Azure Functions} Nuget package for Azure Functions used in Isolated Process should be mentioned. #38056

Merged
merged 2 commits into from
Aug 21, 2023

Conversation

navba-MSFT
Copy link
Contributor

Docs: https://learn.microsoft.com/en-us/dotnet/api/overview/azure/microsoft.azure.webjobs.extensions.storage.blobs-readme?view=azure-dotnet
This document should perhaps say at the top that the package is not compatible with Azure Functions used in Isolated Process mode; this can only be used with an in-process Azure Functions app. This will avoid confusion mong our customers.
As the isolated functions use : Microsoft.Azure.Functions.Worker.Extensions.Storage.Blobs NuGet package, version 5.x.

fixes #37957

Contributing to the Azure SDK

Please see our CONTRIBUTING.md if you are not familiar with contributing to this repository or have questions.

For specific information about pull request etiquette and best practices, see this section.

@github-actions github-actions bot added the Storage Storage Service (Queues, Blobs, Files) label Aug 7, 2023
@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

@navba-MSFT
Copy link
Contributor Author

@seanmcc-msft @amnguye Could you please review this PR once you get a chance ? Thanks in advance.

Copy link
Member

@amnguye amnguye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure this is something we want in our README. I think the point of the README is to give an introduction to the library.. and not a "but if this is your scenario, you want to go here or go there". I think that should be rather put in the getting started guide. Or the introduction to the feature of the azure functions worker, like if this is your scenario, use this, and if it's this use that.

I understand the customer's frustration of "if only this was said exactly here then I wouldn't have gone down the rabbit hole here" however at some point we need to draw the line. It's going to increase to us including all kinds of products to use in our read me.

@amnguye
Copy link
Member

amnguye commented Aug 11, 2023

I'm comfortable updating the first line to something like "This extension provides functionality for accessing Azure Storage Blobs in Azure Functions within the process."

I think this would ease the customer's ask here while not becoming a one stop shop of a guide map to other Azure Products.

@navba-MSFT
Copy link
Contributor Author

I'm comfortable updating the first line to something like "This extension provides functionality for accessing Azure Storage Blobs in Azure Functions within the process."

I think this would ease the customer's ask here while not becoming a one stop shop of a guide map to other Azure Products.

@amnguye Your suggestions have been incorporated. Could you please review and marge this once you get a chance ?

@amnguye amnguye merged commit eb9c2a5 into main Aug 21, 2023
@amnguye amnguye deleted the navba-MSFT-patch-4 branch August 21, 2023 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should indicate that it cannot be used in Isolated Process
3 participants