Skip to content

Update Storage service READMEs - #7306

Merged
JinmingHu (Jinming-Hu) merged 2 commits into
mainfrom
copilot/issues-5902-5905-storage-readmes
Aug 10, 2026
Merged

Update Storage service READMEs#7306
JinmingHu (Jinming-Hu) merged 2 commits into
mainfrom
copilot/issues-5902-5905-storage-readmes

Conversation

@Jinming-Hu

Copy link
Copy Markdown
Member

Purpose

Update the root READMEs for the Azure Storage Blobs, Data Lake, File Shares, and Queues client libraries to follow the common getting-started documentation format.

Changes

  • Add consistent source, package, API reference, product documentation, and sample links.
  • Document prerequisites, vcpkg manifest installation, CMake configuration, and Azure CLI resource creation.
  • Add service-specific client creation and authentication guidance using DefaultAzureCredential.
  • Refresh key concepts, examples, troubleshooting guidance, next steps, and contribution information.
  • Include the required ShareTokenIntent::Backup option for Azure Files token authentication.

Closes #5902
Closes #5903
Closes #5904
Closes #5905

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added the Storage Storage Service (Queues, Blobs, Files) label Aug 8, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).
8 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).
8 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the root README files for the Azure Storage Blobs, Data Lake, File Shares, and Queues C++ client libraries to follow the common getting-started documentation format used across the repo.

Changes:

  • Adds consistent top-of-page links (source, vcpkg package, API reference, product docs, samples) and reorganizes content into a standard “Getting started / Key concepts / Examples / Troubleshooting / Next steps / Contributing” flow.
  • Documents vcpkg manifest-mode installation, CMake integration, and Azure CLI-based Storage account creation.
  • Introduces Microsoft Entra ID authentication guidance using DefaultAzureCredential, including ShareTokenIntent::Backup for Azure Files token auth.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.

File Description
sdk/storage/azure-storage-blobs/README.md Reformats the Blob library README into the standard getting-started template with updated setup/auth guidance and examples.
sdk/storage/azure-storage-files-datalake/README.md Aligns the Data Lake README with the common template, including HNS prerequisites, auth guidance, and refreshed examples.
sdk/storage/azure-storage-files-shares/README.md Updates the File Shares README to the common template and documents required ShareTokenIntent::Backup for token auth.
sdk/storage/azure-storage-queues/README.md Updates the Queues README to the common template with new setup/auth guidance and streamlined examples.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread sdk/storage/azure-storage-files-shares/README.md Outdated
Comment thread sdk/storage/azure-storage-files-shares/README.md
Comment thread sdk/storage/azure-storage-files-shares/README.md
Comment thread sdk/storage/azure-storage-files-datalake/README.md Outdated
Comment thread sdk/storage/azure-storage-files-datalake/README.md
Comment thread sdk/storage/azure-storage-files-datalake/README.md
Comment thread sdk/storage/azure-storage-queues/README.md
Comment thread sdk/storage/azure-storage-queues/README.md
Comment thread sdk/storage/azure-storage-blobs/README.md
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Jinming-Hu
JinmingHu (Jinming-Hu) merged commit 4144fae into main Aug 10, 2026
85 checks passed
@Jinming-Hu
JinmingHu (Jinming-Hu) deleted the copilot/issues-5902-5905-storage-readmes branch August 10, 2026 21:22
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

3 participants