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

[Storage] Improve documentation / samples around using non-standard account URLs #25536

Open
jalauzon-msft opened this issue Aug 3, 2022 · 0 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files)

Comments

@jalauzon-msft
Copy link
Member

jalauzon-msft commented Aug 3, 2022

We get many questions/issues from customers attempting to use non-standard account URLs (CDN, partitioned DNS, custom domains, etc.) so it would seem our documentation about how to handle this scenario could use some improvement. Updating the documentation for client constructors around non-standard account URLs and the when/how to use the credential dictionary would go a long way.

Additionally adding a sample for how to use the dictionary credential for this case would be helpful to direct people towards as well. Something that shows this use case:

credential = {"account_name": "account-name", "account_key": "<account-key>"}
client = BlobServiceClient(
    account_url="https://account-name.zXX.blob.storage.azure.net/",
    credential=credential
)

An extension of this could be to consider updating our automatic account name parsing logic to handle more cases, like partitioned DNS.

@jalauzon-msft jalauzon-msft added Storage Storage Service (Queues, Blobs, Files) Client This issue points to a problem in the data-plane of the library. labels Aug 3, 2022
@github-actions github-actions bot added needs-triage This is a new issue that needs to be triaged to the appropriate team. and removed needs-triage This is a new issue that needs to be triaged to the appropriate team. labels Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

No branches or pull requests

2 participants