Update snippet replacement syntax (Azure#25679)

annelo-msft · web-flow · commit 73cbe40ac5e6 · 2021-12-03T21:53:53.000Z
diff --git a/sdk/synapse/Azure.Analytics.Synapse.AccessControl/tests/samples/Sample1_HelloWorld.cs b/sdk/synapse/Azure.Analytics.Synapse.AccessControl/tests/samples/Sample1_HelloWorld.cs
@@ -22,8 +22,11 @@ public void AddAndRemoveRoleAssignmentSync()
         {
             #region Snippet:CreateAccessControlClient
             // Replace the string below with your actual endpoint url.
+#if SNIPPET
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
 
             RoleAssignmentsClient roleAssignmentsClient = new RoleAssignmentsClient(new Uri(endpoint), new DefaultAzureCredential());
             RoleDefinitionsClient definitionsClient = new RoleDefinitionsClient(new Uri(endpoint), new DefaultAzureCredential());
@@ -38,15 +41,21 @@ public void AddAndRemoveRoleAssignmentSync()
                 Single(role => role.GetProperty("name").ToString() == "Synapse Administrator");
             Guid adminRoleId = new Guid(adminRoleJson.GetProperty("id").ToString());
 
+#if SNIPPET
             string assignedScope = "workspaces/<my-workspace-name>";
-            /*@@*/assignedScope = "workspaces/" + TestEnvironment.WorkspaceName;
+#else
+            string assignedScope = "workspaces/" + TestEnvironment.WorkspaceName;
+#endif
 
             // Replace the string below with the ID you'd like to assign the role.
             Guid principalId = /*<my-principal-id>"*/ Guid.NewGuid();
 
             // Replace the string below with the ID of the assignment you'd like to use.
+#if SNIPPET
             string assignmentId = "<my-assignment-id>";
-            /*@@*/assignmentId = Guid.NewGuid().ToString();
+#else
+            string assignmentId = Guid.NewGuid().ToString();
+#endif
             #endregion
 
             #region Snippet:CreateRoleAssignment
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample2_HelloWorldNotebook.md b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample2_HelloWorldNotebook.md
@@ -18,7 +18,7 @@ To create an notebook, first create one or more `NotebookCell` with contents, an
 
 ```C# Snippet:ConfigureNotebookResource
 string notebookName = "Test-Notebook";
-var cell = new NotebookCell("code", new NotebookMetadata (), new string[] {
+var cell = new NotebookCell("code", new NotebookMetadata(), new string[] {
     "from azureml.opendatasets import NycTlcYellow\n",
     "\n",
     "data = NycTlcYellow()\n",
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample3_HelloWorldTrigger.md b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample3_HelloWorldTrigger.md
@@ -1,7 +1,6 @@
 ```C# Snippet:CreateTriggerClientPrep
 // Replace the string below with your actual endpoint url.
 string endpoint = "<my-endpoint-url>";
-
 string triggerName = "Test-Trigger";
 ```
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample4_HelloWorldDataFlow.md b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample4_HelloWorldDataFlow.md
@@ -1,7 +1,6 @@
 ```C# Snippet:CreateDataFlowClientPrep
 // Replace the string below with your actual endpoint url.
 string endpoint = "<my-endpoint-url>";
-
 string dataFlowName = "Test-DataFlow";
 ```
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample5_HelloWorldDataset.md b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample5_HelloWorldDataset.md
@@ -1,9 +1,7 @@
 ```C# Snippet:CreateDatasetClientPrep
 // Replace the string below with your actual endpoint url.
 string endpoint = "<my-endpoint-url>";
-
 string storageName = "<my-storage-name>";
-
 string dataSetName = "Test-Dataset";
 ```
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample6_HelloWorldLinkedService.md b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/samples/Sample6_HelloWorldLinkedService.md
@@ -4,7 +4,6 @@ string endpoint = "<my-endpoint-url>";
 
 // Replace the string below with your actual datalake endpoint url.
 string dataLakeEndpoint = "<my-datalake-url>";
-
 string serviceName = "Test-LinkedService";
 ```
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample1_HelloWorldPipeline.cs b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample1_HelloWorldPipeline.cs
@@ -21,9 +21,12 @@ public partial class Sample1_HelloWorldPipeline : SamplesBase<SynapseTestEnviron
         public async Task RunPipeline()
         {
             #region Snippet:CreatePipelineClientPrep
+#if SNIPPET
             // Replace the string below with your actual endpoint url.
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
 
             string pipelineName = "Test-Pipeline";
             #endregion
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample2_HelloWorldNotebook.cs b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample2_HelloWorldNotebook.cs
@@ -21,15 +21,18 @@ public partial class Sample2_HelloWorldNotebook : SamplesBase<SynapseTestEnviron
         public async Task CreateAndUploadNotebook()
         {
             #region Snippet:CreateNotebookClient
+#if SNIPPET
             // Replace the string below with your actual endpoint url.
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
             var client = new NotebookClient(endpoint: new Uri(endpoint), credential: new DefaultAzureCredential());
             #endregion
 
             #region Snippet:ConfigureNotebookResource
             string notebookName = "Test-Notebook";
-            var cell = new NotebookCell("code", new NotebookMetadata (), new string[] {
+            var cell = new NotebookCell("code", new NotebookMetadata(), new string[] {
                 "from azureml.opendatasets import NycTlcYellow\n",
                 "\n",
                 "data = NycTlcYellow()\n",
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample3_HelloWorldTrigger.cs b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample3_HelloWorldTrigger.cs
@@ -17,10 +17,12 @@ public partial class Sample3_HelloWorldTrigger : SamplesBase<SynapseTestEnvironm
         public async Task TriggerSample()
         {
             #region Snippet:CreateTriggerClientPrep
+#if SNIPPET
             // Replace the string below with your actual endpoint url.
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
-
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
             string triggerName = "Test-Trigger";
             #endregion
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample4_HelloWorldDataFlow.cs b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample4_HelloWorldDataFlow.cs
@@ -17,10 +17,12 @@ public partial class Sample4_HelloWorldDataFlow : SamplesBase<SynapseTestEnviron
         public async Task DataFlowSample()
         {
             #region Snippet:CreateDataFlowClientPrep
+#if SNIPPET
             // Replace the string below with your actual endpoint url.
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
-
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
             string dataFlowName = "Test-DataFlow";
             #endregion
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample5_HelloWorldDataset.cs b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample5_HelloWorldDataset.cs
@@ -17,13 +17,14 @@ public partial class Sample5_HelloWorldDataset : SamplesBase<SynapseTestEnvironm
         public async Task DatasetSample()
         {
             #region Snippet:CreateDatasetClientPrep
+#if SNIPPET
             // Replace the string below with your actual endpoint url.
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
-
             string storageName = "<my-storage-name>";
-            /*@@*/storageName = TestEnvironment.WorkspaceName + "-WorkspaceDefaultStorage";
-
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
+            string storageName = TestEnvironment.WorkspaceName + "-WorkspaceDefaultStorage";
+#endif
             string dataSetName = "Test-Dataset";
             #endregion
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample6_HelloWorldLinkedService.cs b/sdk/synapse/Azure.Analytics.Synapse.Artifacts/tests/samples/Sample6_HelloWorldLinkedService.cs
@@ -17,14 +17,17 @@ public partial class Sample6_HelloWorldLinkedService : SamplesBase<SynapseTestEn
         public async Task LinkedServiceSample()
         {
             #region Snippet:CreateLinkedServiceClientPrep
+#if SNIPPET
             // Replace the string below with your actual endpoint url.
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
-
+            
             // Replace the string below with your actual datalake endpoint url.
             string dataLakeEndpoint = "<my-datalake-url>";
-            /*@@*/dataLakeEndpoint = "adl://test.azuredatalakestore.net/";
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
 
+            string dataLakeEndpoint = "adl://test.azuredatalakestore.net/";
+#endif
             string serviceName = "Test-LinkedService";
             #endregion
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.ManagedPrivateEndpoints/tests/samples/Sample1_HelloManangedPrivateEndpoint.cs b/sdk/synapse/Azure.Analytics.Synapse.ManagedPrivateEndpoints/tests/samples/Sample1_HelloManangedPrivateEndpoint.cs
@@ -19,9 +19,12 @@ public partial class Sample1_HelloManagedPrivateEndpoint : SamplesBase<SynapseTe
         public void TestManagedPrivateEndpoint()
         {
             #region Snippet:CreateManagedPrivateClient
+#if SNIPPET
             // Replace the string below with your actual endpoint url.
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
+#else
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
             ManagedPrivateEndpointsClient client = new ManagedPrivateEndpointsClient(endpoint: new Uri(endpoint), credential: new DefaultAzureCredential(includeInteractiveCredentials: true));
             #endregion
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample1_SubmitSparkJob.md b/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample1_SubmitSparkJob.md
@@ -9,11 +9,8 @@ To interact with Spark jobs running on Azure Synapse, you need to instantiate a
 ```C# Snippet:CreateSparkBatchClient
 // Replace the strings below with the spark, endpoint, and file system information
 string sparkPoolName = "<my-spark-pool-name>";
-
 string endpoint = "<my-endpoint-url>";
-
 string storageAccount = "<my-storage-account-name>";
-
 string fileSystem = "<my-storage-filesystem-name>";
 
 SparkBatchClient client = new SparkBatchClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
@@ -55,7 +52,7 @@ SparkBatchJob jobCreated = createOperation.Value;
 To retrieve the details of a Spark job call `StartGetSparkBatchJob`, passing in the Spark job ID.
 
 ```C# Snippet:GetSparkBatchJob
-SparkBatchJob retrievedJob = client.GetSparkBatchJob (jobCreated.Id);
+SparkBatchJob retrievedJob = client.GetSparkBatchJob(jobCreated.Id);
 Debug.WriteLine($"Job is returned with name {retrievedJob.Name} and state {retrievedJob.State}");
 ```
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample1_SubmitSparkJobAsync.md b/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample1_SubmitSparkJobAsync.md
@@ -9,11 +9,8 @@ To interact with Spark jobs running on Azure Synapse, you need to instantiate a
 ```C# Snippet:CreateSparkBatchClientAsync
 // Replace the strings below with the spark, endpoint, and file system information
 string sparkPoolName = "<my-spark-pool-name>";
-
 string endpoint = "<my-endpoint-url>";
-
 string storageAccount = "<my-storage-account-name>";
-
 string fileSystem = "<my-storage-filesystem-name>";
 
 SparkBatchClient client = new SparkBatchClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample2_ExecuteSparkStatement.md b/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample2_ExecuteSparkStatement.md
@@ -9,7 +9,6 @@ To submit statements to Spark running on Azure Synapse, you need to instantiate
 ```C# Snippet:CreateSparkSessionClient
 // Replace the strings below with the spark and endpoint information
 string sparkPoolName = "<my-spark-pool-name>";
-
 string endpoint = "<my-endpoint-url>";
 
 SparkSessionClient client = new SparkSessionClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample2_ExecuteSparkStatementAsync.md b/sdk/synapse/Azure.Analytics.Synapse.Spark/samples/Sample2_ExecuteSparkStatementAsync.md
@@ -9,7 +9,6 @@ To submit statements to Spark running on Azure Synapse, you need to instantiate
 ```C# Snippet:CreateSparkSessionClientAsync
 // Replace the strings below with the spark and endpoint information
 string sparkPoolName = "<my-spark-pool-name>";
-
 string endpoint = "<my-endpoint-url>";
 
 SparkSessionClient client = new SparkSessionClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample1_SubmitSparkJob.cs b/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample1_SubmitSparkJob.cs
@@ -21,18 +21,18 @@ public partial class Sample1_SubmitSparkJob : SamplesBase<SynapseTestEnvironment
         public void SubmitSparkJobSync()
         {
             #region Snippet:CreateSparkBatchClient
+#if SNIPPET
             // Replace the strings below with the spark, endpoint, and file system information
             string sparkPoolName = "<my-spark-pool-name>";
-            /*@@*/sparkPoolName = TestEnvironment.SparkPoolName;
-
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
-
             string storageAccount = "<my-storage-account-name>";
-            /*@@*/storageAccount = TestEnvironment.StorageAccountName;
-
             string fileSystem = "<my-storage-filesystem-name>";
-            /*@@*/fileSystem = TestEnvironment.StorageFileSystemName;
+#else
+            string sparkPoolName = TestEnvironment.SparkPoolName;
+            string endpoint = TestEnvironment.EndpointUrl;
+            string storageAccount = TestEnvironment.StorageAccountName;
+            string fileSystem = TestEnvironment.StorageFileSystemName;
+#endif
 
             SparkBatchClient client = new SparkBatchClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
             #endregion
@@ -73,7 +73,7 @@ public void SubmitSparkJobSync()
             #endregion
 
             #region Snippet:GetSparkBatchJob
-            SparkBatchJob retrievedJob = client.GetSparkBatchJob (jobCreated.Id);
+            SparkBatchJob retrievedJob = client.GetSparkBatchJob(jobCreated.Id);
             Debug.WriteLine($"Job is returned with name {retrievedJob.Name} and state {retrievedJob.State}");
             #endregion
 
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample1_SubmitSparkJobAsync.cs b/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample1_SubmitSparkJobAsync.cs
@@ -22,18 +22,18 @@ public partial class Sample1_SubmitSparkJobAsync : SamplesBase<SynapseTestEnviro
         public async Task SubmitSparkJobAsync()
         {
             #region Snippet:CreateSparkBatchClientAsync
+#if SNIPPET
             // Replace the strings below with the spark, endpoint, and file system information
             string sparkPoolName = "<my-spark-pool-name>";
-            /*@@*/sparkPoolName = TestEnvironment.SparkPoolName;
-
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
-
             string storageAccount = "<my-storage-account-name>";
-            /*@@*/storageAccount = TestEnvironment.StorageAccountName;
-
             string fileSystem = "<my-storage-filesystem-name>";
-            /*@@*/fileSystem = TestEnvironment.StorageFileSystemName;
+#else
+            string sparkPoolName = TestEnvironment.SparkPoolName;
+            string endpoint = TestEnvironment.EndpointUrl;
+            string storageAccount = TestEnvironment.StorageAccountName;
+            string fileSystem = TestEnvironment.StorageFileSystemName;
+#endif
 
             SparkBatchClient client = new SparkBatchClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
             #endregion
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample2_ExecuteSparkStatement.cs b/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample2_ExecuteSparkStatement.cs
@@ -21,12 +21,14 @@ public partial class Sample2_ExecuteSparkStatement : SamplesBase<SynapseTestEnvi
         public void ExecuteSparkStatementSync()
         {
             #region Snippet:CreateSparkSessionClient
+#if SNIPPET
             // Replace the strings below with the spark and endpoint information
             string sparkPoolName = "<my-spark-pool-name>";
-            /*@@*/sparkPoolName = TestEnvironment.SparkPoolName;
-
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
+#else
+            string sparkPoolName = TestEnvironment.SparkPoolName;
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
 
             SparkSessionClient client = new SparkSessionClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
             #endregion
diff --git a/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample2_ExecuteSparkStatementAsync.cs b/sdk/synapse/Azure.Analytics.Synapse.Spark/tests/samples/Sample2_ExecuteSparkStatementAsync.cs
@@ -22,12 +22,14 @@ public partial class Sample2_ExecuteSparkStatementAsync : SamplesBase<SynapseTes
         public async Task ExecuteSparkStatementSync()
         {
             #region Snippet:CreateSparkSessionClientAsync
+#if SNIPPET
             // Replace the strings below with the spark and endpoint information
             string sparkPoolName = "<my-spark-pool-name>";
-            /*@@*/sparkPoolName = TestEnvironment.SparkPoolName;
-
             string endpoint = "<my-endpoint-url>";
-            /*@@*/endpoint = TestEnvironment.EndpointUrl;
+#else
+            string sparkPoolName = TestEnvironment.SparkPoolName;
+            string endpoint = TestEnvironment.EndpointUrl;
+#endif
 
             SparkSessionClient client = new SparkSessionClient(new Uri(endpoint), sparkPoolName, new DefaultAzureCredential());
             #endregion
