Azure.Analytics.Synapse.Artifacts 1.0.0-preview.20

Prefix Reserved
This is a prerelease version of Azure.Analytics.Synapse.Artifacts.
dotnet add package Azure.Analytics.Synapse.Artifacts --version 1.0.0-preview.20                
NuGet\Install-Package Azure.Analytics.Synapse.Artifacts -Version 1.0.0-preview.20                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Azure.Analytics.Synapse.Artifacts" Version="1.0.0-preview.20" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Analytics.Synapse.Artifacts --version 1.0.0-preview.20                
#r "nuget: Azure.Analytics.Synapse.Artifacts, 1.0.0-preview.20"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Azure.Analytics.Synapse.Artifacts as a Cake Addin
#addin nuget:?package=Azure.Analytics.Synapse.Artifacts&version=1.0.0-preview.20&prerelease

// Install Azure.Analytics.Synapse.Artifacts as a Cake Tool
#tool nuget:?package=Azure.Analytics.Synapse.Artifacts&version=1.0.0-preview.20&prerelease                

Azure Synapse Analytics Artifacts client library for .NET

This directory contains the open source subset of the .NET SDK. For documentation of the complete Azure SDK, please see the Microsoft Azure .NET Developer Center.

The Azure Synapse Analytics development client library enables programmatically managing artifacts, offering methods to create, update, list, and delete pipelines, datasets, data flows, notebooks, Spark job definitions, SQL scripts, linked services and triggers.

Azure Synapse is a limitless analytics service that brings together enterprise data warehousing and Big Data analytics. It gives you the freedom to query data on your terms, using either serverless on-demand or provisioned resources—at scale. Azure Synapse brings these two worlds together with a unified experience to ingest, prepare, manage, and serve data for immediate BI and machine learning needs.

Getting started

The complete Microsoft Azure SDK can be downloaded from the Microsoft Azure Downloads Page and ships with support for building deployment packages, integrating with tooling, rich command line tooling, and more.

For the best development experience, developers should use the official Microsoft NuGet packages for libraries. NuGet packages are regularly updated with new functionality and hotfixes.

Install the package

Install the Azure Synapse Analytics development client library for .NET with NuGet:

dotnet add package Azure.Analytics.Synapse.Artifacts --prerelease


  • Azure Subscription: To use Azure services, including Azure Synapse, you'll need a subscription. If you do not have an existing Azure account, you may sign up for a free trial or use your Visual Studio Subscription benefits when you create an account.
  • An existing Azure Synapse workspace. If you need to create an Azure Synapse workspace, you can use the Azure Portal or Azure CLI.

If you use the Azure CLI, the command looks like below:

az synapse workspace create \
    --name <your-workspace-name> \
    --resource-group <your-resource-group-name> \
    --storage-account <your-storage-account-name> \
    --file-system <your-storage-file-system-name> \
    --sql-admin-login-user <your-sql-admin-user-name> \
    --sql-admin-login-password <your-sql-admin-user-password> \
    --location <your-workspace-location>

Authenticate the client

In order to interact with part of the Azure Synapse Analytics service, you'll need to create an instance of the respective client class:

You need a workspace endpoint, which you may see as "Development endpoint" in the portal, and client secret credentials (client id, client secret, tenant id) to instantiate a client object.

Client secret credential authentication is being used in this getting started section but you can find more ways to authenticate with Azure identity. To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, you should install the Azure.Identity package:

dotnet add package Azure.Identity


The Azure.Analytics.Synapse.Artifacts package supports synchronous and asynchronous APIs. The following section covers some of the most common Azure Synapse Analytics development related tasks:

Notebook examples

Create a notebook

CreateOrUpdateNotebook creates a notebook.

NotebookCreateOrUpdateNotebookOperation operation = await client.StartCreateOrUpdateNotebookAsync(notebookName, notebookResource);
await operation.WaitForCompletionAsync();
Console.WriteLine("The notebook is created");

Retrieve a notebook

GetNoteBook retrieves a notebook.

NotebookResource retrievedNotebook = client.GetNotebook(notebookName);

List notebooks

GetNotebooksByWorkspace enumerates the notebooks in the Synapse workspace.

Pageable<NotebookResource> notebooks = client.GetNotebooksByWorkspace();
foreach (NotebookResource notebook in notebooks)

Delete a notebook

DeleteNotebook deletes a notebook.

NotebookDeleteNotebookOperation deleteNotebookOperation = client.StartDeleteNotebook(notebookName);
await deleteNotebookOperation.WaitForCompletionResponseAsync();

To build

For information on building the Azure Synapse client library, please see Building the Microsoft Azure SDK for .NET

Target frameworks

For information about the target frameworks of the Azure Synapse client library, please refer to the Target Frameworks of the Microsoft Azure SDK for .NET.

Key concepts


With a notebook client you can create, update, list, and delete pipelines, datasets, data flows, notebooks, Spark job definitions, SQL scripts, linked services and triggers.

Thread safety

We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.

Additional concepts

Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime


Please open issue in github.

Next steps

The next step is adding more examples


This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Azure.Analytics.Synapse.Artifacts:

Package Downloads

Azure Synapse Extensions

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Azure.Analytics.Synapse.Artifacts:

Repository Stars
Microsoft Azure PowerShell
A cross tenant metadata driven processing framework for Azure Data Factory and Azure Synapse Analytics achieved by coupling orchestration pipelines with a SQL database and a set of Azure Functions.
Version Downloads Last updated
1.0.0-preview.20 1,142 6/5/2024
1.0.0-preview.19 12,195 11/1/2023
1.0.0-preview.18 10,793 7/31/2023
1.0.0-preview.17 109,910 1/11/2023
1.0.0-preview.16 16,956 9/14/2022
1.0.0-preview.15 22,384 4/21/2022
1.0.0-preview.14 12,559 3/14/2022
1.0.0-preview.13 1,833 1/14/2022
1.0.0-preview.12 7,912 11/9/2021
1.0.0-preview.11 3,657 10/5/2021
1.0.0-preview.10 12,243 5/17/2021
1.0.0-preview.9 5,317 5/11/2021
1.0.0-preview.8 6,339 4/6/2021
1.0.0-preview.7 296 3/17/2021
1.0.0-preview.6 453 2/10/2021
1.0.0-preview.4 27,280 9/1/2020
1.0.0-preview.3 4,538 8/18/2020
1.0.0-preview.1 1,205 6/10/2020