EntraID support for DataSync #28464

ssubramanya · 2025-08-26T10:16:50Z

Description

Note:

The files under "Sql.Management.Sdk" are generated except readme.md - So Please use that as just reference to review for the API calls if needed. Thanks!

Summary of Changes

Draft PR Notice

This is a draft PR.

The required API spec PR is not yet committed.
Raising this early for review to ensure all changes are aligned.
Once the API spec is merged, the only remaining step will be to commit and finalize this implementation.

Added UAMI Support

Added UAMI support for Data Sync cmdlets.
Introduced three new parameters across New-* and Update-* cmdlets:
- HubDatabaseAuthenticationType
- MemberDatabaseAuthenticationType
- IdentityId

These parameters allow customers to:

Select authentication type (Password or UserAssigned)
Optionally provide a user-assigned identity.

Backward Compatibility

The latest API version now makes the Identity field mandatory on sync group/member resources.
To avoid breaking existing customers using username/password authentication:
- Cmdlets automatically pass Identity = { Type = "None" } in the background.
- This ensures:
  - No visible changes in behavior
  - Password-based authentication continues to work without requiring new parameters.

Validation Logic

Password authentication
- Requires Username and Password.
UserAssigned authentication
- Requires IdentityId when creating new resources.
Update behavior
- If UserAssigned is specified without IdentityId, cmdlet preserves the existing identity instead of throwing.
- This supports partial updates intentionally.

Help and Documentation

Updated cmdlet help files with:
- New parameters and their accepted values (Password, UserAssigned)
- Examples for both password and UAMI flows.

Resource Strings

Added localized error messages for:
- Missing credentials
- Missing IdentityId
- Invalid authentication type

Testing

No scenario tests yet
- Data Sync scenario tests record once and capture API responses.
- Since the new API version is not yet available in stage, reliable baselines cannot be recorded.
Planned tests (once stage is ready):
- Creating sync groups and members with UAMI authentication
- Updating existing groups/members to use UAMI
- Backward compatibility with password authentication
For now:
- Changes validated by code inspection only
- Tests will be added as a follow-up.

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

azure-client-tools-bot-prd · 2025-08-26T10:16:52Z

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

microsoft-github-policy-service · 2025-08-26T10:17:20Z

Thank you for your contribution @ssubramanya! We will review the pull request and get back to you soon.

pranavathalye · 2025-08-26T11:54:05Z

src/Sql/Sql.Management.Sdk/Generated/Models/DataSyncParticipantIdentity.cs

+        /// Gets or sets the Datasync identity type Possible values include: &#39;None&#39;, &#39;SystemAssigned&#39;, &#39;UserAssigned&#39;, &#39;SystemAssignedUserAssigned&#39;
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "type")]
+        public string Type {get; set; }


Why is string chosen instead of enum?

pranavathalye · 2025-08-26T11:54:44Z

src/Sql/Sql.Management.Sdk/Generated/Models/DataSyncParticipantIdentity.cs

+        /// </exception>
+        public virtual void Validate()
+        {
+            if (this.Type == null)


Also check that type is one of three supported values?

What about validating other fields?

pranavathalye · 2025-08-26T11:56:30Z

src/Sql/Sql.Management.Sdk/Generated/Models/DataSyncParticipantIdentity.cs

+
+        /// <param name="userAssignedIdentities">The resource ids of the user assigned identities to use
+        /// </param>
+        public DataSyncParticipantIdentity(string type, System.Guid? tenantId = default(System.Guid?), System.Collections.Generic.IDictionary<string, DataSyncParticipantUserAssignedIdentity> userAssignedIdentities = default(System.Collections.Generic.IDictionary<string, DataSyncParticipantUserAssignedIdentity>))


Nit: Line too long. Needs a break

pranavathalye · 2025-08-26T11:59:16Z

src/Sql/Sql.Management.Sdk/Generated/Models/DataSyncParticipantUserAssignedIdentity.cs

+
+        /// <param name="clientId">The Azure Active Directory client id.
+        /// </param>
+        public DataSyncParticipantUserAssignedIdentity(System.Guid? principalId = default(System.Guid?), System.Guid? clientId = default(System.Guid?))


Should default values be picked up here? I see a private setters. If these are mandatory data, it may be worth considering not defaulting.

pranavathalye · 2025-08-26T12:11:36Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncGroup.cs

+        /// Gets or sets sync group authentication information.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "identity")]
+        public DataSyncParticipantIdentity Identity {get; set; }


Constructor takes identity as a mandatory param. Considering that, is private setter appropriate?

pranavathalye · 2025-08-26T12:16:39Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncGroup.cs

@@ -186,10 +196,18 @@ public SyncGroup()
        /// </exception>
        public virtual void Validate()
        {
+            if (this.Identity == null)


Nit: Shorten with _ = this.Identity ?? throw new Microsoft.Rest.ValidationException(Microsoft.Rest.ValidationRules.CannotBeNull, "Identity");

pranavathalye · 2025-08-26T12:17:27Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncGroup.cs

            if (this.Sku != null)
            {
                this.Sku.Validate();
            }
+            if (this.Identity != null)


Nit: Shorten with this.Identity?.Validate()

pranavathalye · 2025-08-26T12:18:37Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncGroupProperties.cs

@@ -8,7 +8,7 @@ namespace Microsoft.Azure.Management.Sql.Models
    using System.Linq;

    /// <summary>
-    /// Properties of a sync group.
+    /// Properties of a sync group with support to MI.


Nit: with support for MI and SQL auth

pranavathalye · 2025-08-26T12:19:35Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncGroupsCreateOrUpdateHeaders.cs

+{
+    using System.Linq;
+
+    public partial class SyncGroupsCreateOrUpdateHeaders


/// <summary> /// <Brief summary> /// </summary>

pranavathalye · 2025-08-26T12:21:33Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncGroupsUpdateHeaders.cs

+{
+    using System.Linq;
+
+    public partial class SyncGroupsUpdateHeaders


If we already have SyncGroupsCreateOrUpdateHeaders why can't we reuse that class for update?

pranavathalye · 2025-08-26T12:23:22Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncMember.cs

+        /// Gets or sets sync member authentication information.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "identity")]
+        public DataSyncParticipantIdentity Identity {get; set; }


Constructor takes identity as a mandatory param. Considering that, is private setter appropriate?

pranavathalye · 2025-08-26T12:24:05Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncMember.cs

+        /// </exception>
+        public virtual void Validate()
+        {
+            if (this.Identity == null)


Nit: Use ?? operator?

pranavathalye · 2025-08-26T12:24:21Z

src/Sql/Sql.Management.Sdk/Generated/Models/SyncMember.cs

+            }
+            if (this.Identity != null)
+            {
+                this.Identity.Validate();


Nit: Use ?. operator?

microsoft-github-policy-service · 2025-08-28T05:55:25Z

@ssubramanya please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

EntraID support for DataSync

faaa402

microsoft-github-policy-service bot added the customer-reported label Aug 26, 2025

Changelog.md changes

77ce50e

pranavathalye reviewed Aug 26, 2025

View reviewed changes

EntraID support for DataSync #28464

Are you sure you want to change the base?

EntraID support for DataSync #28464

Conversation

ssubramanya commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Note:

Summary of Changes

Draft PR Notice

Added UAMI Support

Backward Compatibility

Validation Logic

Help and Documentation

Resource Strings

Testing

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Aug 26, 2025

Uh oh!

microsoft-github-policy-service bot commented Aug 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pranavathalye Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

microsoft-github-policy-service bot commented Aug 28, 2025

Contribution License Agreement

Uh oh!

Uh oh!

ssubramanya commented Aug 26, 2025 •

edited

Loading

pranavathalye Aug 26, 2025 •

edited

Loading