Skip to content

Add cleanroom SDK CLI samples and SDK walkthrough doc#98

Open
ShreyaSangwa wants to merge 4 commits into
Azure-Samples:managedfrom
ShreyaSangwa:sdk_update
Open

Add cleanroom SDK CLI samples and SDK walkthrough doc#98
ShreyaSangwa wants to merge 4 commits into
Azure-Samples:managedfrom
ShreyaSangwa:sdk_update

Conversation

@ShreyaSangwa

@ShreyaSangwa ShreyaSangwa commented Jun 1, 2026

Copy link
Copy Markdown

Purpose

Adds SDK-based command-line samples for both management plane and frontend dataplane flows, and introduces a full SDK walkthrough document that replaces the managedcleanroom CLI dependency for this path.

Does this introduce a breaking change?

  • Yes
  • No

Pull Request Type

What kind of change does this Pull Request introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Documentation content changes
  • Other... Please describe:

Summary of All Changes

  • Added a new end-to-end SDK guide in README-SDK.md covering setup, auth modes, workflow steps, and troubleshooting for cleanroom-mgmt + afe commands.
  • Added a management-plane CLI sample project in packages\mgmt-sample\CleanRoomMgmtSample.csproj and packages\mgmt-sample\Program.cs.
  • Management CLI implements collaboration operations: create, get, list, delete, enable-workload, add-collaborator, recover, pause, resume, get-readonly-kubeconfig.
  • Management CLI also adds consortia operations: create, get, list, delete.
  • Added a frontend dataplane CLI sample project in packages\sample\AnalyticsFrontendSample.csproj and packages\sample\Program.cs.
  • Frontend CLI supports endpoint-based operations for collaborations, analytics, OIDC, invitations, datasets, consent, queries, runs, secrets, and audit events.
  • Frontend CLI includes both auth paths: DefaultAzureCredential and MSAL device-code, plus optional insecure TLS mode for dev/test.
  • Added repository-level NuGet source config in NuGet.Config, and per-project NuGet configs inpackages\mgmt-sample\NuGet.config and packages\sample\NuGet.config, to resolve local package artifacts.
  • Updated ignore behavior in .gitignore to preserve sample sources under packages/sample while still ignoring generic package/build outputs.
  • Added local package artifacts required by the sample projects: packages\Azure.ResourceManager.CleanRoom.1.0.0-alpha.20260603.1.nupkg and packages\Azure.Cleanroom.Analytics.Frontend.Client.1.0.0-beta.1.nupkg.

How to Test

  • Get the code
git clone https://github.com/ShreyaSangwa/azure-cleanroom-samples.git
cd azure-cleanroom-samples
git checkout sdk_update
  • Build and validate frontend sample:
dotnet restorepackages\sample\AnalyticsFrontendSample.csproj
dotnet build packages\sample\AnalyticsFrontendSample.csproj -nologo
dotnet run --project packages\sample\AnalyticsFrontendSample.csproj -- --help
  • Build and validate management sample:
dotnet restore packages\mgmt-sample\CleanRoomMgmtSample.csproj
dotnet build packages\mgmt-sample\CleanRoomMgmtSample.csproj -nologo
dotnet run --project packages\mgmt-sample\CleanRoomMgmtSample.csproj -- --help

Expected Result

Verify that the following are valid

  • Both projects restore and build successfully.
  • Help output is displayed for both CLIs.
  • No unintended generated runtime artifacts are included in the PR.

@ShreyaSangwa ShreyaSangwa requested a review from a team as a code owner June 1, 2026 11:13
@ShreyaSangwa ShreyaSangwa changed the title Add dataplane SDK sample source files and docs Add cleanroom SDK CLI samples and SDK walkthrough doc Jun 9, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

@ShreyaSangwa 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.

  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.
  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.

Comment thread README-SDK.md
# Run this block in every terminal that will call the SDK CLIs.
# If your terminal starts in C:\Users\...\Downloads\sample, move into the repo first.

dotnet restore .\packages\mgmt-sample\CleanRoomMgmtSample.csproj

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Can we create a new csproject for samples, and use the sdk generated from above inside the .cs file for testing?

Comment thread NuGet.Config
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

What needs to be added if the goal is “create packages for two folders”
If by “create packages” you mean the repo should generate those .nupkg files instead of checking them in manually, then you need a packaging step for each SDK source project.

  1. Add packable SDK project(s)
    You need the actual SDK source projects somewhere, for example:

sdk/management/Azure.ResourceManager.CleanRoom/Azure.ResourceManager.CleanRoom.csproj
sdk/frontend/Azure.Cleanroom.Analytics.Frontend.Client/Azure.Cleanroom.Analytics.Frontend.Client.csproj
Those projects must include package metadata and be packable, e.g.:

sdk/management/Azure.ResourceManager.CleanRoom/Azure.ResourceManager.CleanRoom.csproj


net8.0
false
true
Azure.ResourceManager.CleanRoom
and similarly for frontend:

sdk/frontend/Azure.Cleanroom.Analytics.Frontend.Client/Azure.Cleanroom.Analytics.Frontend.Client.csproj


net8.0
true
Azure.Cleanroom.Analytics.Frontend.Client
1.0.0-beta.1
2. Add a pack command for both projects
You need a build script or workflow that runs something like:

pack-sdks.sh
dotnet pack sdk/management/Azure.ResourceManager.CleanRoom/Azure.ResourceManager.CleanRoom.csproj -c Release -o ./packages
dotnet pack sdk/frontend/Azure.Cleanroom.Analytics.Frontend.Client/Azure.Cleanroom.Analytics.Frontend.Client.csproj -c Release -o ./packages

That is the missing “create packages for two folders” step.

  1. Ensure sample projects restore from that output folder
    This part is already mostly done.

Repo root NuGet.Config points to:

NuGet.Config

Per-sample NuGet.config points to:

packages/mgmt-sample/NuGet.config
v2

and same for packages/sample/NuGet.config.

That means each sample looks one directory up, i.e. packages/, where the .nupkg files live.

Comment thread README-SDK.md
dotnet restore .\packages\sample\AnalyticsFrontendSample.csproj

# Verify
dotnet run --project .\packages\mgmt-sample\CleanRoomMgmtSample.csproj -- --help

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This looks directionally right for consuming local SDK packages, but I think we’re still missing the package-production side of the flow.

The expectation for this change was to support two separately generated NuGet packages — one for the management SDK and one for the frontend SDK — and then use those packages from the sample Program.cs apps. Right now the PR adds the sample consumers and local NuGet.config files, but it appears to rely on checked-in .nupkg artifacts rather than defining how those packages are actually produced.

A few things I think we should add/clarify:

Source-of-truth for package generation

Where are the SDK source projects that produce:
Azure.ResourceManager.CleanRoom
Azure.Cleanroom.Analytics.Frontend.Client
We should have a documented or scripted dotnet pack flow for both.
Package output location

The two sample projects should remain normal PackageReference consumers of those package IDs/versions.
NuGet.config should point to the generated package feed location.
Docs/build instructions

We should document the expected sequence explicitly:
build/pack management SDK
build/pack frontend SDK
restore/build mgmt-sample
restore/build sample
Ignore rules

Suggested direction:

add a script/workflow that runs dotnet pack for both SDK projects
output packages to a dedicated local feed folder
update NuGet.config to consume from that folder
avoid relying on committed .nupkg binaries as the long-term model
If you want, I can also rewrite this into a shorter, more direct review comment for inline PR use

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