Skip to content

docs: improve Azure SQL Managed Identity authentication documentation #838

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

Merged
merged 2 commits into from
Aug 20, 2025

Conversation

d-bytebase
Copy link
Contributor

Summary

  • Improved Azure SQL authentication documentation to emphasize the most secure approach using VM-attached managed identities
  • Aligned documentation structure with AWS and GCP sections for consistency
  • Removed screenshots in favor of text-based instructions with official Microsoft documentation links

Changes

  • Renamed section: Changed from "Entra Managed Identity" to "Azure SQL with Managed Identity Authentication" for better clarity
  • Security-first approach: Emphasized VM system-assigned managed identity as the primary method (no credential management needed)
  • Enhanced documentation references: Added comprehensive links to official Azure documentation throughout
  • Improved SQL examples: Added detailed permission examples with security best practices
  • Removed images: Deleted 3 webp screenshots, replacing with clear text instructions and documentation links
  • Added alternatives: Included user-assigned managed identity configuration for advanced scenarios
  • Clarified requirements: Explicitly noted that no AZURE_TENANT_ID or AZURE_CLIENT_SECRET are needed with managed identities

Test plan

  • Verified all Azure documentation links are valid and point to correct resources
  • Confirmed terminology matches Bytebase UI ("Azure Default Credential")
  • Validated SQL syntax for creating users and granting permissions
  • Ensured consistency with AWS and GCP authentication sections

🤖 Generated with Claude Code

- Renamed section from "Entra Managed Identity" to "Azure SQL with Managed Identity Authentication" for clarity
- Restructured content to follow the same secure pattern as AWS and GCP sections
- Emphasized VM-attached managed identity approach as the most secure method
- Added comprehensive Azure documentation references throughout
- Included security best practices and production recommendations
- Removed screenshots in favor of text instructions with official documentation links
- Added step-by-step configuration with proper SQL permission examples
- Clarified that no credentials (AZURE_TENANT_ID, AZURE_CLIENT_SECRET) are needed with managed identities
- Added alternative user-assigned managed identity configuration
- Improved readability with consistent formatting and structure

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@Copilot Copilot AI review requested due to automatic review settings August 20, 2025 08:05
Copy link

vercel bot commented Aug 20, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Ready Preview Comment Aug 20, 2025 8:15am

Copy link

github-actions bot commented Aug 20, 2025

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 16 broken links in 9 files

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

@h3n4l h3n4l merged commit 4575b2b into main Aug 20, 2025
4 of 5 checks passed
@h3n4l h3n4l deleted the improve-azure-managed-identity-docs branch August 20, 2025 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants