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

[synapse] Convert samples to markdown format #17657

Merged
merged 2 commits into from
Dec 21, 2020

Conversation

chamons
Copy link
Contributor

@chamons chamons commented Dec 21, 2020

@@ -19,14 +19,4 @@ public class SampleFixture: SamplesBase<SynapseTestEnvironment>
[TearDown]
public void TearDown() => _listener?.Dispose();
}

#pragma warning disable SA1402 // File may only contain a single type
Copy link
Member

Choose a reason for hiding this comment

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

@@ -0,0 +1,64 @@
# Create, Retrieve and Delete a Synapse Role Assignment

This sample demonstrates basic operations with two core classes in this library: `AccessControlClient` and `RoleAssignmentDetails`. `AccessControlClient` is used to call the Azure Synapse service - each method call sends a request to the service's REST API. `RoleAssignmentDetails` is an entity that represents a role assignment within Synapse. The sample walks through the basics of adding, retrieving, and deleting role assignment. To get started, you'll need a connection endpoint to Azure Synapse. See the README for links and instructions.
Copy link
Member

Choose a reason for hiding this comment

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

It would be helpful to link back to the README since we're asking folks to "see" it...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Dang it, I did all of your comments but this one...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@chamons chamons merged commit 47bf086 into Azure:master Dec 21, 2020
@chamons chamons deleted the synapse_markdown_conversion_rebase branch December 21, 2020 20:40
annelo-msft pushed a commit to annelo-msft/azure-sdk-for-net that referenced this pull request Feb 17, 2021
- Converted all synapse samples (both per-existing and those that I wrote) to markdown + cs snippet format
- First pass at documenting the 4-5 that are champion scenarios
- Found and deleting some duplicate snippet + scenarios I found along the way.
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